ooodev.adapter.chart2.data_point_properties_partial module

class ooodev.adapter.chart2.data_point_properties_partial.DataPointPropertiesPartial(component)[source]

Bases: PropertySetPartial, FillPropertiesPartial

Partial class for XStyleFamiliesSupplier.

See also

API DataPointProperties

Parameters:: component (DataPointProperties) –

__init__(component)[source]

Constructor

Parameters:

component (DataPointProperties) – UNO Component that implements com.sun.star.chart2.DataPointProperties interface.
interface (UnoInterface, optional) – The interface to be validated. Defaults to DataPointProperties.

Return type:

None

property border_color: int

Gets/Sets - Is used for borders around filled objects.

See line_color.

Return type:: int

property border_dash: com.sun.star.drawing.LineDash

Gets/Sets - Is used for borders around filled objects.

See LineDash.

Return type:: LineDash

property border_dash_name: str | None

Gets/Sets the name of a dash that can be found in the com.sun.star.container.XNameContainer com.sun.star.drawing.LineDashTable, that can be created via the com.sun.star.uno.XMultiServiceFactory of the Chart Document.

optional

Return type:: str | None

property border_style: com.sun.star.drawing.LineStyle.LineStyleProto

Gets/Sets - Is used for borders around filled objects.

See LineStyle.

Return type:: LineStyleProto

property border_transparency: int | None

Gets/Sets - Is used for borders around filled objects.

See line_transparence.

optional

Return type:: int | None

property border_width: int

Gets/Sets Is used for borders around filled objects.

See line_width.

Return type:: int

property color: Color

Gets/Sets - points to a style that also supports this service (but not this property) that is used as default, if the PropertyState of a property is DEFAULT_VALUE.

This is the main color of a data point.

For charts with filled areas, like bar-charts, this should map to the fill_color of the objects. For line-charts this should map to the line_color property.

Return type:: NewType()(Color, int)

property custom_label_fields: Tuple[XDataPointCustomLabelField, ...] | None

Gets/Sets a text with possible fields that is used as a data point label, if set then Label property is ignored.

optional

Return type:: Tuple[XDataPointCustomLabelField, …] | None

property custom_label_position: RelativePosition | None

Gets/Sets - Custom position on the page associated to the CUSTOM label placement.

since

LibreOffice 7.0

optional

Return type:: RelativePosition | None

property error_bar_x: XPropertySet | None

Gets/Sets - If void, no error bars are shown for the data point in x-direction.

The com.sun.star.beans.XPropertySet must support the service ErrorBar.

optional

Return type:: XPropertySet | None

property error_bar_y: XPropertySet | None

Get/Sets - If void, no error bars are shown for the data point in y-direction.

The com.sun.star.beans.XPropertySet must support the service ErrorBar.

optional

Return type:: XPropertySet | None

property fill_background: bool

Gets/Sets - If True, fills the background of a hatch with the color given in the Color property.

Return type:: bool

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: com.sun.star.drawing.BitmapMode.BitmapModeProto

Gets/Sets - this enum selects how an area is filled with a single bitmap.

Return type:: BitmapModeProto

property fill_bitmap_name: str

Gets/Sets - The name of the fill bitmap.

Return type:: str

property fill_bitmap_offset_x: int

Gets/Sets - This is 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_offset_y: int

Gets/Sets - This is the vertical 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_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_position_offset_y: int

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

Return type:: int

property fill_bitmap_rectangle_point: com.sun.star.drawing.RectanglePoint.RectanglePointProto

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

Return type:: RectanglePointProto

property fill_bitmap_size_x: int

Gets/Sets - This is the width of the tile for filling.

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

Return type:: int

property fill_bitmap_size_y: int

Gets/Sets - This is the height of the tile for filling.

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

Return type:: int

property fill_style: com.sun.star.drawing.FillStyle.FillStyleProto

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

Return type:: FillStyleProto

property geometry3d: int | None

Gets/Sets the geometry of a 3 dimensional data point.

Number is one of constant group DataPointGeometry3D.

This is especially used for 3D bar-charts.

CUBOID==0 CYLINDER==1 CONE==2 PYRAMID==3 CUBOID==else

optional

Return type:: int | None

property gradient: Gradient | None

Gets/Sets the gradient.

optional

Return type:: Gradient | None

property gradient_name: str

Gets/Sets the name of the gradient.

Return type:: str

property hatch: Hatch | None

Gets/Sets the hatch.

optional

Return type:: Hatch | None

property hatch_name: str

Gets/Sets the name of the hatch.

Return type:: str

property label: com.sun.star.chart2.DataPointLabel

Gets/Sets the data point label.

Return type:: DataPointLabel

property label_placement: int | None

Gets/Sets a relative position for the data label.

optional

Return type:: int | None

property label_separator: str | None

Gets/Sets a string that is used to separate the parts of a data label (caption).

optional

Return type:: str | None

property line_dash: com.sun.star.drawing.LineDash

Gets/Sets - Is only used for line-chart types.

Return type:: LineDash

property line_dash_name: str | None

Gets/Sets the name of a dash that can be found in the com.sun.star.container.XNameContainer com.sun.star.drawing.LineDashTable, that can be created via the com.sun.star.uno.XMultiServiceFactory of the Chart Document.

optional

Return type:: str | None

property line_style: com.sun.star.drawing.LineStyle.LineStyleProto

Gets/Sets the line style.

Return type:: LineStyleProto

property line_width: int

Gets/Sets - Is only used for line-chart types.

Return type:: int

property number_format: int | None

Gets/Sets a number format for the display of the value in the data label.

optional

Return type:: int | None

property offset: float | None

Gets/sets a value by which a data point is moved from its default position in percent of the maximum allowed distance.

This is especially useful for the explosion of pie-chart segments.

optional

Return type:: float | None

property percent_diagonal: int | None

Gets/Seta a value between 0 and 100 indicating the percentage how round an edge should be.

optional

Return type:: int | None

property percentage_number_format: int | None

Gets/Sets a number format for the display of the percentage value in the data label.

optional

Return type:: int | None

property reference_page_size: Size | None

Gets/Sets - The size of the page at the moment when the font size for data labels was set.

This size is used to resize text in the view when the size of the page has changed since the font sizes were set (automatic text scaling).

optional

Return type:: Size | None

property show_error_box: bool | None

Gets/Sets - In case error_bar_x and error_bar_y both are set, and error bars are shown, a box spanning all error-indicators is rendered.

optional

Return type:: bool | None

property symbol: Symbol | None

Gets/Sets - This is the symbol that is used for a data point.

optional

Return type:: Symbol | None

property text_word_wrap: bool | None

Gets/Sets if the text of a data label (caption) must be wrapped

optional

Return type:: bool | None

property transparency: int

Gets/Sets - This is the main transparency value of a data point.

For charts with filled areas, like bar-charts, this should map to the FillTransparence of the objects. For line-charts this should map to the line_transparence property.

Return type:: int

property transparency_gradient: Gradient | None

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

optional

Return type:: Gradient | None

property transparency_gradient_name: str

Gets/Sets the name of the transparency gradient.

Return type:: str