LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
ChartAxis Service Referencepublished

Specifies the axes in a diagram. More...

import"ChartAxis.idl";

Inheritance diagram for ChartAxis:
LineProperties CharacterProperties UserDefinedAttributesSupplier XAxis XPropertySet XInterface XInterface

Included Services

service com::sun::star::drawing::LineProperties
 set the properties for the entire axis line as well as for the tick marks. More...
 
service com::sun::star::style::CharacterProperties
 set the properties for all text labels of the axis More...
 
service com::sun::star::xml::UserDefinedAttributesSupplier
 If a ChartAxis may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes. More...
 

Exported Interfaces

interface com::sun::star::chart::XAxis
 Access to the sub elements of an axis like title and grids. More...
 
interface com::sun::star::beans::XPropertySet
 

Public Attributes

double Max
 Properties for scaling: More...
 
double Min
 Contains the minimum value for the axis scale. More...
 
double StepMain
 Contains the distance between the main tick marks. More...
 
long StepHelpCount
 Contains the number of help intervals within a main interval. More...
 
double StepHelp
 
boolean AutoMax
 The maximum value of the axis scale is calculated by the chart if this property is TRUE. More...
 
boolean AutoMin
 The minimum value of the axis scale is calculated by the chart if this property is TRUE. More...
 
boolean AutoStepMain
 The distance between the main tick marks is calculated by the chart if this property is TRUE. More...
 
boolean AutoStepHelp
 The number of help intervals within a main interval is calculated by the chart if this property is TRUE. More...
 
boolean Logarithmic
 Determines if the axis is scaled logarithmically or not (linear). More...
 
long AxisType
 determines which type of axis this is, e.g. More...
 
TimeIncrement TimeIncrement
 if the current axis is a date-axis the intervals are chosen as given with TimeIncrement More...
 
boolean ReverseDirection
 Determines if the axis orientation is mathematical or reversed. 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...
 
double Origin
 Indicates the reference value where bars or areas have their grounding. More...
 
boolean AutoOrigin
 The origin is calculated by the chart if this property is TRUE. More...
 
long Marks
 Properties for interval marks: More...
 
long HelpMarks
 Determines the type of the help marks. More...
 
com::sun::star::chart::ChartAxisMarkPosition MarkPosition
 Determines where the interval marks are placed. More...
 
boolean DisplayLabels
 Properties for axes labels: More...
 
long NumberFormat
 Contains the type id for the number formatter of the axis. More...
 
boolean LinkNumberFormatToSource
 determines whether to use the number format given by the container application, e.g. More...
 
com::sun::star::chart::ChartAxisLabelPosition LabelPosition
 Determines where the axis labels are placed. More...
 
long TextRotation
 Determines the rotation of the text elements (axis description) in 100th degrees. More...
 
com::sun::star::chart::ChartAxisArrangeOrderType ArrangeOrder
 The axis description may be arranged in a special order for a better placement. More...
 
boolean TextBreak
 Determines if long text is broken into multiple lines. More...
 
boolean TextCanOverlap
 Determines if certain labels are hidden, if they would otherwise overlap. More...
 
long Overlap
 Properties related to bar charts: More...
 
long GapWidth
 Specifies the width of the gaps between each set of data points in a bar chart. 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 style of the font. 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. 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...
 
sequence< string > CharStyleNames
 This optional property specifies the names of the all styles applied to the font. 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...
 
sequence< com::sun::star::beans::PropertyValueCharInteropGrabBag
 Grab bag of character properties, used as a string-any map for interim interop purposes. More...
 
short RubyPosition
 This optional property determines the position of the ruby . More...
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from XAxis
com::sun::star::beans::XPropertySet getAxisTitle ()
 
com::sun::star::beans::XPropertySet getMajorGrid ()
 
com::sun::star::beans::XPropertySet getMinorGrid ()
 
- Protected 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...
 
- Protected 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...
 
- Protected Attributes inherited from UserDefinedAttributesSupplier
::com::sun::star::container::XNameContainer UserDefinedAttributes
 This container holds the AttributeData elements that represent uninterpreted XML attributes. More...
 

Detailed Description

