ooodev.format.chart2.direct.axis.positioning package

Module contents

class ooodev.format.chart2.direct.axis.positioning.AxisLine(cross=None, value=<object object>)[source]

Bases: StyleBase

Chart Axis Line.

Select where to cross the other axis: at start, at end, at a specified value, or at a category.

See also

Chart2 Direct Axis Positioning

New in version 0.9.4.

__init__(cross=None, value=<object object>)[source]

Constructor

Parameters:

cross (ChartAxisPosition, optional) – The position where the axis crosses the other axis.
value (float, None, optional) – The value where the axis crosses the other axis.

Return type:

None

See also

Chart2 Direct Axis Positioning

on_property_setting(source, event_args)[source]

Triggers for each property that is set

Parameters:

source (Any) – Event Source.
event_args (KeyValueCancelArgs) – Event Args

Return type:

None

property prop_cross: ChartAxisPosition | None

Return type:: ChartAxisPosition | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_value: Any

Return type:: Any

class ooodev.format.chart2.direct.axis.positioning.IntervalMarks(major=None, minor=None, pos=None)[source]

Bases: StyleBase

Chart Axis Interval Marks.

See also

Chart2 Direct Axis Positioning

New in version 0.9.4.

__init__(major=None, minor=None, pos=None)[source]

Constructor

Parameters:

major (MarkKind, optional) – Specifies the major tickmark style.
minor (MarkKind, optional) – Specifies the minor tickmark style.
pos (ChartAxisMarkPosition, optional) – Specifies where to place the marks: at labels, at axis, or at axis and labels.

Return type:

None

See also

Chart2 Direct Axis Positioning

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_major: MarkKind | None

Return type:: MarkKind | None

property prop_minor: MarkKind | None

Return type:: MarkKind | None

property prop_pos: ChartAxisMarkPosition | None

Return type:: ChartAxisMarkPosition | None

class ooodev.format.chart2.direct.axis.positioning.LabelPosition(pos=ChartAxisLabelPosition.NEAR_AXIS)[source]

Bases: StyleBase

Chart Axis Label placement.

See also

Chart2 Direct Axis Positioning

New in version 0.9.4.

__init__(pos=ChartAxisLabelPosition.NEAR_AXIS)[source]

Constructor

Parameters:: pos (ChartAxisLabelPosition, optional) – Specifies where to place the labels: near axis, near axis (other side), outside start, or outside end. Default is ChartAxisLabelPosition.NEAR_AXIS.
Return type:: None

See also

Chart2 Direct Axis Positioning

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_pos: ChartAxisLabelPosition

Return type:: ChartAxisLabelPosition

class ooodev.format.chart2.direct.axis.positioning.PositionAxis(on_mark=True)[source]

Bases: StyleBase

Chart Axis Line Position.

Note

Does not apply to all axis types.

See also

Chart2 Direct Axis Positioning

New in version 0.9.4.

__init__(on_mark=True)[source]

Constructor

Parameters:: on_mark (bool, optional) – Specifies that the axis is position. If True, specifies that the axis is positioned on the first/last tickmarks. This makes the data points visual representation begin/end at the value axis. If False, specifies that the axis is positioned between the tickmarks. This makes the data points visual representation begin/end at a distance from the value axis. Default is True.
Return type:: None

See also

Chart2 Direct Axis Positioning

apply(obj, **kwargs)[source]

Applies styles to object

Parameters:

obj (Any) – UNO Object that styles are to be applied.
kwargs (Any, optional) – Expandable list of key value pairs that may be used in child classes.

Keyword Arguments:

override_dv (Dic[str, Any], optional) – if passed in this dictionary is used to set properties instead of internal dictionary of property values.
validate (bool, optional) – if False then obj is not validated. Defaults to True.

Events:

Return type:

None

Note

If Event data obj, data_values or allow_update are changed then the new values are used.

Add update object to instance if not already set and allow_update is True (default).

Changed in version 0.27.0: Event data is now a dictionary with keys source, obj, data_values and allow_update.

Changed in version 0.9.4: Added validate keyword arguments.

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_on_mark: bool

Return type:: bool