ooodev.format.inner.modify.calc.page.area.img module
- class ooodev.format.inner.modify.calc.page.area.img.Img(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Bases:
CellStyleBaseMulti
Page Style Image
See also
New in version 0.9.0.
- __init__(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Constructor
- Parameters:
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 image. This is also the name that is used to store bitmap in LibreOffice Bitmap Table.
mode (ImgStyleKind, optional) – Specifies the image style, tiled, stretched etc. Default
ImgStyleKind.TILED
.size (SizePercent, SizeMM, optional) – Size in percent (
0 - 100
) or size inmm
units.position (RectanglePoint) – Tiling position of Image.
pos_offset (Offset, optional) – Tiling position offset.
tile_offset (OffsetColumn, OffsetRow, optional) – The tiling offset.
auto_name (bool, optional) – Specifies if
name
is ensured to be unique. Defaults toFalse
.style_name (CalcStylePageKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_preset(preset, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]
Gets an instance from a preset.
- Parameters:
preset (PresetImageKind) – Preset.
style_name (CalcStylePageKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Returns:
Img
instance from preset.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str
- class ooodev.format.inner.modify.calc.page.area.img.InnerImg(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False)[source]
Bases:
Img
Class for Style background image.
See also
New in version 0.9.0.
- property prop_format_kind: FormatKind
Gets the kind of style
- Return type: