Class ChartTitle

class ooodev.calc.chart2.chart_title.ChartTitle(owner, chart_doc, component, title_kind, lo_inst=None)

Bases: Generic[_T], LoInstPropsPartial, EventsPartial, TitleComp, ChartDocPropPartial, PropPartial, QiPartial, ServicePartial, CalcDocPropPartial, CalcSheetPropPartial, StylePartial, FontOnlyPartial, FontEffectsPartial, FontPartial, Chart2TitleOrientationPartial, FillColorPartial, ChartFillGradientPartial, ChartFillHatchPartial, ChartFillImgPartial, ChartFillPatternPartial, BorderLinePropertiesPartial, Chart2PositionPartial

Class for managing Chart2 Chart Title Component.

__init__(owner, chart_doc, component, title_kind, lo_inst=None)

Constructor

Parameters:

• component (Any) – UNO Chart2 Title Component.

• lo_inst (LoInst, optional) – Lo Instance. Use when creating multiple documents. Defaults to None.

• owner (_T) –

• chart_doc (ChartDoc) –

• title_kind (ChartTitleKind) –

Return type:

None

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:

args (EventObserver) – One or more observers to add.

Return type:

None

Note

Observers are removed automatically when they are out of scope.

add_event_properties_change(names, cb)

Add properties to listen for changes.

Parameters:

• names (Iterable[str]) – One or more property names to listen for changes.

• cb (EventArgsCallbackT) – Callback that is invoked when an event is triggered.

Raises:

ValueError – If names is empty.

Return type:

None

Note

The callback EventArgs.event_data will contain a tuple of com.sun.star.beans.PropertyChangeEvent objects.

Each time this method is called, the previous names are removed and the new names are added.

add_event_property_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

• name (str) – Property Name

• cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_property_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

• name (str) – Property Name

• cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

• name (str) – Property Name

• cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

• name (str) – Property Name

• cb (EventArgsCallbackT) – Callback

Return type:

None

apply_styles(*styles, **kwargs)

Applies style to component.

Parameters:

• obj. (styles expandable list of styles object such as Font to apply to) –

• kwargs (Any, optional) – Expandable list of key value pairs.

• styles (StyleT) –

Return type:

None

fire_event_properties_change(names)

Fires a sequence of PropertyChangeEvents

Parameters:

names (Iterable[str]) – Sequence of property names to fire event for.

Return type:

None

get_property(name, default=<object object>)

Get property value

Parameters:

• name (str) – Property Name.

• default (Any, optional) – Return value if property value is None.

Returns:

Property value or default.

Return type:

Any

get_services()

Gets service names for the instance.

Returns:

service names

Return type:

List[str]

get_text()

Gets the text of the title.

Return type:

Tuple[XFormattedString, ...]

qi(atype, raise_err=False)

Generic method that get an interface instance from an object.

Parameters:

• atype (T) – Interface type to query obj for. Any Uno class that starts with ‘X’ such as XInterface

• raise_err (bool, optional) – If True then raises MissingInterfaceError if result is None. Default False

Raises:

MissingInterfaceError – If ‘raise_err’ is ‘True’ and result is None

Returns:

instance of interface if supported; Otherwise, None

Return type:

T | None

Note

When raise_err=True return value will never be None.

remove_event_observer(observer)

Removes an observer

Parameters:

observer (EventObserver) – One or more observers to add.

Returns:

True if observer has been removed; Otherwise, False.

Return type:

bool

remove_event_properties_listener()

Remove Properties Listener

Return type:

None

remove_event_property_change(name)

Removes a listener for an event

Parameters:

name (str) – Property Name

Return type:

None

remove_event_property_change_events_disposing(name)

Removes a listener for an event

Parameters:

name (str) – Property Name

Return type:

None

remove_event_vetoable_change(name)

Removes a listener for an event

Parameters:

name (str) – Property Name

Return type:

None

remove_event_vetoable_change_events_disposing(name)

Removes a listener for an event

Parameters:

name (str) – Property Name

Return type:

None

set_property(**kwargs)

Set property value

Parameters:

**kwargs (Any) – Variable length Key value pairs used to set properties.

Return type:

None

set_text(*strings)

Sets the text of the title.

Return type:

None

Parameters:

strings (com.sun.star.chart2.XFormattedString) –

style_area_color(color=-1)

Style Area Color.

Parameters:

color (Color, optional) – FillColor Color. Defaults to StandardColor.AUTO_COLOR.

Raises:

CancelEventError – If the event before_style_area_color is cancelled and not handled.

Returns:

FillColor instance or None if cancelled.

Return type:

FillColorT | None

style_area_color_get()

Gets the Area Color Style.

Raises:

CancelEventError – If the event before_style_area_color_get is cancelled and not handled.

Returns:

Area color style or None if cancelled.

Return type:

FillColorT | None

style_area_gradient(*, style=GradientStyle.LINEAR, step_count=0, offset=Offset(x=50, y=50), angle=0, border=0, grad_color=ColorRange(start=0, end=16777215), grad_intensity=IntensityRange(start=100, end=100), name='')

Style Area Color.

Parameters:

• style (GradientStyle, optional) – Specifies the style of the gradient. Defaults to GradientStyle.LINEAR.

• step_count (int, optional) – Specifies the number of steps of change color. Defaults to 0.

