ooodev.format.chart2.direct.series.data_series.options package

Module contents

class ooodev.format.chart2.direct.series.data_series.options.AlignSeries(chart_doc, primary_y_axis=True)[source]

Bases: StyleBase

Chart Data Series Align

See also

Chart2 Direct Series Data Series Options

__init__(chart_doc, primary_y_axis=True)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
primary_y_axis (bool, optional) – If True Data Series is plotted on the primary Y axis; if False Data Series is plotted on the secondary Y axis. Defaults to True.

Return type:

None

See also

Chart2 Direct Series Data Series Options

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies styles to object

Parameters:: obj (object) – UNO Object that styles are to be applied.
Return type:: None

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: AlignSeries

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_primary_y_axis: bool | None

Gets or sets the primary Y axis.

Return type:: bool | None

class ooodev.format.chart2.direct.series.data_series.options.LegendEntry(chart_doc, *, hide_legend=False, **kwargs)[source]

Bases: StyleBase

Chart Data Series Legend Visibility

See also

Chart2 Direct Series Data Series Options

__init__(chart_doc, *, hide_legend=False, **kwargs)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
hide_legend (bool, optional) – Specifies if legend entry is to be hidden. Defaults to False.

Return type:

None

See also

Chart2 Direct Series Data Series Options

apply(obj: object)[source]

apply(obj: object, **kwargs)

apply(obj, **kwargs)

Applies styles to object

Parameters:: obj (object) – UNO Object that styles are to be applied.
Return type:: None

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: LegendEntry

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_hide_legend: bool

Gets or sets whether the legend is hidden.

Return type:: bool

class ooodev.format.chart2.direct.series.data_series.options.Orientation(chart_doc, clockwise=None, angle=None)[source]

Bases: StyleBase

Chart Orientation.

Available for pie and donut charts.

See also

Chart2 Direct Series Data Series Options

__init__(chart_doc, clockwise=None, angle=None)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
clockwise (bool, optional) – Specifies he default direction in which the pieces of a pie chart are ordered is counterclockwise. Set to True to enable the Clockwise direction to draw the pieces in opposite direction.
angle (int, Angle, optional) – Sets the starting angle of a pie or donut chart.

Return type:

None

See also

Chart2 Direct Series Data Series Options

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies styles to object

Parameters:: obj (object) – UNO Object that styles are to be applied.
Return type:: None

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: TypeVar(_TOrientation, bound= Orientation)
Parameters:: self (_TOrientation) –

property prop_angle: Angle | None

Gets or sets the angle property

Return type:: Angle | None

property prop_clockwise: bool | None

Gets or sets the clockwise property

Return type:: bool | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

class ooodev.format.chart2.direct.series.data_series.options.Plot(chart_doc, *, missing_values=None, hidden_cell_values=None)[source]

Bases: PlotSimple

Chart Data Series Plot Options

See also

Chart2 Direct Series Data Series Options

__init__(chart_doc, *, missing_values=None, hidden_cell_values=None)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
missing_values (MissingValueTreatmentEnum | None, optional) – Specifies plot missing values option. Defaults to None.
hidden_cell_values (bool | None, optional) – Specifies if values from hidden cells are to be included. Defaults to None.

Return type:

None

See also

Chart2 Direct Series Data Series Options

property prop_missing_values: MissingValueKind | None

Gets or sets the missing value treatment.

Return type:: MissingValueKind | None

class ooodev.format.chart2.direct.series.data_series.options.PlotSimple(chart_doc, hidden_cell_values=None)[source]

Bases: StyleBase

Data Series Plot Simple

..seealso:

- :ref:`help_chart2_format_direct_series_series_options`

__init__(chart_doc, hidden_cell_values=None)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
hidden_cell_values (bool, optional) – Specifies if values from hidden cells are to be included. Defaults to None.

Return type:

None

See also

Chart2 Direct Series Data Series Options

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies styles to object

Parameters:: obj (object) – UNO Object that styles are to be applied.
Return type:: None

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: TypeVar(_TPlotSimple, bound= PlotSimple)
Parameters:: self (_TPlotSimple) –

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_hidden_cell_values: bool | None

Gets or sets whether hidden cells are included.

Return type:: bool | None

class ooodev.format.chart2.direct.series.data_series.options.Settings(chart_doc, *, spacing=None, overlap=None, side_by_side=None, **kwargs)[source]

Bases: StyleBase

Chart Data Series Settings

Note

The axis that the setting are applied to is determined by the axis that the data series is plotted on. For this reason if formatting is applied to a data series axis it should be done before applying Settings.

See also

Chart2 Direct Series Data Series Options

New in version 0.9.4.

__init__(chart_doc, *, spacing=None, overlap=None, side_by_side=None, **kwargs)[source]

Constructor

Parameters:

chart_doc (XChartDocument) – Chart document.
spacing (int | None, optional) – Spacing between bars. Must be a positive integer value. Defaults to None.
overlap (int | None, optional) – Overlap of bars. Defaults to None.
side_by_side (bool | None, optional) – Specifies if bars are shown side by side. Defaults to None.

Return type:

None

See also

Chart2 Direct Series Data Series Options

apply(obj: Any)[source]

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies styles to object

Parameters:: obj (object) – UNO Object that styles are to be applied.
Return type:: None

copy()[source]

copy(**kwargs)

Gets a copy of instance as a new instance

Return type:: Settings

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_overlap: int | None

Gets or sets the overlap between bars.

Return type:: int | None

property prop_side_by_side: bool | None

Gets or sets whether bars are side by side.

Return type:: bool | None

property prop_spacing: int | None

Gets or sets the spacing between bars.

Return type:: int | None