Specifies the axes in a diagram.

Note: The text properties correlate to all axis description elements, not to just a single text element.

Exported Interfaces

set the properties for the entire axis line as well as for the tick marks.

set the properties for all text labels of the axis

If a ChartAxis may be stored as XML element, this service should be supported in order to preserve unparsed XML attributes.

Since
OOo 1.1.2

Exported Interfaces

interface com::sun::star::chart::XAxis
optional

Access to the sub elements of an axis like title and grids.

Since
OOo 3.4

Member Data Documentation

The axis description may be arranged in a special order for a better placement.

boolean AutoMax
optionalproperty

The maximum value of the axis scale is calculated by the chart if this property is TRUE.

boolean AutoMin
optionalproperty

The minimum value of the axis scale is calculated by the chart if this property is TRUE.

boolean AutoOrigin
optionalproperty

The origin is calculated by the chart if this property is TRUE.

boolean AutoStepHelp
optionalproperty

The number of help intervals within a main interval is calculated by the chart if this property is TRUE.

boolean AutoStepMain
optionalproperty

The distance between the main tick marks is calculated by the chart if this property is TRUE.

long AxisType
optionalproperty

determines which type of axis this is, e.g.

a date-axis or a category-axis

See also
ChartAxisType
Since
OOo 3.4
com::sun::star::chart::ChartAxisPosition CrossoverPosition
optionalproperty

Determines where the axis crosses the other axis.

double CrossoverValue
optionalproperty

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

boolean DisplayLabels
property

Properties for axes labels:

Determines whether to display text at the axis or not.

long GapWidth
property

Specifies the width of the gaps between each set of data points in a bar chart.

The value is given in percent of the width of a bar; the valid range is 0 to 600%.

long HelpMarks
property

Determines the type of the help marks.

See also
ChartAxisMarks
com::sun::star::chart::ChartAxisLabelPosition LabelPosition
optionalproperty

Determines where the axis labels are placed.

boolean LinkNumberFormatToSource
optionalproperty

determines whether to use the number format given by the container application, e.g.

a spreadsheet document, or from the own property NumberFormat.

boolean Logarithmic
optionalproperty

Determines if the axis is scaled logarithmically or not (linear).

com::sun::star::chart::ChartAxisMarkPosition MarkPosition
optionalproperty

Determines where the interval marks are placed.

long Marks
property

Properties for interval marks:

Determines the type of the marks.

See also
ChartAxisMarks
double Max
optionalproperty

Properties for scaling:

Contains the maximum value for the axis scale.

double Min
optionalproperty

Contains the minimum value for the axis scale.

long NumberFormat
property

Contains the type id for the number formatter of the axis.

See also
com::sun::star::util::XNumberFormatter
double Origin
optionalproperty

Indicates the reference value where bars or areas have their grounding.

This property has only an effect when the used ODF file format does not allow for further axis positioning or the axis is a secondary y-axis.

long Overlap
property

Properties related to bar charts:

Determines the overlap of the bars in a bar-type chart.

The value is given in percent of the width of the bars. The valid range is -100% to +100%. +100% means full overlap, -100% indicates a distance of one bar between 2 neighboring bars.

boolean ReverseDirection
optionalproperty

Determines if the axis orientation is mathematical or reversed.

double StepHelp
optionalproperty
Deprecated:
User property StepHelpCount instead Contains the distance between the help tick marks.
long StepHelpCount
optionalproperty

Contains the number of help intervals within a main interval.

E.g. a StepHelpCount of 5 divides the main interval into 5 pieces and thus produces 4 help tick marks.

double StepMain
optionalproperty

Contains the distance between the main tick marks.

boolean TextBreak
property

Determines if long text is broken into multiple lines.

boolean TextCanOverlap
property

Determines if certain labels are hidden, if they would otherwise overlap.

In this case, the value of this property must be set to FALSE.

long TextRotation
property

Determines the rotation of the text elements (axis description) in 100th degrees.

TimeIncrement TimeIncrement
optionalpropertymaybevoid

if the current axis is a date-axis the intervals are chosen as given with TimeIncrement

Since
OOo 3.4

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