• offset (Offset, int, optional) – Specifies the X and Y coordinate, where the gradient begins. X is effectively the center of the RADIAL, ELLIPTICAL, SQUARE and RECT style gradients. Defaults to Offset(50, 50).

• angle (Angle, int, optional) – Specifies angle of the gradient. Defaults to 0.

• border (int, optional) – Specifies percent of the total width where just the start color is used. Defaults to 0.

• grad_color (ColorRange, optional) – Specifies the color at the start point and stop point of the gradient. Defaults to ColorRange(Color(0), Color(16777215)).

• grad_intensity (IntensityRange, optional) – Specifies the intensity at the start point and stop point of the gradient. Defaults to IntensityRange(100, 100).

• name (str, optional) – Specifies the Fill Gradient Name.

Raises:

CancelEventError – If the event before_style_area_gradient is cancelled and not handled.

Returns:

Chart Fill Gradient instance or None if cancelled.

Return type:

ChartFillGradientT | None

Hint

• GradientStyle can be imported from ooo.dyn.awt.gradient_style

• Angle can be imported from ooodev.units

• ColorRange can be imported from ooodev.utils.data_type.color_range

• Intensity can be imported from ooodev.utils.data_type.intensity

• IntensityRange can be imported from ooodev.utils.data_type.intensity_range

• Offset can be imported from ooodev.utils.data_type.offset

style_area_gradient_from_preset(preset)

Style Area Gradient from Preset.

Parameters:

preset (PresetGradientKind) – Preset Gradient Kind.

Returns:

Chart Fill Gradient instance.

Return type:

ChartFillGradientT

Hint

• PresetGradientKind can be imported from ooodev.format.inner.preset.preset_gradient

style_area_gradient_get()

Gets the Area Gradient Style.

Raises:

CancelEventError – If the event before_style_area_gradient_get is cancelled and not handled.

Returns:

Gradient style or None if cancelled.

Return type:

ChartFillGradientT | None

style_area_hatch(*, style=HatchStyle.SINGLE, color=0, space=0, angle=0, bg_color=-1)

Style Area Color.

Parameters:

• style (HatchStyle, optional) – Specifies the kind of lines used to draw this hatch. Default HatchStyle.SINGLE.

• color (Color, optional) – Specifies the color of the hatch lines. Default 0.

• space (float, UnitT, optional) – Specifies the space between the lines in the hatch (in mm units) or Class UnitT. Default 0.0

• angle (Angle, int, optional) – Specifies angle of the hatch in degrees. Default to 0.

• bg_color (Color, optional) – Specifies the background Color. Set this -1 (default) for no background color.

Raises:

CancelEventError – If the event before_style_area_hatch is cancelled and not handled.

Returns:

Fill Image instance or None if cancelled.

Return type:

ChartFillHatchT | None

Hint

• Angle can be imported from ooodev.units

• HatchStyle can be imported from ooo.dyn.drawing.hatch_style

style_area_hatch_from_preset(preset)

Style Area Gradient from Preset.

Parameters:

preset (PresetHatchKind) – Preset Hatch Kind.

Returns:

Chart Fill Hatch instance or None if before_style_area_hatch_from_preset event is cancelled.

Return type:

ChartFillHatchT | None

Hint

• PresetHatchKind can be imported from ooodev.format.inner.preset.preset_hatch

style_area_image(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False)

Style Area Color.

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 in mm 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 to False.

Raises:

CancelEventError – If the event before_style_area_img is cancelled and not handled.

Returns:

Fill Image instance or None if cancelled.

Return type:

ChartFillImgT | None

Hint

• RectanglePoint can be imported from ooo.dyn.drawing.rectangle_point

• ImgStyleKind can be imported from ooodev.format.inner.direct.write.fill.area.img

• SizePercent can be imported from ooodev.format.inner.common.format_types.size_percent

• SizeMM can be imported from ooodev.utils.data_type.size_mm

• OffsetColumn can be imported from ooodev.format.inner.common.format_types.offset_column

• OffsetRow can be imported from ooodev.format.inner.common.format_types.offset_row

• Offset can be imported from ooodev.utils.data_type.offset

style_area_image_from_preset(preset)

Style Area Gradient from Preset.

Parameters:

preset (PresetImageKind) – Preset Image Kind.

Returns:

Chart Fill Image instance.

Return type:

ChartFillImgT

Hint

• PresetImageKind can be imported from ooodev.format.inner.preset.preset_image

style_area_image_get()

Gets the Area Area Image Style.

Raises:

CancelEventError – If the event before_style_area_img_get is cancelled and not handled.

Returns:

Area image style or None if cancelled.

Return type:

ChartFillImgT | None

style_area_pattern(*, bitmap=None, name='', tile=True, stretch=False, auto_name=False)

Style Area Color.

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 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.

Raises:

CancelEventError – If the event before_style_area_pattern is cancelled and not handled.

Returns:

Fill Image instance or None if cancelled.

Return type:

ChartFillPatternT | None

style_area_pattern_from_preset(preset)

Style Area Gradient from Preset.

Parameters:

preset (PresetPatternKind) – Preset Image Kind.

Returns:

Chart Fill Image instance.

Return type:

ChartFillPatternT

Hint

• PresetPatternKind can be imported from ooodev.format.inner.preset.preset_pattern

style_area_pattern_get()

Gets the Area Area Pattern Style.

Raises:

CancelEventError – If the event before_style_area_pattern_get is cancelled and not handled.

Returns:

Area pattern style or None if cancelled.

