LibreOffice LibreOffice 26.2 SDK API Reference

Included Services | Exported Interfaces | Public Attributes | List of all members
Axis Service Reference

`import"Axis.idl";`

Inheritance diagram for Axis:

## Included Services
service | ::com::sun::star::drawing::LineProperties
service | ::com::sun::star::style::CharacterProperties
service | ::com::sun::star::beans::PropertySet
service | ::com::sun::star::style::CharacterPropertiesAsian
service | ::com::sun::star::style::CharacterPropertiesComplex

## Exported Interfaces
interface | ::com::sun::star::chart2::XAxis
interface | ::com::sun::star::chart2::XTitled
Exported Interfaces inherited from PropertySet
interface | com::sun::star::beans::XPropertySet
interface | com::sun::star::beans::XFastPropertySet
interface | com::sun::star::beans::XMultiPropertySet
interface | com::sun::star::beans::XPropertyAccess
interface | com::sun::star::beans::XPropertyState

## Public Attributes
boolean | Show
| Determines, whether the axis should be rendered by the view. More...
com::sun::star::chart::ChartAxisPosition | CrossoverPosition
| Determines where the axis crosses the other axis. More...
double | CrossoverValue
| Determines the scale value on the other axis when CrossoverPosition is set to VALUE. More...
boolean | DisplayLabels
| Determines whether to display text at the axis or not. More...
com::sun::star::chart::ChartAxisLabelPosition | LabelPosition
| Determines where the axis labels are placed. More...
::com::sun::star::chart::ChartAxisArrangeOrderType | ArrangeOrder
| Determines how to stagger the labels at the axis (side by side, even, odd, auto ) More...
boolean | TextBreak
| Determines whether the labels are allowed to break into more than one line. More...
boolean | TextOverlap
| Determines whether the labels are allowed to overlap. More...
boolean | StackCharacters
| Determines whether the characters in a single labels should be stacked one upon each other. More...
double | TextRotation
| Determines the rotation of the text labels in degrees. More...
long | NumberFormat
| A NumberFormat key. More...
::com::sun::star::awt::Size | ReferencePageSize
long | MajorTickmarks
| determines what kind of tickmarks should be shown for major ticks. More...
long | MinorTickmarks
| determines what kind of tickmarks should be shown for minor ticks. More...
com::sun::star::chart::ChartAxisMarkPosition | MarkPosition
| Determines where the interval marks are placed. More...
boolean | DisplayUnits
| Determines display units are available for axis. More...
string | BuiltInUnit
| Determines built in display unit value for axis. More...
boolean | TryStaggeringFirst
| Compatibility option: determines which strategy should be tried first for fixing axis labels overlapping issues. More...
long | MajorOrigin
| This attribute specifies the shift of the first major tick from the origin. More...
Public Attributes inherited from LineProperties
com::sun::star::drawing::LineStyle | LineStyle
| This property contains the type of the line. More...
com::sun::star::drawing::LineDash | LineDash
| This property contains the dash of the line. More...
string | LineDashName
| This property contains the name of the dash of the line. More...
com::sun::star::util::Color | LineColor
| This property contains the line color. More...
short | LineTransparence
| This property contains the extent of transparency. More...
long | LineWidth
| This property contains the width of the line in 1/100th mm. More...
com::sun::star::drawing::LineJoint | LineJoint
| This property defines the rendering of joints between thick lines. More...
com::sun::star::drawing::LineCap | LineCap
| This property defines the rendering of ends of thick lines. More...
string | LineStartName
| This property contains the name of the line start poly polygon Bezier. More...
string | LineEndName
| This property contains the name of the line end poly polygon Bezier. More...
com::sun::star::drawing::PolyPolygonBezierCoords | LineStart
| This property contains the line start in the form of a poly polygon Bezier. More...
com::sun::star::drawing::PolyPolygonBezierCoords | LineEnd
| This property contains the line end in the form of a poly polygon Bezier. More...
boolean | LineStartCenter
| If this property is `TRUE`, the line will start from the center of the polygon. More...
long | LineStartWidth
| This property contains the width of the line start polygon. More...
boolean | LineEndCenter
| If this property is `TRUE`, the line will end in the center of the polygon. More...
long | LineEndWidth
| This property contains the width of the line end polygon. More...
Public Attributes inherited from CharacterProperties
string | CharFontName
| This property specifies the name of the font style. More...
string | CharFontStyleName
| This property contains the name of the font style. More...
short | CharFontFamily
| This property contains font family. More...
short | CharFontCharSet
| This property contains the text encoding of the font. More...
short | CharFontPitch
| This property contains the font pitch. More...
com::sun::star::util::Color | CharColor
| This property contains the value of the text color. More...
short | CharEscapement
| specifies the percentage by which to raise/lower superscript/subscript characters. More...
float | CharHeight
| This value contains the height of the characters in point. More...
short | CharUnderline
| This property contains the value for the character underline. More...
float | CharWeight
| This property contains the value of the font weight. More...
com::sun::star::awt::FontSlant | CharPosture
| This property contains the value of the posture of the document. More...
boolean | CharAutoKerning
| This optional property determines whether the kerning tables from the current font are used. More...
com::sun::star::util::Color | CharBackColor
| This optional property contains the text background color. More...
long | CharShadingValue
| This optional property contains the text shading value. More...
boolean | CharBackTransparent
| This property determines if the text background color is set to transparent. More...
short | CharCaseMap
| This optional property contains the value of the case-mapping of the text for formatting and displaying. More...
boolean | CharCrossedOut
| This property is `TRUE` if the characters are crossed out. More...
boolean | CharFlash
| If this optional property is `TRUE`, then the characters are flashing. More...
short | CharStrikeout
| This property determines the type of the strike out of the character. More...
boolean | CharWordMode
| If this property is `TRUE`, the underline and strike-through properties are not applied to white spaces. More...
short | CharKerning
| This optional property contains the value of the kerning of the characters. More...
com::sun::star::lang::Locale | CharLocale
| This property contains the value of the locale. More...
boolean | CharKeepTogether
| This optional property marks a range of characters to prevent it from being broken into two lines. More...
boolean | CharNoLineBreak
| This optional property marks a range of characters to ignore a line break in this area. More...
boolean | CharShadowed
| This optional property specifies if the characters are formatted and displayed with a shadow effect. More...
short | CharFontType
| This optional property specifies the fundamental technology of the font. More...
string | CharStyleName
| This optional property specifies the name of the applied character style. More...
boolean | CharContoured
| This optional property specifies if the characters are formatted and displayed with a contour effect. More...
boolean | CharCombineIsOn
| This optional property determines whether text is formatted in two lines. More...
string | CharCombinePrefix
| This optional property contains the prefix (usually parenthesis) before text that is formatted in two lines. More...
string | CharCombineSuffix
| This optional property contains the suffix (usually parenthesis) after text that is formatted in two lines. More...
short | CharEmphasis
| This optional property contains the font emphasis value. More...
short | CharRelief
| This optional property contains the relief style of the characters. More...
string | RubyText
| This optional property contains the text that is set as ruby. More...
short | RubyAdjust
| This optional property determines the adjustment of the ruby . More...
string | RubyCharStyleName
| This optional property contains the name of the character style that is applied to RubyText. More...
boolean | RubyIsAbove
| This optional property determines whether the ruby text is printed above/left or below/right of the text. More...
short | CharRotation
| This optional property determines the rotation of a character in tenths of a degree. More...
boolean | CharRotationIsFitToLine
| This optional property determines whether the text formatting tries to fit rotated text into the surrounded line height. More...
short | CharScaleWidth
| This optional property determines the percentage value for scaling the width of characters. More...
string | HyperLinkURL
| This optional property contains the URL of a hyperlink. More...
string | HyperLinkTarget
| This optional property contains the name of the target for a hyperlink. More...
string | HyperLinkName
| This optional property contains the name of the hyperlink. More...
string | VisitedCharStyleName
| This optional property contains the character style name for visited hyperlinks. More...
string | UnvisitedCharStyleName
| This optional property contains the character style name for unvisited hyperlinks. More...
byte | CharEscapementHeight
| This is the relative height used for subscript or superscript characters in units of percent. More...
boolean | CharNoHyphenation
| This optional property determines if the word can be hyphenated at the character by automatic hyphenation. More...
com::sun::star::util::Color | CharUnderlineColor
| This property contains the color of the underline for the characters. More...
boolean | CharUnderlineHasColor
| This property specifies if the property CharUnderlineColor is used for an underline. More...
boolean | CharHidden
| If this optional property is `TRUE`, then the characters are invisible. More...
com::sun::star::container::XNameContainer | TextUserDefinedAttributes
| This property stores XML attributes. More...
com::sun::star::table::BorderLine2 | CharLeftBorder
| This property contains the left border of the object. More...
com::sun::star::table::BorderLine2 | CharRightBorder
| This property contains the right border of the object. More...
com::sun::star::table::BorderLine2 | CharTopBorder
| This property contains the top border of the object. More...
com::sun::star::table::BorderLine2 | CharBottomBorder
| This property contains the bottom border of the object. More...
long | CharBorderDistance
| This property contains the distance from the border to the object. More...
long | CharLeftBorderDistance
| This property contains the distance from the left border to the object. More...
long | CharRightBorderDistance
| This property contains the distance from the right border to the object. More...
long | CharTopBorderDistance
| This property contains the distance from the top border to the object. More...
long | CharBottomBorderDistance
| This property contains the distance from the bottom border to the object. More...
com::sun::star::table::ShadowFormat | CharShadowFormat
| Determines the type, color, and width of the shadow. More...
com::sun::star::util::Color | CharHighlight
| Determines the color of the highlight. More...
short | RubyPosition
| This optional property determines the position of the ruby . More...
short | CharTransparence
| This is the transparency of the character text. More...
short | CharColorTheme
| If available, keeps the color theme index, so that the character can be re-colored easily based on a theme. More...
short | CharColorTintOrShade
| Tint or shade of the character color. More...
short | CharScriptHint
| This optional property suggests that the text should be interpreted as a specific script type. More...

