ooodev.format.chart2.direct.title.alignment package

Module contents

class ooodev.format.chart2.direct.title.alignment.Direction(mode=DirectionModeKind.PAGE)[source]

Bases: AbstractWritingMode

Title Text Direction.

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

All methods starting with fmt_ can be used to chain together properties.

New in version 0.9.4.

__init__(mode=DirectionModeKind.PAGE)[source]

Constructor

Parameters:

mode (DirectionModeKind, optional) – Specifies the writing direction.

Return type:

None

fmt_mode(value)[source]

Gets copy of instance with writing mode set or removed

Parameters:

value (DirectionModeKind | None) – mode value

Returns:

Direction instance.

Return type:

Direction

property lr_tb: Direction

Gets instance.

Text within lines is written left-to-right. Lines and blocks are placed top-to-bottom. Typically, this is the writing mode for normal alphabetic text.

Return type:

Direction

property page: Direction

Gets instance.

Use super-ordinate object settings.

Return type:

Direction

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_mode: DirectionModeKind

Gets/Sets writing mode.

Return type:

DirectionModeKind

property rl_tb: Direction

Gets instance.

Text within a line are written right-to-left. Lines and blocks are placed top-to-bottom. Typically, this writing mode is used in Arabic and Hebrew text.

Return type:

Direction

class ooodev.format.chart2.direct.title.alignment.Orientation(angle=None, vertical=None)[source]

Bases: StyleBase

Title Text orientation.

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

All methods starting with fmt_ can be used to chain together properties.

New in version 0.9.4.

__init__(angle=None, vertical=None)[source]

Constructor

Parameters:
  • angle (int, Angle, optional) – Rotation in degrees of the text.

  • vertical (bool, optional) – Specifies if the text is vertically stacked.

Return type:

None

fmt_angle(value)[source]

Gets new instance with the rotation set or removed.

Parameters:
  • value (int | Angle | None) – The rotation in degrees, None to remove.

  • self (_TOrientation) –

Returns:

The new instance.

Return type:

_TOrientation

fmt_vertical(value)[source]

Gets new instance with the vertical orientation set or removed.

Parameters:
  • value (bool | None) – True or False to set vertical orientation, None to remove.

  • self (_TOrientation) –

Returns:

The new instance.

Return type:

_TOrientation

property prop_angle: Angle | None

Gets/Sets the rotation of the text.

Return type:

Angle | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_vertical: bool | None

Gets/Sets if the text is vertically stacked.

Return type:

bool | None

property vertical: _TOrientation

Gets new instance with the vertical orientation set.

Return type:

TypeVar(_TOrientation, bound= Orientation)