ooodev.format.inner.direct.structs.data_point_label_struct module

class ooodev.format.inner.direct.structs.data_point_label_struct.DataPointLabelStruct(show_number=False, show_number_in_percent=False, show_category_name=False, show_legend_symbol=False, show_custom_label=False, show_series_name=False)[source]

Bases: StructBase

DataPointLabel struct.

New in version 0.9.4.

__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)[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.

Return type:

None

apply(obj: Any)[source]

apply(obj, **kwargs)

Applies tab properties to obj

Parameters:: obj (object) – UNO object.
Return type:: None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (object) – UNO object
Raises:: PropertyNotFoundError – If obj does not have required property
Returns:: DataPointLabelStruct instance.
Return type:: DataPointLabelStruct

classmethod from_uno_struct(value)[source]

classmethod from_uno_struct(value, **kwargs)

Converts a DataPointLabel instance to a PointStruct.

Parameters:: value (DataPointLabel) – UNO DataPointLabel.
Returns:: PointStruct set with DataPointLabel properties.
Return type:: DataPointLabelStruct

get_uno_struct()[source]

Gets UNO DataPointLabel from instance.

Returns:: DataPointLabel instance
Return type:: DataPointLabel

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