Return type:

ChartFillPatternT | None

style_border_line(color=0, width=0, transparency=0, style=BorderLineKind.CONTINUOUS)

Style border line.

Parameters:

• color (Color, optional) – Line Color. Defaults to Color(0).

• width (float | UnitT, optional) – Line Width (in mm units) or Class UnitT. Defaults to 0.

• transparency (int | Intensity, optional) – Line transparency from 0 to 100. Defaults to 0.

• style (BorderLineKind, optional) – Line style. Defaults to BorderLineKind.CONTINUOUS.

Raises:

CancelEventError – If the event before_style_chart_border_line is cancelled and not handled.

Returns:

Line properties style or None if cancelled.

Return type:

LinePropertiesT | None

Hint

• BorderLineKind can be imported from ooodev.format.inner.preset.preset_border_line

• Intensity can be imported from ooodev.utils.data_type.intensity

style_border_line_get()

Gets the line properties style.

Raises:

CancelEventError – If the event before_style_chart_border_line_get is cancelled and not handled.

Returns:

Line properties style or None if cancelled.

Return type:

LinePropertiesT | None

style_font(name=None, size=None, font_style=None, lang=None)

Style Font.

Parameters:

• name (str | None, optional) – Font Name.

• size (float | UnitT | None, optional) – Font Size in PT units or UnitT.

• font_style (str | None, optional) – Font Style such as Bold Italics

• lang (FontLangT | None, optional) – Font Language.

Raises:

CancelEventError – If the event before_style_font_only is cancelled and not handled.

Returns:

Font Only instance or None if cancelled.

Return type:

FontOnlyT | None

See also

FontLang

style_font_effect(*, color=None, transparency=None, overline=None, underline=None, strike=None, word_mode=None, case=None, relief=None, outline=None, hidden=None, shadowed=None)

Style Font options.

Parameters:

• color (Color, optional) – The value of the text color. If value is -1 the automatic color is applied.

• transparency (Intensity, int, optional) – The transparency value from 0 to 100 for the font color.

• overline (FontLine, optional) – Character overline values.

• underline (FontLine, optional) – Character underline values.

• strike (FontStrikeoutEnum, optional) – Determines the type of the strike out of the character.

• word_mode (bool, optional) – If True, the underline and strike-through properties are not applied to white spaces.

• case (CaseMapEnum, optional) – Specifies the case of the font.

• relief (FontReliefEnum, optional) – Specifies the relief of the font.

• outline (bool, optional) – Specifies if the font is outlined.

• hidden (bool, optional) – Specifies if the font is hidden.

• shadowed (bool, optional) – Specifies if the characters are formatted and displayed with a shadow effect.

Raises:

CancelEventError – If the event before_style_font_effect is cancelled and not handled.

Returns:

Font Effects instance or None if cancelled.

Return type:

FontEffectsT | None

Hint

• CaseMapEnum can be imported from ooo.dyn.style.case_map

• FontReliefEnum can be imported from ooo.dyn.awt.font_relief

• FontStrikeoutEnum can be imported from ooo.dyn.awt.font_strikeout

• FontLine can be imported from ooodev.format.inner.direct.write.char.font.font_effects

• Intensity can be imported from ooodev.utils.data_type.intensity

• FontUnderlineEnum can be imported from ooo.dyn.awt.font_underline

style_font_effect_get()

Gets the font effect Style.

Raises:

CancelEventError – If the event before_style_font_effect_get is cancelled and not handled.

Returns:

Font Effect style or None if cancelled.

Return type:

FontEffectsT | None

style_font_effect_line(line=None, color=None, overline=False)

Style Font Underline or Overline.

This method is a subset of style_font_effect() method for convenience.

Parameters:

• color (Color, optional) – The value of the text color. If value is -1 the automatic color is applied.

• line (FontUnderlineEnum, optional) – Font Line kind.

• overline (bool, optional) – If True the line is overline, otherwise it is underline.

Raises:

CancelEventError – If the event before_style_font_effect is cancelled and not handled.

Returns:

Font Effects instance or None if cancelled.

Return type:

FontEffectsT | None

Hint

• FontUnderlineEnum can be imported from ooo.dyn.awt.font_underline

style_font_general(b=None, i=None, u=None, bg_color=None, bg_transparent=None, charset=None, color=None, family=None, name=None, overline=None, rotation=None, shadow_fmt=None, shadowed=None, size=None, slant=None, spacing=None, strike=None, subscript=None, superscript=None, underline=None, weight=None, word_mode=None)

Style Font.

Parameters:

• b (bool, optional) – Shortcut to set weight to bold.

• i (bool, optional) – Shortcut to set slant to italic.

• u (bool, optional) – Shortcut ot set underline to underline.

• bg_color (Color, optional) – The value of the text background color.

• bg_transparent (bool, optional) – Determines if the text background color is set to transparent.

• charset (CharSetEnum, optional) – The text encoding of the font.

• color (Color, optional) – The value of the text color. Setting to -1 will cause automatic color.

• family (FontFamilyEnum, optional) – Font Family.

• name (str, optional) – This property specifies the name of the font style. It may contain more than one name separated by comma.

• overline (FontLine, optional) – Character overline values.

• rotation (int, Angle, optional) – Specifies the rotation of a character in degrees. Depending on the implementation only certain values may be allowed.

• shadow_fmt (ShadowFormat | None) – (ShadowFormat, optional): Determines the type, color, and width of the shadow.

