ooodev.format.inner.direct.chart2.series.data_labels.data_labels.text_attribs module

class ooodev.format.inner.direct.chart2.series.data_labels.data_labels.text_attribs.TextAttribs(show_number=False, show_number_in_percent=False, show_category_name=False, show_legend_symbol=False, show_custom_label=False, show_series_name=False, auto_text_wrap=None)[source]

Bases: StyleMulti

Chart Data Series, Data Labels Text Attributes.

Any properties starting with prop_ set or get current instance values.

See also

__init__(show_number=False, show_number_in_percent=False, show_category_name=False, show_legend_symbol=False, show_custom_label=False, show_series_name=False, auto_text_wrap=None)[source]

Constructor.

Parameters:

  • show_number (bool, optional) – if True, the value that is represented by a data point is displayed next to it. Defaults to False.

  • show_number_in_percent (bool, optional) – Only effective, if ShowNumber is True. If this member is also True, the numbers are displayed as percentages of a category. That means, if a data point is the first one of a series, the percentage is calculated by using the first data points of all available series. Defaults to False.

  • show_category_name (bool, optional) – Specifies the caption contains the category name of the category to which a data point belongs. Defaults to False.

  • show_legend_symbol (bool, optional) – Specifies the symbol of data series is additionally displayed in the caption. Since LibreOffice 7.1. Defaults to False.

  • show_custom_label (bool, optional) – Specifies the caption contains a custom label text, which belongs to a data point label. Defaults to False.

  • show_series_name (bool, optional) – Specifies the name of the data series is additionally displayed in the caption. Since LibreOffice 7.2. Defaults to False.

  • auto_text_wrap (bool, optional) – Specifies the text is automatically wrapped, if the text is too long to fit in the available space.

Return type:

None

See also

copy(**kwargs)[source]

Copies the style

Return type:

TextAttribs

property auto_text_wrap: TextAttribs

Gets a copy of the style with prop_auto_text_wrap set to True

Return type:

TextAttribs

property prop_auto_text_wrap: bool | None

Gets or set if the text is automatically wrapped, if the text is too long to fit in the available space.

Return type:

bool | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_show_category_name: bool

Gets or set if the caption contains the category name of the category to which a data point belongs

Return type:

bool

property prop_show_custom_label: bool

Gets or set if a custom label is additionally displayed in the caption.

Since LibreOffice 7.1

Return type:

bool

property prop_show_legend_symbol: bool

Gets or set if the legend symbol is additionally displayed in the caption.

Return type:

bool

property prop_show_number: bool

Gets or set if the number is additionally displayed in the caption.

Return type:

bool

property prop_show_number_in_percent: bool

Only effective, if ShowNumber is True.

If this member is also True, the numbers are displayed as percentages of a category

Return type:

bool

property prop_show_series_name: bool

Gets or set if the caption contains the name of the series to which a data point belongs.

Since LibreOffice 7.2

Return type:

bool

property show_category_name: TextAttribs

Gets a copy of the style with prop_show_category_name set to True

Return type:

TextAttribs

property show_custom_label: TextAttribs

Gets a copy of the style with prop_show_custom_label set to True

Return type:

TextAttribs

property show_legend_symbol: TextAttribs

Gets a copy of the style with prop_show_legend_symbol set to True

Return type:

TextAttribs

property show_number: TextAttribs

Gets a copy of the style with prop_show_number set to True

Return type:

TextAttribs

property show_number_in_percent: TextAttribs

Gets a copy of the style with prop_show_number_in_percent set to True

Return type:

TextAttribs

property show_series_name: TextAttribs

Gets a copy of the style with prop_show_series_name set to True

Return type:

TextAttribs