Class ChartAxis

class ooodev.calc.chart2.chart_axis.ChartAxis(owner, component, axis_kind, lo_inst=None)[source]

Bases: LoInstPropsPartial, AxisComp, EventsPartial, ChartDocPropPartial, PropPartial, QiPartial, ServicePartial, TheDictionaryPartial, CalcDocPropPartial, CalcSheetPropPartial, StylePartial, FontOnlyPartial, FontEffectsPartial, FontPartial, AxisLinePropertiesPartial, Chart2AxisPosAxisLinePartial, Chart2AxisPosIntervalMarksPartial, Chart2AxisPosLabelPositionPartial, Chart2AxisPosPositionAxisPartial, NumbersNumbersPartial, Chart2GridLinePartial

Class for managing Chart2 Chart Title Component.

Parameters:
__init__(owner, component, axis_kind, lo_inst=None)[source]

Constructor

Parameters:

  • component (Any) – UNO Chart2 Title Component.

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

  • owner (ChartDoc) –

  • axis_kind (ChartAxisKind) –

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)[source]

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_grid_properties()[source]

Gets the returned property set.

Return type:

Prop[ChartAxis]

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_scale_data()

Gets the scale data.

Return type:

ScaleData

get_services()

Gets service names for the instance.

Returns:

service names

Return type:

List[str]

get_sub_grid_properties()[source]

Gets the sub grid properties.

Return type:

Tuple[Prop[ChartAxis], ...]

get_sub_tick_properties()[source]

Gets the sub tick properties.

Return type:

Tuple[Prop[ChartAxis], ...]

get_title()[source]

Gets the Chart Title Component.

Raises:

ChartError – If error occurs.

Returns:

Chart Title Component.

Return type:

ChartTitle

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

scale(scale_type)[source]

Scales the axis.

Parameters:

scale_type (CurveKind) – Scale kind

Raises:

ChartError – If error occurs.

Return type:

None

Note

Supported types of scale_type are LINEAR, LOGARITHMIC, EXPONENTIAL and POWER. If scale_type is not supported then the Scaling is not set.

Hint

  • CurveKind can be imported from ooodev.utils.kind.curve_kind.

set_property(**kwargs)

Set property value

Parameters:

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

Return type:

None

set_scale_data(scale)

Sets the scale data.

Return type:

None

Parameters:

scale (com.sun.star.chart2.ScaleData) –

set_title(title)[source]

Sets Chart Title.

Parameters:

title (str) – Title text.

Raises:

ChartError – If error occurs.

Returns:

Chart Title Component.

Return type:

ChartTitle

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

Style Axis 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_axis_line is cancelled and not handled.

Returns:

Axis Line 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_axis_line_get()

Gets the axis line properties style.

Raises:

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

Returns:

Line properties style or None if cancelled.

Return type:

LinePropertiesT | None

style_axis_pos_axis_line(cross=None, value=<object object>)

Style Area Color.

Parameters:

  • cross (ChartAxisPosition, optional) – The position where the axis crosses the other axis.

  • value (float, None, optional) – The value where the axis crosses the other axis.

Raises:

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

Returns:

Axis Line instance or None if cancelled.

Return type:

AxisLineT | None

Hint

  • ChartAxisPosition can be imported from ooo.dyn.chart.chart_axis_position

style_axis_pos_interval_marks(major=None, minor=None, pos=None)

Style Area Color.

Parameters:

  • major (MarkKind, optional) – Specifies the major tickmark style.

  • minor (MarkKind, optional) – Specifies the minor tickmark style.

  • pos (ChartAxisMarkPosition, optional) – Specifies where to place the marks: at labels, at axis, or at axis and labels.

Raises:

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

Returns:

Interval Marks instance or None if cancelled.

Return type:

IntervalMarksT | None

Hint

  • MarkKind can be imported from ooodev.format.inner.direct.chart2.axis.positioning.interval_marks

  • ChartAxisMarkPosition can be imported from ooo.dyn.chart.chart_axis_mark_position

style_axis_pos_label_position(pos=ChartAxisLabelPosition.NEAR_AXIS)

Style Area Color.

Parameters:

pos (ChartAxisLabelPosition, optional) – Specifies where to place the labels: near axis, near axis (other side), outside start, or outside end. Default is ChartAxisLabelPosition.NEAR_AXIS.

Raises:

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

Returns:

Label Position instance or None if cancelled.

Return type:

LabelPositionT | None

