ooodev.adapter.chart2.coordinate_system_partial module
- class ooodev.adapter.chart2.coordinate_system_partial.CoordinateSystemPartial(component, interface=com.sun.star.chart2.XCoordinateSystem)[source]
Bases:
object
Partial class for XCoordinateSystem.
- Parameters:
component (XCoordinateSystem) –
interface (UnoInterface | None) –
- __init__(component, interface=com.sun.star.chart2.XCoordinateSystem)[source]
Constructor
- Parameters:
component (XCoordinateSystem) – UNO Component that implements
com.sun.star.chart2.XCoordinateSystem
interface.interface (UnoInterface, optional) – The interface to be validated. Defaults to
XCoordinateSystem
.
- Return type:
None
- get_axis_by_dimension(dimension, idx)[source]
The dimension says whether it is a x, y or z axis.
The index indicates whether it is a primary or a secondary axis or maybe more in future. Use nIndex == 0 for a primary axis. An empty Reference will be returned if the given nDimension and nIndex are in the valid range but no axis is set for those values. An IndexOutOfBoundsException will be thrown if nDimension is lower than 0 or greater than the value returned by getDimension() and/or if nIndex is lower 0 or greater than the value returned by getMaxAxisIndexByDimension(nDimension).
- Raises:
com.sun.star.lang.IndexOutOfBoundsException –
IndexOutOfBoundsException
- Return type:
XAxis
- Parameters:
dimension (int) –
idx (int) –
- get_coordinate_system_type()[source]
Gets the type of coordinate system (e.g.Cartesian, polar …)
- Return type:
str
- get_maximum_axis_index_by_dimension(dimension)[source]
In one dimension there could be several axes to enable main and secondary axis and maybe more in future.
This method returns the maximum index at which an axis exists for the given dimension. It is allowed that some indexes in between do not have an axis.
- Raises:
com.sun.star.lang.IndexOutOfBoundsException –
IndexOutOfBoundsException
- Return type:
int
- Parameters:
dimension (int) –
- get_view_service_name()[source]
return a service name from which the view component for this coordinate system can be created
- Return type:
str
- set_axis_by_dimension(dimension, axis, idx)[source]
The dimension says whether it is a x, y or z axis.
The index says whether it is a primary or a secondary axis. Use nIndex == 0 for a primary axis.
- Raises:
com.sun.star.lang.IndexOutOfBoundsException –
IndexOutOfBoundsException
- Return type:
None
- Parameters:
dimension (int) –
axis (com.sun.star.chart2.XAxis) –
idx (int) –