Class ChartErrorBar

class ooodev.calc.chart2.chart_error_bar.ChartErrorBar(chart_doc, lo_inst=None, component=None)

Bases: LoInstPropsPartial, ErrorBarComp, ChartDocPropPartial, DataSinkPartial, PropPartial, QiPartial, ServicePartial, TheDictionaryPartial, CalcDocPropPartial, CalcSheetPropPartial

Class for managing Chart2 ErrorBar.

Parameters:

• chart_doc (ChartDoc) –

• lo_inst (LoInst | None) –

• component (XPropertySet | None) –

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

Constructor

Parameters:

• lo_inst (mLo.LoInst) – Lo Instance. This instance is used to create component is it is not provided.

• component (XPropertySet, optional) – UNO Chart2 ErrorBar Component. Defaults to None.

• chart_doc (ChartDoc) –

Return type:

None

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

add_property_change_listener(name, listener)

Adds a listener for property changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be added.

Return type:

None

add_vetoable_change_listener(name, listener)

Adds a listener for vetoable changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be added.

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

Returns the property set info.

Returns:

The property set info.

Return type:

XPropertySetInfo

get_property_value(name)

Returns the value of a property.

Parameters:

name (str) – The name of the property.

Returns:

The value of the property.

Return type:

Any

get_services()

Gets service names for the instance.

Returns:

service names

Return type:

List[str]

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

remove_property_change_listener(name, listener)

Removes a listener for property changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be removed.

Return type:

None

remove_vetoable_change_listener(name, listener)

Removes a listener for vetoable changes.

Parameters:

• name (str) – The name of the property.

• listener (Any) – The listener to be removed.

Return type:

None

set_data(data)

Sets new data sequences.

The elements set here must support the service DataSequence.

If the data consist only of floating point numbers (double values), the instances set here should also support the service NumericalDataSequence.

If the data consist only of strings, the instances set here should also support the service TextualDataSequence.

If one of the derived services is supported by one element of the sequence, it should be available for all elements in the sequence.

Return type:

None

Parameters:

data (Tuple[com.sun.star.chart2.data.XLabeledDataSequence, ...]) –

set_property(**kwargs)

Set property value

Parameters:

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

Return type:

None

set_property_value(name, value)

Sets the value of a property.

Parameters:

• name (str) – The name of the property.

• value (Any) – The value of the property.

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

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

ErrorBar Component

Return type:

ErrorBar

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

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