Hint

  • ChartAxisLabelPosition can be imported from ooo.dyn.chart.chart_axis_label_position

style_axis_pos_position_axis(on_mark=True)

Style Area Color.

Parameters:

on_mark (bool, optional) – Specifies that the axis is position. If True, specifies that the axis is positioned on the first/last tickmarks. This makes the data points visual representation begin/end at the value axis. If False, specifies that the axis is positioned between the tickmarks. This makes the data points visual representation begin/end at a distance from the value axis. Default is True.

Raises:

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

Returns:

Position Axis instance or None if cancelled.

Return type:

PositionAxisT | 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_gird_line(color=0, width=0, transparency=0, style=BorderLineKind.CONTINUOUS)

Style Axis 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_gird_line is cancelled and not handled.

Returns:

Font Only instance 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_gird_line_get()

Gets the grid line style.

Raises:

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

Returns:

Grid line style or None if cancelled.

Return type:

LinePropertiesT | None

style_numbers_numbers(source_format=True, num_format=0, num_format_index=-1, lang_locale=None)

Style Numbers.

Parameters:

  • num_format (NumberFormatEnum, int, optional) – Type of a number format. Use this to select a default format. Defaults to 0 (General Format). Only used if num_format_index is -1 (omitted).

  • num_format_index (NumberFormatIndexEnum, int, optional) – Index of a number format. The enumeration values represent the built-in number formats. Defaults to -1.

  • lang_locale (Locale, optional) – Locale of the number format. Defaults to None which used current Locale.

  • source_format (bool) –

Raises:

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

Returns:

Number Style instance or None if cancelled.

Return type:

NumbersT | None

Hint

  • Locale can be imported from ooo.dyn.lang.locale

  • NumberFormatEnum can be imported from ooo.dyn.util.number_format

  • NumberFormatIndexEnum can be imported from ooo.dyn.i18n.number_format_index

style_numbers_numbers_get()

Gets the Numbers Style.

Raises:

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

Returns:

Numbers style or None if cancelled.

Return type:

NumbersT | None

style_numbers_numbers_get_from_index(idx, locale=None)

Gets the Numbers Style.

Raises:

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

Returns:

Numbers style or None if cancelled.

Return type:

NumbersT | None

Parameters:

  • idx (int) –

  • locale (Locale | None) –

style_numbers_numbers_get_from_str(nf_str, locale=None, auto_add=False, source_format=False)

Gets the Numbers Style.

Parameters:

  • nf_str (str) – Format string.

  • lang_locale (Locale, optional) – Locale. Defaults to None.

  • auto_add (bool, optional) – If True, format string will be added to document if not found. Defaults to False.

  • source_format (bool, optional) – If True, the number format will be linked to the source format. Defaults to False.

  • locale (Locale | None) –

Raises:

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

Returns:

Number style or None if cancelled.

Return type:

NumbersT | None

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 axis_kind: ChartAxisKind

Gets the axis kind.

Return type:

ChartAxisKind

property calc_doc: CalcDoc

Calc Document.

Return type:

CalcDoc

property calc_sheet: CalcSheet

Calc Sheet.

Return type:

CalcSheet

property char_auto_kerning: bool | None

Gets/Sets - This optional property determines whether the kerning tables from the current font are used.

Automatic kerning applies a spacing in between certain pairs of characters to make the text look better.

Optional

Return type:

bool | None

property char_back_color: Color | None

Get/Sets - This optional property contains the text background color.

Optional

Returns:

Color or None if not supported.

Return type:

Color | None

property char_back_transparent: bool | None

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

Optional

Return type:

bool | None

property char_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 char_bottom_border: BorderLine2StructComp | None

This property contains 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 char_bottom_border_distance: UnitMM100 | None

This property contains 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 char_case_map: int | None

Gets/Sets - This optional property contains the value of the case-mapping of the text for formatting and displaying.

optional

Return type:

int | None

property char_color: Color

This property contains the value of the text color.

Returns:

Color

Return type:

Color

property char_color_theme: int | None

Gets/Sets - If available, keeps the color theme index, so that the character can be re-colored easily based on a theme.

since

LibreOffice 7.3

optional

Return type:

int | None

property char_color_tint_or_shade: int | None

Gets/Sets the tint or shade of the character color.

since

LibreOffice 7.3

optional

Return type:

int | None

property char_combine_is_on: bool | None

Gets/Sets - This optional property determines whether text is formatted in two lines.

It is linked to the properties char_combine_prefix and char_combine_suffix.

optional

