Paper Office
paper-pptxAPI referenceenum.chart

XL_LEGEND_POSITION

paper-pptx 0.2.0 API reference

Specifies the position of the legend on a chart.

Example::

from pptx.enum.chart import XL_LEGEND_POSITION

chart.has_legend = True chart.legend.position = XL_LEGEND_POSITION.BOTTOM

MS API Name: XlLegendPosition

http://msdn.microsoft.com/en-us/library/office/ff745840.aspx

Attributes

BOTTOM

attributeBOTTOM
= (-4107, 'b', 'Below the chart.')

Below the chart.

CORNER

attributeCORNER
= (2, 'tr', 'In the upper-right corner of the chart border.')

In the upper-right corner of the chart border.

CUSTOM

attributeCUSTOM
= (-4161, '', 'A custom position (read-only).')

A custom position (read-only).

LEFT

attributeLEFT
= (-4131, 'l', 'Left of the chart.')

Left of the chart.

attributeRIGHT
= (-4152, 'r', 'Right of the chart.')

Right of the chart.

TOP

attributeTOP
= (-4160, 't', 'Above the chart.')

Above the chart.

xml_value

attributexml_valuestr | None

Functions

from_xml

funcfrom_xml(xml_value: str) -> Self

Enumeration member corresponding to XML attribute value xml_value.

Raises ValueError if xml_value is the empty string ("") or is not an XML attribute value registered on the enumeration. Note that enum members that do not correspond to one of the defined values for an XML attribute have xml_value == "". These "return-value only" members cannot be automatically mapped from an XML attribute value and must be selected explicitly by code, based on the appropriate conditions.

Example::

WD_PARAGRAPH_ALIGNMENT.from_xml("center") WD_PARAGRAPH_ALIGNMENT.CENTER

paramxml_valuestr

Returns

typing_extensions.Self

to_xml

functo_xml(value: int | _T) -> str

XML value of this enum member, generally an XML attribute value.

paramvalueint | _T

Returns

str

validate

funcvalidate(value: _T)

Raise ValueError if value is not an assignable value.

paramvalue_T

On this page