• shadowed (bool, optional) – Specifies if the characters are formatted and displayed with a shadow effect.

• size (float, UnitT, optional) – This value contains the size of the characters in pt (point) units or Class UnitT.

• slant (FontSlant, optional) – The value of the posture of the document such as FontSlant.ITALIC.

• spacing (CharSpacingKind, float, UnitT, optional) – Specifies character spacing in pt (point) units or Class UnitT.

• strike (FontStrikeoutEnum, optional) – Determines the type of the strike out of the character.

• subscript (bool, optional) – Subscript option.

• superscript (bool, optional) – Superscript option.

• underline (FontLine, optional) – Character underline values.

• weight (FontWeightEnum, optional) – The value of the font weight.

• word_mode (bool, optional) – If True, the underline and strike-through properties are not applied to white spaces.

Raises:

CancelEventError – If the event before_style_general_font is cancelled and not handled.

Returns:

Font instance or None if cancelled.

Return type:

FontT | None

Hint

• FontFamilyEnum can be imported from ooo.dyn.awt.font_family

• CharSetEnum can be imported from ooo.dyn.awt.char_set

• ShadowFormat can be imported from ooo.dyn.table.shadow_format

• FontSlant can be imported from ooo.dyn.awt.font_slant

• FontStrikeoutEnum can be imported from ooo.dyn.awt.font_strikeout

• FontWeightEnum can be imported from ooo.dyn.awt.font_weight

• FontLine can be imported from ooodev.format.inner.direct.write.char.font.font_effects

• CharSpacingKind can be imported from ooodev.format.inner.direct.write.char.font.font_position

style_font_get()

Gets the font Style.

Raises:

CancelEventError – If the event before_style_font_only_get is cancelled and not handled.

Returns:

Font style or None if cancelled.

Return type:

FontOnlyT | None

style_orientation(angle=None, vertical=None)

Style Chart2 Data Series Text Attributes.

Parameters:

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

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

Raises:

CancelEventError – If the event before_style_chart2_text_orientation is cancelled and not handled.

Returns:

Orientation Style instance or None if cancelled.

Return type:

Orientation | None

style_position(x, y)

Style Area Color.

Parameters:

• x (float, UnitT) – Specifies the x-coordinate of the position of the shape (in mm units) or Class UnitT.

• y (float, UnitT) – Specifies the y-coordinate of the position of the shape (in mm units) or Class UnitT.

Raises:

CancelEventError – If the event before_style_position is cancelled and not handled.

Returns:

Position instance or None if cancelled.

Return type:

PositionT | None

style_position_get()

Gets the Position Style.

Raises:

CancelEventError – If the event before_style_position_get is cancelled and not handled.

Returns:

Position style or None if cancelled.

Return type:

PositionT | None

style_write_mode(mode=DirectionModeKind.PAGE)

Style Chart2 Data Series Text Writing Mode.

Parameters:

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

Raises:

CancelEventError – If the event before_style_chart2_text_direction is cancelled and not handled.

Returns:

Direction Style instance or None if cancelled.

Return type:

Direction | None

Hint

• DirectionModeKind can be imported from ooodev.format.chart2.direct.title.alignment

subscribe_event(event_name, callback)

Add an event listener to current instance.

Parameters:

• event_name (str) – Event Name.

• callback (EventCallback) – Callback of the event listener.

Return type:

None

support_service(*service)

Gets if instance supports a service.

Parameters:

*service (str) – Variable length argument list of UNO namespace strings such as com.sun.star.configuration.GroupAccess

Returns:

True if instance supports any passed in service; Otherwise, False

Return type:

bool

trigger_event(event_name, event_args)

Trigger an event on current instance.

Parameters:

• event_name (str) – Event Name.

• event_args (EventArgsT) – Event Args.

Return type:

None

unsubscribe_event(event_name, callback)

Remove an event listener from current instance.

Parameters:

• event_name (str) – Event Name.

• callback (EventCallback) – Callback of the event listener.

Return type:

None

property border_distance: UnitMM100 | None

Gets/Sets the distance from the border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:

UnitMM100 | None

property bottom_border: BorderLine2StructComp | None

Gets/Sets the bottom border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:

Returns BorderLine2 or None if not supported.

Return type:

BorderLine2StructComp | None

Hint

• BorderLine2 can be imported from ooo.dyn.table.border_line2

property bottom_border_distance: UnitMM100 | None

Gets/Sets the distance from the bottom border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:

UnitMM100 | None

property break_type: BreakType | None

Gets/Sets the type of break that is applied at the beginning of the table.

optional

Returns:

Returns BreakType or None if not supported.

Return type:

BreakType | None

Hint

• BreakType can be imported from ooo.dyn.style.break_type

property calc_doc: CalcDoc

Calc Document.

Return type:

CalcDoc

property calc_sheet: CalcSheet

Calc Sheet.

Return type:

CalcSheet

property chart_doc: ChartDoc

Chart Document.

Return type:

ChartDoc

property component: com.sun.star.chart2.Title

Title Component

Return type:

Title

property continuing_previous_sub_tree: bool | None

Gets that a child node of a parent node that is not counted is continuing the numbering of parent’s previous node’s sub tree.

optional

Return type:

bool | None

property drop_cap_char_style_name: str | None

Gets/Sets the character style name for drop caps.

optional

Return type:

str | None

property drop_cap_format: DropCapFormatStructComp | None