Return type:

bool | None

property char_combine_prefix: str | None

Gets/Sets - This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines.

It is linked to the properties char_combine_is_on and char_combine_suffix.

optional

Return type:

str | None

property char_combine_suffix: str | None

Gets/Sets - This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines.

It is linked to the properties CharCombineIsOn and CharCombinePrefix.

optional

Return type:

str | None

property char_contoured: bool | None

Gets/Sets - This optional property specifies if the characters are formatted and displayed with a contour effect.

optional

Return type:

bool | None

property char_crossed_out: bool | None

Gets/Sets - This property is True if the characters are crossed out.

optional

Return type:

bool | None

property char_emphasis: int | None

Gets/Sets - This optional property contains the font emphasis value.

optional

Return type:

int | None

property char_escapement: int | None

Gets/Sets the percentage by which to raise/lower superscript/subscript characters.

Negative values denote subscripts and positive values superscripts.

optional

Return type:

int | None

property char_escapement_height: int | None

Gets/Sets - This is the relative height used for subscript or superscript characters in units of percent.

The value 100 denotes the original height of the characters.

optional

Return type:

int | None

property char_flash: bool | None

Gets/Sets - If this optional property is True, then the characters are flashing.

optional

Return type:

bool | None

property char_font_char_set: int

Gets/Sets - This property contains the text encoding of the font.

Return type:

int

property char_font_family: int

Get/Sets the font family.

Return type:

int

property char_font_name: str

Gets/Sets the name of the font style.

It may contain more than one name separated by comma.

Return type:

str

property char_font_pitch: int

Gets/Sets the font pitch.

Return type:

int

property char_font_style_name: str

Gets/Sets the name of the font style.

This property may be empty.

Return type:

str

property char_font_type: int | None

Gets/Sets - This optional property specifies the fundamental technology of the font.

optional

Return type:

int | None

property char_height: UnitPT

Gets/Sets - This value contains the height of the characters in point.

When setting the value can be a float (in points) or a UnitT instance.

Return type:

UnitPT

property char_hidden: bool | None

Gets/Sets - If this optional property is True, then the characters are invisible.

optional

Return type:

bool | None

property char_highlight: Color | None

Gets/Sets the color of the highlight.

optional

Returns:

Color

Return type:

Color

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

Gets/Sets grab bag of character 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 char_keep_together: bool | None

Gets/Sets - This optional property marks a range of characters to prevent it from being broken into two lines.

A line break is applied before the range of characters if the layout makes a break necessary within the range.

optional

Return type:

bool | None

property char_kerning: int | None

Gets/Sets - This optional property contains the value of the kerning of the characters.

optional

Return type:

int | None

property char_left_border: BorderLine2StructComp | None

Gets/Sets - This property contains the left 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 char_left_border_distance: UnitMM100 | None

Gets/Sets - This property contains 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 char_locale: Locale

Gets/Sets - This property contains the value of the locale.

Return type:

Locale

property char_no_hyphenation: bool | None

Gets/Sets - This optional property determines if the word can be hyphenated at the character.

optional

Return type:

bool | None

property char_no_line_break: bool | None

Gets/Sets - This optional property marks a range of characters to ignore a line break in this area.

A line break is applied behind the range of characters if the layout makes a break necessary within the range. That means that the text may go through the border.

optional

Return type:

bool | None

property char_posture: FontSlant

Gets/Sets - This property contains the value of the posture of the document.

Returns:

Returns FontSlant

Return type:

FontSlant

Hint

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

property char_relief: int | None

Gets/Sets - This optional property contains the relief style of the characters.

optional

Return type:

int | None

property char_right_border: BorderLine2StructComp | None

Gets/Sets - This property contains 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 char_right_border_distance: UnitMM100 | None

Gets/Sets - This property contains the distance from the right 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 char_rotation: Angle10 | None

Gets/Sets - This optional property determines the rotation of a character in tenths of a degree.

Depending on the implementation only certain values may be allowed.

optional

Returns:

Returns Angle10, 1/10th degrees, or None if not supported.

Return type:

Angle10

Hint

  • Angle10 can be imported from ooodev.units

property char_rotation_is_fit_to_line: bool | None

Gets/Sets - This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height.

optional

Return type:

bool | None

property char_scale_width: int | None

Gets/Sets - This optional property determines the percentage value for scaling the width of characters.

The value refers to the original width which is denoted by 100, and it has to be greater than 0.

optional

Return type:

int | None

property char_shading_value: int | None

