ooodev.format.inner.preset.preset_border_line module

class ooodev.format.inner.preset.preset_border_line.BorderLineKind(value)

Bases: Enum

An enumeration.

CONTINUOUS = 'Continuous'

DASH = 'Dash'

DASHED = 'Dashed (var)'

DASHES_3_DOTS_3 = '3 Dashes 3 Dots (var)'

DASH_DOT = 'Dash Dot'

DASH_DOT_DOT = 'Dash Dot Dot'

DASH_DOT_DOT_ROUNDED = 'Dash Dot Dot (Rounded)'

DASH_DOT_ROUNDED = 'Dash Dot (Rounded)'

DASH_ROUNDED = 'Dash (Rounded)'

DOT = 'Dot'

DOTS_2_DASH_1 = '2 Dots 1 Dash'

DOT_ROUNDED = 'Dot (Rounded)'

DOUBLE_DASH = 'Double Dash'

DOUBLE_DASH_DOT = 'Double Dash Dot'

DOUBLE_DASH_DOT_DOT = 'Double Dash Dot Dot'

DOUBLE_DASH_DOT_DOT_ROUNDED = 'Double Dash Dot Dot (Rounded)'

DOUBLE_DASH_DOT_ROUNDED = 'Double Dash Dot (Rounded)'

DOUBLE_DASH_ROUNDED = 'Double Dash (Rounded)'

FINE_DASHED = 'Fine Dashed'

FINE_DOTTED = 'Fine Dotted'

LINE_STYLE_09 = 'Line Style 9'

LINE_WITH_FINE_DOTS = 'Line with Fine Dots'

LONG_DASH = 'Long Dash'

LONG_DASH_DOT = 'Long Dash Dot'

LONG_DASH_DOT_ROUNDED = 'Long Dash Dot (Rounded)'

LONG_DASH_ROUNDED = 'Long Dash (Rounded)'

LONG_DOT = 'Long Dot'

LONG_DOT_ROUNDED = 'Long Dot (Rounded)'

NONE = 'None'

ULTRA_FINE_DASHED = 'Ultrafine Dashed'

ULTRA_FINE_DOTS_2_DASHES_3 = 'Ultrafine 2 Dots 3 Dashes'

ULTRA_FINE_DOTTED = 'Ultrafine Dotted (var)'

namedtuple ooodev.format.inner.preset.preset_border_line.BorderLineProps(line_cap, line_dash_name, line_dash, line_joint, line_style)

Bases: NamedTuple

BorderLineProps(line_cap, line_dash_name, line_dash, line_joint, line_style)

Fields:

0.  line_cap (LineCap) – Alias for field number 0

1.  line_dash_name (Optional[str]) – Alias for field number 1

2.  line_dash (Optional[str]) – Alias for field number 2

3.  line_joint (LineJoint) – Alias for field number 3

4.  line_style (Optional[LineStyle]) – Alias for field number 4

namedtuple ooodev.format.inner.preset.preset_border_line.BorderLineSeriesProps(border_name, border_style, line_cap, line_dash, line_dash_name, line_style)

Bases: NamedTuple

BorderLineSeriesProps(border_name, border_style, line_cap, line_dash, line_dash_name, line_style)

Fields:

0.  border_name (str) – Alias for field number 0

1.  border_style (LineStyle) – Alias for field number 1

2.  line_cap (LineCap) – Alias for field number 2

3.  line_dash (LineDash) – Alias for field number 3

4.  line_dash_name (Optional[str]) – Alias for field number 4

5.  line_style (LineStyle) – Alias for field number 5

ooodev.format.inner.preset.preset_border_line.get_preset_border_line_props(kind)

Gets preset border line properties.

Parameters:

kind (PresetBorderLineKind) – Preset border line kind.

Returns:

Preset border line properties.

Return type:

BorderLineProps

ooodev.format.inner.preset.preset_border_line.get_preset_series_border_line_props(kind)

Gets preset series border line properties.

This method is used to get the border line properties for the data series.

Parameters:

kind (PresetBorderLineKind) – Preset border line kind.

Returns:

Preset border line properties.

Return type:

BorderLineProps