Gets/Sets whether the first characters of the paragraph are displayed in capital letters and how they are formatted.

optional

Returns:

Drop cap format or None if not supported.

Return type:

DropCapFormatStructComp

Hint

• DropCapFormat can be imported from ooo.dyn.style.drop_cap_format

property drop_cap_whole_word: bool | None

Gets/Sets if the property DropCapFormat is applied to the whole first word.

optional

Return type:

bool | None

property event_observer: EventObserver

Gets/Sets The Event Observer for this instance.

Return type:

EventObserver

property events_listener_properties_change_implement: PropertiesChangeListener

Returns listener

Return type:

PropertiesChangeListener

property fill_background: bool

Gets/Sets whether the transparent background of a hatch filled area is drawn in the current background color.

If this is True, the transparent background of a hatch filled area is drawn in the current background color.

Return type:

bool

property fill_bitmap: XBitmap | None

Gets/Sets the bitmap used for filling.

If the property fill_style is set to FillStyle.BITMAP, this is the bitmap used.

optional

Return type:

XBitmap | None

property fill_bitmap_logical_size: bool

Gets/Sets if the size is given in percentage or as an absolute value.

If this is True, the properties fill_bitmap_size_x and fill_bitmap_size_y contain the size of the tile in percent of the size of the original bitmap. If this is False, the size of the tile is specified with 1/100th mm.

Return type:

bool

property fill_bitmap_mode: BitmapMode

Gets/Sets how an area is filled with a single bitmap.

This enum selects how an area is filled with a single bitmap.

This property corresponds to the properties fill_bitmap_stretch and fill_bitmap_tile.

If set to BitmapMode.REPEAT, the property fill_bitmap_stretch is set to False, and the property fill_bitmap_tile is set to True.

If set to BitmapMode.STRETCH, the property fill_bitmap_stretch is set to True, and the property fill_bitmap_tile is set to False.

If set to BitmapMode.NO_REPEAT, both properties fill_bitmap_stretch and fill_bitmap_tile are set to False.

Returns:

Bitmap Mode

Return type:

BitmapMode

Hint

• BitmapMode can be imported from ooo.dyn.drawing.bitmap_mode.

property fill_bitmap_name: str

If the property FillStyle is set to FillStyle.BITMAP, this is the name of the used fill bitmap style.

Return type:

str

property fill_bitmap_offset_x: int

Gets/Sets - Every second line of tiles is moved the given percent of the width of the bitmap.

Return type:

int

property fill_bitmap_offset_y: int

Gets/Sets - Every second row of tiles is moved the given percent of the height of the bitmap.

Return type:

int

property fill_bitmap_position_offset_x: int

Gets/Sets the horizontal offset where the tile starts.

It is given in percent in relation to the width of the bitmap.

Return type:

int

property fill_bitmap_position_offset_y: int

Gets/Sets the vertical offset where the tile starts.

It is given in percent in relation to the height of the bitmap.

Return type:

int

property fill_bitmap_rectangle_point: RectanglePoint

Gets/Sets - RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.

Returns:

RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.

Return type:

RectanglePoint

Hint

• RectanglePoint can be imported from ooo.dyn.drawing.rectangle_point.

property fill_bitmap_size_x: int

Gets/Sets the width of the tile for filling.

Depending on the property fill_bitmap_logical_size, this is either relative or absolute.

If fill_bitmap_logical_size is True then property contain the size of the tile in percent of the size of the original bitmap; Otherwise, the size of the tile is specified with 1/100th mm.

Return type:

int

property fill_bitmap_size_y: int

Gets/Sets the height of the tile for filling.

This is the height of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

If fill_bitmap_logical_size is True then property contain the size of the tile in percent of the size of the original bitmap; Otherwise, the size of the tile is specified with 1/100th mm.

Return type:

int

property fill_bitmap_stretch: bool | None

Gets/Sets if the fill bitmap is stretched to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The fill_bitmap_mode property can be used instead to set all supported bitmap modes.

If set to True, the value of the fill_bitmap_mode property changes to BitmapMode.STRETCH. BUT: behavior is undefined, if the property fill_bitmap_tile is True too.

If set to False, the value of the fill_bitmap_mode property changes to BitmapMode.REPEAT or BitmapMode.NO_REPEAT, depending on the current value of the fill_bitmap_tile property.

optional

Return type:

bool | None

property fill_bitmap_tile: bool | None

Get/Sets the fill bitmap is repeated to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The fill_bitmap_mode property can be used instead to set all supported bitmap modes.

If set to True, the value of the fill_bitmap_mode property changes to BitmapMode.REPEAT. BUT: behavior is undefined, if the property fill_bitmap_stretch is True too.

If set to False, the value of the fill_bitmap_mode property changes to BitmapMode.STRETCH or BitmapMode.NO_REPEAT, depending on the current value of the fill_bitmap_stretch property.

optional

Return type:

bool | None

property fill_bitmap_url: str | None

Gets/Sets the URL of the bitmap used for filling.

If the property fill_style is set to FillStyle.BITMAP, this is a URL to the bitmap used.

Note the new behavior since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When a URL is set, then it will load the bitmap and set the fill_bitmap property.

optional

Return type:

str | None

property fill_color: com.sun.star.util.Color

Gets/Sets the color used for filling.

If the property fill_style is set to FillStyle.SOLID, this is the color used.

Return type:

Color

