ooodev.adapter.chart2.chart_type_partial module

class ooodev.adapter.chart2.chart_type_partial.ChartTypePartial(component, interface=com.sun.star.chart2.XChartType)

Bases: object

Partial class for XChartType.

Parameters:

• component (XChartType) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.chart2.XChartType)

Constructor

Parameters:

• component (XChartType) – UNO Component that implements com.sun.star.chart2.XChartType interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XChartType.

Return type:

None

create_coordinate_system(dimension_count)

Creates a coordinate systems that fits the chart-type with its current settings and for the given dimension.

Raises:

com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

Return type:

XCoordinateSystem

Parameters:

dimension_count (int) –

get_chart_type()

A string representation of the chart type.

This needs to be the service-name which can be used to create a chart type.

Return type:

str

get_role_of_sequence_for_series_label()

Returns the role of the XLabeledDataSequence of which the label will be taken to identify the DataSeries in dialogs or the legend.

Return type:

str

get_supported_mandatory_roles()

Returns a sequence of roles that are understood by this chart type.

All roles must be listed in the order in which they are usually parsed. This ensures that gluing sequences together and splitting them up apart again results in the same structure as before.

Note, that this does not involve optional roles, like error-bars.

Return type:

Tuple[str, ...]

get_supported_optional_roles()

Returns a sequence of roles that are understood in addition to the mandatory roles see XChartType.getSupportedMandatoryRoles().

An example for an optional role are error-bars.

Return type:

Tuple[str, ...]

get_supported_property_roles()

Returns a sequence with supported property mapping roles.

An example for a property mapping role is FillColor.

Return type:

Tuple[str, ...]