ooodev.format.inner.direct.chart2.chart.area.pattern module

class ooodev.format.inner.direct.chart2.chart.area.pattern.Pattern(chart_doc, *, bitmap=None, name='', tile=True, stretch=False, auto_name=False)[source]

Bases: Pattern

Class for Chart Area Fill Pattern.

See also

New in version 0.9.4.

__init__(chart_doc, *, bitmap=None, name='', tile=True, stretch=False, auto_name=False)[source]

Constructor

Parameters:

  • chart_doc (XChartDocument) – Chart document.

  • bitmap (XBitmap, optional) – Bitmap instance. If name is not already in the Bitmap Table then this property is required.

  • name (str, optional) – Specifies the name of the pattern. This is also the name that is used to store bitmap in LibreOffice Bitmap Table.

  • tile (bool, optional) – Specified if bitmap is tiled. Defaults to True.

  • stretch (bool, optional) – Specifies if bitmap is stretched. Defaults to False.

  • auto_name (bool, optional) – Specifies if name is ensured to be unique. Defaults to False.

Return type:

None

See also

copy()[source]
copy(**kwargs)
copy(**kwargs)

Gets a copy of instance as a new instance

Return type:

Pattern

classmethod from_obj(chart_doc, obj)[source]
classmethod from_obj(chart_doc, obj, **kwargs)
classmethod from_obj(chart_doc, obj, **kwargs)

Gets instance from object

Parameters:

  • chart_doc (XChartDocument) – Chart document.

  • obj (object) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

Pattern instance that represents obj fill pattern.

Return type:

Pattern

classmethod from_preset(chart_doc, preset)[source]
classmethod from_preset(chart_doc, preset, **kwargs)
classmethod from_preset(chart_doc, preset, **kwargs)

Gets an instance from a preset.

Parameters:

  • preset (PresetPatternKind) – Preset.

  • chart_doc (XChartDocument) –

Returns:

Pattern instance from preset.

Return type:

Pattern

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

prop_stretch

Descriptor to raise an exception when an attribute is accessed after deletion.

prop_tile

Descriptor to raise an exception when an attribute is accessed after deletion.