property fill_gradient: GradientStructComp | None

Gets/Sets the gradient used for filling.

If the property fill_style is set to FillStyle.GRADIENT, this describes the gradient used.

Note when setting the gradient it can be a GradientStructComp or a Gradient struct.

optional

Returns:

Gradient Struct Component or None if not supported.

Return type:

GradientStructComp | None

Hint

• Gradient can be imported from ooo.dyn.awt.gradient.

property fill_gradient_name: str

Gets/Sets the name of the used fill gradient style.

If the property fill_style is set to FillStyle.GRADIENT, this is the name of the used fill gradient style.

Return type:

str

property fill_hatch: HatchStructComp | None

Gets/Sets the hatch used for filling.

If the property fill_style is set to FillStyle.HATCH, this describes the hatch used.

optional

Return type:

HatchStructComp | None

property fill_hatch_name: str

Gets/Sets the name of the used fill hatch style.

If the property fill_style is set to FillStyle.HATCH, this is the name of the used fill hatch style.

Return type:

str

property fill_style: FillStyle

Gets/Sets the enumeration selects the style the area will be filled with.

Returns:

Fill Style

Return type:

FillStyle

Hint

• FillStyle can be imported from ooo.dyn.drawing.fill_style.

property fill_transparence: int

Gets/Sets the transparence of the filled area.

This property is only valid if the property fill_style is set to FillStyle.SOLID.

Return type:

int

property fill_transparence_gradient: GradientStructComp | None

Gets/Sets the transparency of the fill area as a gradient.

Note when setting the gradient it can be a GradientStructComp or a Gradient struct.

optional

Returns:

Gradient Struct Component or None if not supported.

Return type:

GradientStructComp | None

Hint

• Gradient can be imported from ooo.dyn.awt.gradient.

property fill_transparence_gradient_name: str

Gets/Sets the name of the used transparence gradient style.

If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty.

If you set the name of a transparence gradient style contained in the document, this style used.

Return type:

str

property fill_use_slide_background: bool | None

The area displays the slide background.

since

LibreOffice 7.4

optional

Type:

If this is True, and fill_style is FillStyle.NONE

Return type:

bool | None

property graphic_crop: GraphicCropStructComp[UnitMM100] | None

Gets/Sets the cropping of the object.

If the property fill_bitmap_mode is set to BitmapMode.STRETCH, this is the cropping, otherwise it is empty.

When setting the cropping it can be a GraphicCropStructComp or a GraphicCrop struct.

optional

Returns:

Graphic Crop Struct Component or None if not supported.

Return type:

GraphicCropStructComp | None

Hint

• GraphicCrop can be imported from ooo.dyn.text.graphic_crop.

property left_border: BorderLine2StructComp | None

Gets/Sets the left border of the object.

optional

Return type:

BorderLine2StructComp | None

property left_border_distance: UnitMM100 | None

Gets/Sets the distance from the left border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:

UnitMM100 | None

property line_cap: LineCap | None

Gets/Sets the rendering of ends of thick lines.

optional:

Returns:

The line cap.

Return type:

LineCap

Hint

• LineCap can be imported from ooo.dyn.drawing.line_cap

property line_color: com.sun.star.util.Color

Gets/Sets the line color.

Return type:

Color

property line_dash: LineDashStructComp

Gets/Sets the dash of the line.

When setting the value can be a LineDash or a LineDashStructComp.

Returns:

The line dash.

Return type:

LineDashStructComp

Hint

• LineDash can be imported from ooo.dyn.drawing.line_dash

property line_dash_name: str

Gets/Sets the name of the dash of the line.

Return type:

str

property line_end: PolyPolygonBezierCoords | None

Gets/Sets the line end in the form of a poly polygon Bezier.

optional

Return type:

PolyPolygonBezierCoords | None

property line_end_center: bool | None

Gets/Sets the line end center.

If this property is True, the line will end in the center of the polygon.

optional

Return type:

bool | None

property line_end_name: str | None

Gets/Sets the name of the line end poly polygon Bezier.

If this string is empty, no line end polygon is rendered.

optional

Return type:

str | None

property line_end_width: UnitMM100 | None

Gets/Sets the width of the line end polygon.

When setting this property, you can use either an integer or a UnitT object.

optional

Returns:

The width of the line end polygon or None if not available.

Return type:

UnitMM100

Hint

• UnitMM100 can be imported from ooodev.units.

property line_joint: LineJoint

Gets/Sets the rendering of joints between thick lines.

Returns:

The line joint.

Return type:

LineJoint

Hint

• LineJoint can be imported from ooo.dyn.drawing.line_joint

property line_start: PolyPolygonBezierCoords | None

Gets/Sets the line start in the form of a poly polygon Bezier.

optional

Return type:

PolyPolygonBezierCoords | None

property line_start_center: bool | None

Gets/Sets the line start center.

If this property is True, the line will start from the center of the polygon.

optional

Return type:

bool | None

property line_start_name: str | None

Gets/Sets the name of the line start poly polygon Bezier.

If this string is empty, no line start polygon is rendered.

optional

Return type:

str | None

property line_start_width: UnitMM100 | None

Gets/Sets the width of the line start polygon.

When setting this property, you can use either an integer or a UnitT object.

optional

Returns:

The width of the line start polygon or None if not available.

Return type:

UnitMM100

Hint

• UnitMM100 can be imported from ooodev.units.

property line_style: LineStyle