## Additional Inherited Members
Public Types inherited from CharacterProperties
typedef sequence< string > | CharStyleNames
| This optional property specifies the names of the all styles applied to the font. More...
typedef sequence< com::sun::star::beans::PropertyValue > | CharInteropGrabBag
| Grab bag of character properties, used as a string-any map for interim interop purposes. More...
Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value of the property with the specified name. More...
any | getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
void | addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XPropertyChangeListener to the specified property. More...
void | removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XPropertyChangeListener from the listener list. More...
void | addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
void | removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
| removes an XVetoableChangeListener from the listener list. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...
Public Member Functions inherited from XAxis
void | setScaleData ([in] ScaleData aScale)
ScaleData | getScaleData ()
com::sun::star::beans::XPropertySet | getGridProperties ()
| the returned property set must support the service GridProperties More...
sequence< com::sun::star::beans::XPropertySet > | getSubGridProperties ()
| the returned property sets must support the service GridProperties More...
sequence< com::sun::star::beans::XPropertySet > | getSubTickProperties ()
| the returned property sets must support the service TickProperties More...
Protected Member Functions inherited from XFastPropertySet
void | setFastPropertyValue ([in] long nHandle, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the value to the property with the specified name. More...
any | getFastPropertyValue ([in] long nHandle) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
Protected Member Functions inherited from XMultiPropertySet
com::sun::star::beans::XPropertySetInfo | getPropertySetInfo ()
void | setPropertyValues ([in] sequence< string > aPropertyNames, [in] sequence< any > aValues) raises ( com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the values to the properties with the specified names. More...
sequence< any > | getPropertyValues ([in] sequence< string > aPropertyNames)
void | addPropertiesChangeListener ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
| adds an XPropertiesChangeListener to the specified property with the specified names. More...
void | removePropertiesChangeListener ([in] com::sun::star::beans::XPropertiesChangeListener xListener)
| removes an XPropertiesChangeListener from the listener list. More...
void | firePropertiesChangeEvent ([in] sequence< string > aPropertyNames, [in] com::sun::star::beans::XPropertiesChangeListener xListener)
| fires a sequence of PropertyChangeEvents to the specified listener. More...
Protected Member Functions inherited from XPropertyAccess
sequence< com::sun::star::beans::PropertyValue > | getPropertyValues ()
void | setPropertyValues ([in] sequence< com::sun::star::beans::PropertyValue > aProps) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
| sets the values of given properties. More...
Protected Member Functions inherited from XPropertyState
com::sun::star::beans::PropertyState | getPropertyState ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
sequence< com::sun::star::beans::PropertyState > | getPropertyStates ([in] sequence< string > aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
void | setPropertyToDefault ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException )
| Sets the property to default value. More...
any | getPropertyDefault ([in] string aPropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
Protected Member Functions inherited from XAxis
void | setScaleData ([in] ScaleData aScale)
ScaleData | getScaleData ()
com::sun::star::beans::XPropertySet | getGridProperties ()
| the returned property set must support the service GridProperties More...
sequence< com::sun::star::beans::XPropertySet > | getSubGridProperties ()
| the returned property sets must support the service GridProperties More...
sequence< com::sun::star::beans::XPropertySet > | getSubTickProperties ()
| the returned property sets must support the service TickProperties More...
Protected Member Functions inherited from XTitled
XTitle | getTitleObject ()
| get the object holding the title's content and formatting More...
void | setTitleObject ([in] XTitle Title)
| set a new title object replacing the former one More...
Protected Attributes inherited from CharacterPropertiesAsian
float | CharHeightAsian
| This value contains the height of the characters in point. More...
float | CharWeightAsian
| This property contains the value of the font weight. More...
string | CharFontNameAsian
| This property specifies the name of the font style. More...
string | CharFontStyleNameAsian
| This property contains the name of the font style. More...
short | CharFontFamilyAsian
| This property contains font family as specified in com.sun.star.awt.FontFamily . More...
short | CharFontCharSetAsian
| This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
short | CharFontPitchAsian
| This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
com::sun::star::awt::FontSlant | CharPostureAsian
| This property contains the value of the posture of the document. More...
com::sun::star::lang::Locale | CharLocaleAsian
| contains the value of the locale. More...
Protected Attributes inherited from CharacterPropertiesComplex
float | CharHeightComplex
| This value contains the height of the characters in point. More...
float | CharWeightComplex
| This property contains the value of the font weight. More...
string | CharFontNameComplex
| This property specifies the name of the font style. More...
string | CharFontStyleNameComplex
| This property contains the name of the font style. More...
short | CharFontFamilyComplex
| This property contains font family as specified in com.sun.star.awt.FontFamily . More...
short | CharFontCharSetComplex
| This property contains the text encoding of the font as specified in com.sun.star.awt.CharSet. More...
short | CharFontPitchComplex
| This property contains the font pitch as specified in com.sun.star.awt.FontPitch. More...
com::sun::star::awt::FontSlant | CharPostureComplex
| This property contains the value of the posture of the document. More...
com::sun::star::lang::Locale | CharLocaleComplex
| contains the value of the locale. More...

## Exported Interfaces

## ◆ ::com::sun::star::beans::PropertySet

service ::com::sun::star::beans::PropertySet

## ◆ ::com::sun::star::drawing::LineProperties

service ::com::sun::star::drawing::LineProperties

## ◆ ::com::sun::star::style::CharacterProperties

service ::com::sun::star::style::CharacterProperties

## ◆ ::com::sun::star::style::CharacterPropertiesAsian

service ::com::sun::star::style::CharacterPropertiesAsian
| optional

## ◆ ::com::sun::star::style::CharacterPropertiesComplex

service ::com::sun::star::style::CharacterPropertiesComplex
| optional

## Exported Interfaces

## ◆ ::com::sun::star::chart2::XAxis

interface ::com::sun::star::chart2::XAxis

## ◆ ::com::sun::star::chart2::XTitled

interface ::com::sun::star::chart2::XTitled
| optional

## Member Data Documentation

## ◆ ArrangeOrder

::com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder
| property

Determines how to stagger the labels at the axis (side by side, even, odd, auto )

## ◆ BuiltInUnit

string BuiltInUnit
| optional property

Determines built in display unit value for axis.

Since
  LibreOffice 4.3

## ◆ CrossoverPosition

com::sun::star::chart::ChartAxisPosition CrossoverPosition
| optional property

Determines where the axis crosses the other axis.

## ◆ CrossoverValue

double CrossoverValue
| optional property

Determines the scale value on the other axis when CrossoverPosition is set to VALUE.

## ◆ DisplayLabels

boolean DisplayLabels
| property

Determines whether to display text at the axis or not.

## ◆ DisplayUnits

boolean DisplayUnits
| optional property

Determines display units are available for axis.

Since
  LibreOffice 4.3

## ◆ LabelPosition

com::sun::star::chart::ChartAxisLabelPosition LabelPosition
| optional property

Determines where the axis labels are placed.

## ◆ MajorOrigin

long MajorOrigin
| optional property

This attribute specifies the shift of the first major tick from the origin.

Since
  LibreOffice 7.0

## ◆ MajorTickmarks

long MajorTickmarks
| property

determines what kind of tickmarks should be shown for major ticks.

See also
  TickmarkStyle.

## ◆ MarkPosition

com::sun::star::chart::ChartAxisMarkPosition MarkPosition
| optional property

Determines where the interval marks are placed.

## ◆ MinorTickmarks

long MinorTickmarks
| property

determines what kind of tickmarks should be shown for minor ticks.

See also
  TickmarkStyle.

## ◆ NumberFormat

long NumberFormat
| property maybevoid

A NumberFormat key.

If this property is not set, it is treated as auto. This means linked to the source format.

To determine a source format, the axis can query the XDataSequences used by the data series attached to it (see XDataSequence::getNumberFormatKeyByIndex()).

## ◆ ReferencePageSize

::com::sun::star::awt::Size ReferencePageSize
| property

## ◆ Show

boolean Show
| property

Determines, whether the axis should be rendered by the view.

## ◆ StackCharacters

boolean StackCharacters
| property

Determines whether the characters in a single labels should be stacked one upon each other.

## ◆ TextBreak

boolean TextBreak
| property

Determines whether the labels are allowed to break into more than one line.

## ◆ TextOverlap

boolean TextOverlap
| property

Determines whether the labels are allowed to overlap.

## ◆ TextRotation

double TextRotation
| property

Determines the rotation of the text labels in degrees.

## ◆ TryStaggeringFirst

boolean TryStaggeringFirst
| optional property

Compatibility option: determines which strategy should be tried first for fixing axis labels overlapping issues.

Since
  LibreOffice 5.1

The documentation for this service was generated from the following file:

- com/sun/star/chart2/Axis.idl