Gets/Sets - This optional property contains the text shading value.

optional

Return type:

int | None

property char_shadow_format: ShadowFormatStructComp | None

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

When setting the value can be an instance of ShadowFormatStructComp or ShadowFormat.

optional

Returns:

Shadow Format or None if not supported.

Return type:

ShadowFormatStructComp

Hint

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

property char_shadowed: bool | None

Gets/Sets - This optional property specifies if the characters are formatted and displayed with a shadow effect.

optional

Return type:

bool | None

property char_strikeout: FontStrikeoutEnum | None

Gets/Sets - This property determines the type of the strike out of the character.

optional

Returns:

Returns FontStrikeoutEnum or None if not supported.

Return type:

FontStrikeoutEnum | None

Hint

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

property char_style_name: str | None

Gets/Sets - This optional property specifies the name of the style of the font.

optional

Return type:

str | None

property char_style_names: Tuple[str, ...] | None

Gets/Sets - This optional property specifies the names of the all styles applied to the font.

It is not guaranteed that the order in the sequence reflects the order of the evaluation of the character style attributes.

Optional

Return type:

Tuple[str, …] | None

property char_top_border: BorderLine2StructComp | None

Gets/Sets - This property contains 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 char_top_border_distance: UnitMM100 | None

Gets/Sets - This property contains the distance from the top 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 char_transparence: int | None

Gets/Sets - This is the transparency of the character text.

The value 100 means entirely transparent, while 0 means not transparent at all.

optional

Return type:

int | None

property char_underline: FontUnderlineEnum

This property contains the value for the character underline.

Return type:

FontUnderlineEnum

property char_underline_color: Color

Gets/Sets the color of the underline for the characters.

Returns:

Color

Return type:

Color

property char_underline_has_color: bool

Gets/Sets if the property char_underline_color is used for an underline.

Return type:

bool

property char_weight: float

Gets/Sets the value of the font weight.

Example

from com.sun.star.awt import FontWeight

my_char_properties.char_weight = FontWeight.BOLD
Return type:

float

property char_word_mode: bool | None

Gets/Sets - If this property is True, the underline and strike-through properties are not applied to white spaces.

optional

Return type:

bool | None

property chart_doc: Any

Chart Document.

Return type:

ChartDoc

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

Axis Component

Return type:

Axis

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 extra_data: TheDict

Extra Data Key Value Pair Dictionary.

Properties can be assigned properties and access like a dictionary and with dot notation.

Note

This is a dictionary object that can be used to store key value pairs. Generally speaking this data is not part of the object’s main data structure and is not saved with the object (document).

This property is used to store data that is not part of the object’s main data structure and can be used however the developer sees fit.

Return type:

TheDict

Gets/Sets - This optional property contains the name of the hyperlink.

optional

Return type:

str | None

Gets/Sets - This optional property contains the name of the target for a hyperlink.

optional

Return type:

str | None

Gets/Sets - This optional property contains the URL of a hyperlink.

optional

Return type:

str | 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 lo_inst: LoInst

Lo Instance

Return type:

LoInst

property office_doc: OfficeDocumentT

Office Document.

Return type:

OfficeDocumentT

property ruby_adjust: int | None

Gets/Sets - This optional property determines the adjustment of the ruby .

optional

Return type:

int | None

property ruby_char_style_name: str | None

Gets/Sets - This optional property contains the name of the character style that is applied to RubyText.

optional

Return type:

str | None

property ruby_is_above: bool | None

Gets/Sets - This optional property determines whether the ruby text is printed above/left or below/right of the text.

This property is replaced by RubyPosition.

optional

Return type:

bool | None

property ruby_position: RubyPositionEnum | None

Gets/Sets - This optional property determines the position of the ruby .

optional

Returns:

Returns RubyPositionEnum or None if not supported.

Return type:

RubyPositionEnum | None

Hint

  • RubyPositionEnum can be imported from ooo.dyn.text.ruby_position

property ruby_text: str | None

Gets/Sets - This optional property contains the text that is set as ruby.

optional

Return type:

str | None

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

When setting the value, it can be a NameContainerComp or a XNameContainer instance.

optional

Return type:

NameContainerComp | None

property unvisited_char_style_name: str | None

Gets/Sets - This optional property contains the character style name for unvisited hyperlinks.

optional

Return type:

str | None

property visited_char_style_name: str | None

Gets/Sets - This optional property contains the character style name for visited hyperlinks.

optional

Return type:

str | None