Gets/Sets the type of the line.

Returns:

Line Style.

Return type:

LineStyle

Hint

• LineStyle can be imported from ooo.dyn.drawing.line_style

property line_transparence: int

Gets/Sets the extent of transparency.

Return type:

int

property line_width: UnitMM100

Gets/Sets the width of the line in 1/100th mm units.

Return type:

UnitMM100

property list_id: str | None

Gets/Sets the id of the list to which the paragraph belongs.

optional

Return type:

str | None

property list_label_string: str | None

Gets reading the generated numbering list label.

optional

Return type:

str | None

property lo_inst: LoInst

Lo Instance

Return type:

LoInst

property numbering_is_number: bool | None

Gets/Sets.

Returns False if the paragraph is part of a numbering, but has no numbering label.

A paragraph is part of a numbering, if a style for a numbering is set - see numbering_style_name. If the paragraph is not part of a numbering the property is void.

optional

Return type:

bool | None

property numbering_level: int | None

Gets/Sets the numbering level of the paragraph.

optional

Return type:

int | None

property numbering_rules: IndexReplaceComp | None

Gets/Sets the numbering rules applied to this paragraph.

When setting the value, it can be either an instance of XIndexReplace or IndexReplaceComp.

optional

Return type:

IndexReplaceComp | None

property numbering_start_value: int | None

Gets/Sets the start value for numbering if a new numbering starts at this paragraph.

optional

Return type:

int | None

property numbering_style_name: str | None

Gets/Sets the name of the style for the numbering.

The name must be one of the names which are available via XStyleFamiliesSupplier.

optional

Return type:

str | None

property office_doc: OfficeDocumentT

Office Document.

Return type:

OfficeDocumentT

property outline_level: int | None

Gets/Sets the outline level to which the paragraph belongs

Value 0 indicates that the paragraph belongs to the body text.

Values [1..10] indicates that the paragraph belongs to the corresponding outline level.

optional

Return type:

int | None

property owner: _T

Chart Document

Return type:

TypeVar(_T, bound= ComponentT)

property page_desc_name: str | None

If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use.

optional

Return type:

str | None

property page_number_offset: int | None

Gets/Sets if a page break property is set at a paragraph, this property contains the new value for the page number.

optional

Return type:

int | None

property page_style_name: str | None

Gets the name of the current page style.

optional

Return type:

str | None

property para_adjust: ParagraphAdjust

Gets/Sets the adjustment of a paragraph.

Returns:

Paragraph adjustment.

Return type:

ParagraphAdjust

Hint

• ParagraphAdjust can be imported from ooo.dyn.style.paragraph_adjust

property para_back_color: Color | None

Gets/Sets the paragraph background color.

optional

Returns:

Color or None if not supported.

Return type:

Color | None

property para_back_graphic: XGraphic | None

Gets/Sets the graphic for the background of a paragraph.

optional

Return type:

XGraphic | None

property para_back_graphic_filter: str | None

Gets/Sets the name of the graphic filter for the background graphic of a paragraph.

optional

Return type:

str | None

property para_back_graphic_location: GraphicLocation | None

Gets/Sets the value for the position of a background graphic.

optional

Returns:

Returns GraphicLocation or None if not supported.

Return type:

GraphicLocation | None

Hint

• GraphicLocation can be imported from ooo.dyn.style.graphic_location

property para_back_graphic_url: str | None

Gets/Sets the value of a link for the background graphic of a paragraph.

Note the new behavior since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the ParaBackGraphic property.

optional

Return type:

str | None

property para_back_transparent: bool | None

Gets/Sets if the paragraph background color is set to transparent.

This value is True if the paragraph background color is set to transparent.

optional

Return type:

bool | None

property para_bottom_margin: UnitMM100

Gets/Sets the bottom margin of the paragraph in 100th mm.

The distance between two paragraphs is specified by:

The greater one is chosen.

This property accepts int and UnitT types when setting.

Return type:

UnitMM100

property para_context_margin: bool | None

Gets/Sets if contextual spacing is used.

If True, the top and bottom margins of the paragraph should not be applied when the previous and next paragraphs have the same style.

optional

Return type:

bool | None

property para_expand_single_word: bool | None

Gets/Sets if single words are stretched.

It is only valid if para_adjust and para_last_line_adjust are also valid.

optional

Return type:

bool | None

property para_first_line_indent: int | None

Gets/Sets the indent for the first line.

optional

Return type:

int | None

property para_hyphenation_max_hyphens: int | None

Gets/Sets the maximum number of consecutive hyphens.

optional

Return type:

int | None

property para_hyphenation_max_leading_chars: int | None

Gets/Sets the minimum number of characters to remain before the hyphen character (when hyphenation is applied).

Note

Confusingly it is named Max but specifies a minimum.

optional

Return type:

int | None

property para_hyphenation_max_trailing_chars: int | None

Gets/Sets the minimum number of characters to remain after the hyphen character (when hyphenation is applied).

optional

Note

Confusingly it is named Max but specifies a minimum.

Return type:

int | None

property para_hyphenation_min_word_length: int | None

Gets/Sets the minimum word length in characters, when hyphenation is applied.

since

LibreOffice 7.4

optional

Return type:

int | None

property para_hyphenation_no_caps: bool | None

Specifies whether words written in CAPS will be hyphenated.

Setting to true will disable hyphenation of words written in CAPS for this paragraph.

optional

Return type:

bool | None

property para_hyphenation_no_last_word: bool | None

Specifies whether last word of paragraph will be hyphenated.

Setting to true will disable hyphenation of last word for this paragraph.

since

LibreOffice 7.4

optional

Return type:

bool | None

property para_hyphenation_zone: int | None

Gets/Sets the hyphenation zone, i.e. allowed extra white space in the line before applying hyphenation.

since

LibreOffice 7.4

optional

Return type:

int | None

property para_interop_grab_bag: Tuple[PropertyValue, ...] | None

Gets/Sets grab bag of paragraph properties, used as a string-any map for interim interop purposes.

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

optional:

Return type:

Tuple[PropertyValue, …] | None

property para_is_auto_first_line_indent: bool | None

Gets/Sets if the first line should be indented automatically.

optional

Return type:

bool | None

property para_is_connect_border: bool | None

Gets/Sets if borders set at a paragraph are merged with the next paragraph.

Borders are only merged if they are identical.

optional

Return type:

bool | None

property para_is_hyphenation: bool

Gets/Sets if automatic hyphenation is applied.

Return type:

bool

property para_is_numbering_restart: bool | None

Gets/Sets if the numbering rules restart, counting at the current paragraph.

optional

Return type:

bool | None

property para_keep_together: bool | None

Gets/Sets if page or column breaks between this and the following paragraph are prevented.

Setting this property to True prevents page or column breaks between this and the following paragraph.

This feature is useful for preventing title paragraphs to be the last line on a page or column.

optional

Return type:

bool | None

property para_last_line_adjust: int

Gets/Sets the adjustment of the last line.

It is only valid if para_adjust is set to block.

Return type:

int

property para_left_margin: UnitMM100

Gets/Sets the left margin of the paragraph in 1/100th mm` units.

This property accepts int and UnitT types when setting.

Return type:

UnitMM100

property para_line_number_count: bool | None

Gets/Sets if the paragraph is included in the line numbering.

optional

Return type:

bool | None

property para_line_number_start_value: int | None

Gets/Sets the start value for the line numbering.

optional

Return type:

int | None

property para_line_spacing: LineSpacingStructComp | None

Gets/Sets the type of the line spacing of a paragraph.

Setting value can be done with a LineSpacing or LineSpacingStructComp object.

optional

Returns:

Returns BorderLine2 or None if not supported.

Return type:

LineSpacingStructComp | None

Hint

• LineSpacing can be imported from ooo.dyn.style.line_spacing

property para_orphans: int | None

Gets/Sets the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page.

optional

Return type:

int | None

property para_register_mode_active: bool | None

Gets/Sets if the register mode is applied to a paragraph.

Note

Register mode is only used if the register mode property of the page style is switched on.

optional

Return type:

bool | None

property para_right_margin: UnitMM100

Gets/Sets the right margin of the paragraph in 100th mm units.

This property accepts float and UnitT types when setting.

Return type:

UnitMM100

property para_shadow_format: ShadowFormat | None

Gets/Sets the type, color, and size of the shadow.

optional

Return type:

ShadowFormat | None

property para_split: bool | None

Gets/Sets - Setting this property to False prevents the paragraph from getting split into two pages or columns.

optional

Return type:

bool | None

property para_style_name: str | None

Gets/Sets the name of the current paragraph style.

optional

Return type:

str | None

property para_tab_stops: Tuple[TabStop, ...] | None

Gets/Sets the positions and kinds of the tab stops within this paragraph.

optional:

Return type:

Tuple[TabStop, …] | None

property para_top_margin: UnitMM100

determines the top margin of the paragraph in 100th mm units.

The distance between two paragraphs is specified by:

The greater one is chosen.

This property accepts float and UnitT types when setting.

Return type:

UnitMM100

property para_user_defined_attributes: NameContainerComp | None

Gets/Sets - this property stores xml attributes.

They will be saved to and restored from automatic styles inside xml files.

Can be set with XNameContainer or NameContainerComp.

optional

Return type:

NameContainerComp | None

property para_vert_alignment: ParagraphVertAlignEnum | None

Gets/Set the vertical alignment of a paragraph.

When setting the value, it can be either an integer or an instance of ParagraphVertAlignEnum.

optional

Return type:

ParagraphVertAlignEnum | None

property para_widows: int | None

Gets/Sets the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page.

optional

Return type:

int | None

property right_border: BorderLine2StructComp | None

Gets/Sets the right border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:

Returns BorderLine2 or None if not supported.

Return type:

BorderLine2StructComp | None

Hint

• BorderLine2 can be imported from ooo.dyn.table.border_line2

property right_border_distance: UnitMM100 | None

Gets/Sets the distance from the right border to the object.

When setting the value, it can be either an float or an instance of UnitT.

optional

Return type:

UnitMM100 | None

property rotation: Angle

Gets or sets the rotation angle of the title.

Return type:

Angle

property title_kind: ChartTitleKind

Gets the title kind.

Return type:

ChartTitleKind

property top_border: BorderLine2StructComp | None

Gets/Sets the top border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:

Returns BorderLine2 or None if not supported.

Return type:

BorderLine2StructComp | None

Hint

• BorderLine2 can be imported from ooo.dyn.table.border_line2

property top_border_distance: UnitMM100 | None

Gets/Sets the distance from the top border to the object.

When setting the value, it can be either an float or an instance of UnitT.

optional

Return type:

UnitMM100 | None