Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: chart ::

service ChartAxis
Description
Specifies the axes in a diagram.

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


Included Services - Summary
::com::sun::star::drawing::LineProperties

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

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

set the properties for all text labels of the axis

::com::sun::star::xml::UserDefinedAttributeSupplier

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

Exported Interfaces - Summary
XAxis

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

::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Summary
double
Max
[ OPTIONAL ]
Contains the maximum value for the axis scale.  
double
Min
[ OPTIONAL ]
Contains the minimum value for the axis scale.  
double
StepMain
[ OPTIONAL ]
Contains the distance between the main tick marks.  
long
StepHelpCount
[ OPTIONAL ]
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 producces 4 help tick marks.  
double
StepHelp
[ DEPRECATED ]
[ OPTIONAL ]
 
boolean
AutoMax
[ OPTIONAL ]
The maximium value of the axis scale is calculated by the chart if this property is true.  
boolean
AutoMin
[ OPTIONAL ]
The minimum value of the axis scale is calculated by the chart if this property is true.  
boolean
AutoStepMain
[ OPTIONAL ]
The distance between the main tick marks is calculated by the chart if this property is true.  
boolean
AutoStepHelp
[ OPTIONAL ]
The number of help intervals within a main interval is calculated by the chart if this property is true.  
boolean
Logarithmic
[ OPTIONAL ]
Determines if the axis is scaled logarithmically or not (linear).  
long
AxisType
[ OPTIONAL ]
determines which type of axis this is, e.g. a date-axis or a category-axis  
[ maybevoid ] TimeIncrement
TimeIncrement
[ OPTIONAL ]
if the current axis is a date-axis the intervals are choosen as given with TimeIncrement  
boolean
ReverseDirection
[ OPTIONAL ]
Determines if the axis orientation is mathematical or reversed.  
ChartAxisPosition
CrossoverPosition
[ OPTIONAL ]
Determines where the axis crosses the other axis.  
double
CrossoverValue
[ OPTIONAL ]
Determines the scale value on the other axis when CrossoverPosition is set to VALUE.  
double
Origin
[ OPTIONAL ]
Indicates the reference value where bars or areas have their grounding. This property has only an effect when the used odf fileformat does not allow for further axis posiioning or the axis is a secondary y-axis.  
boolean
AutoOrigin
[ OPTIONAL ]
The origin is calculated by the chart if this property is true.  
long
Marks
Determines the type of the marks. 
long
HelpMarks
Determines the type of the help marks. 
ChartAxisMarkPosition
MarkPosition
[ OPTIONAL ]
Determines where the interval marks are placed.  
boolean
DisplayLabels
Determines whether to display text at the axis or not.  
long
NumberFormat
Contains the type id for the number formatter of the axis.  
boolean
LinkNumberFormatToSource
[ OPTIONAL ]
determines whether to use the number format given by the container application, e.g. a spreadsheet document, or from the own property NumberFormat.  
ChartAxisLabelPosition
LabelPosition
[ OPTIONAL ]
Determines where the axis labels are placed.  
long
TextRotation
Determines the rotation of the text elements (axis description) in 100th degrees.  
ChartAxisArrangeOrderType
ArrangeOrder
The axis description may be arranged in a special order for a better placement.  
boolean
TextBreak
Determines if long text is broken into multiple lines.  
boolean
TextCanOverlap
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
Overlap
Determines the overlap of the bars in a bar-type chart.  
long
GapWidth
Specifies the width of the gaps between each set of data points in a bar chart.  
Included Services - Details
::com::sun::star::drawing::LineProperties
Description
set the properties for the entire axis line as well as for the tick marks.
::com::sun::star::style::CharacterProperties
Description
set the properties for all text labels of the axis
::com::sun::star::xml::UserDefinedAttributeSupplier
Usage Restrictions
optional
Description
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 - Details
XAxis
Usage Restrictions
optional
Description
Access to the sub elements of an axis like title and grids.
Since
OOo 3.4
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Details
Max
double Max;
Usage Restrictions
optional
Description
Contains the maximum value for the axis scale.
Min
double Min;
Usage Restrictions
optional
Description
Contains the minimum value for the axis scale.
StepMain
double StepMain;
Usage Restrictions
optional
Description
Contains the distance between the main tick marks.
StepHelpCount
long StepHelpCount;
Usage Restrictions
optional
Description
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 producces 4 help tick marks.
StepHelp
double StepHelp;
Usage Restrictions
deprecated
optional
Deprecation Info
User property StepHelpCount instead Contains the distance between the help tick marks.
AutoMax
boolean AutoMax;
Usage Restrictions
optional
Description
The maximium value of the axis scale is calculated by the chart if this property is true.
AutoMin
boolean AutoMin;
Usage Restrictions
optional
Description
The minimum value of the axis scale is calculated by the chart if this property is true.
AutoStepMain
boolean AutoStepMain;
Usage Restrictions
optional
Description
The distance between the main tick marks is calculated by the chart if this property is true.
AutoStepHelp
boolean AutoStepHelp;
Usage Restrictions
optional
Description
The number of help intervals within a main interval is calculated by the chart if this property is true.
Logarithmic
boolean Logarithmic;
Usage Restrictions
optional
Description
Determines if the axis is scaled logarithmically or not (linear).
AxisType
long AxisType;
Usage Restrictions
optional
Description
determines which type of axis this is, e.g. a date-axis or a category-axis
Since
OOo 3.4
See also
ChartAxisType
TimeIncrement
[ maybevoid ] TimeIncrement TimeIncrement;
Usage Restrictions
optional
Description
if the current axis is a date-axis the intervals are choosen as given with TimeIncrement
Since
OOo 3.4
ReverseDirection
boolean ReverseDirection;
Usage Restrictions
optional
Description
Determines if the axis orientation is mathematical or reversed.
CrossoverPosition
ChartAxisPosition CrossoverPosition;
Usage Restrictions
optional
Description
Determines where the axis crosses the other axis.
CrossoverValue
double CrossoverValue;
Usage Restrictions
optional
Description
Determines the scale value on the other axis when CrossoverPosition is set to VALUE.
Origin
double Origin;
Usage Restrictions
optional
Description
Indicates the reference value where bars or areas have their grounding. This property has only an effect when the used odf fileformat does not allow for further axis posiioning or the axis is a secondary y-axis.
AutoOrigin
boolean AutoOrigin;
Usage Restrictions
optional
Description
The origin is calculated by the chart if this property is true.
Marks
long Marks;
Description
Determines the type of the marks.
See also
ChartAxisMarks
HelpMarks
long HelpMarks;
Description
Determines the type of the help marks.
See also
ChartAxisMarks
MarkPosition
ChartAxisMarkPosition MarkPosition;
Usage Restrictions
optional
Description
Determines where the interval marks are placed.
DisplayLabels
boolean DisplayLabels;
Description
Determines whether to display text at the axis or not.
NumberFormat
long NumberFormat;
Description
Contains the type id for the number formatter of the axis.
See also
::com::sun::star::util::XNumberFormatter
LinkNumberFormatToSource
boolean LinkNumberFormatToSource;
Usage Restrictions
optional
Description
determines whether to use the number format given by the container application, e.g. a spreadsheet document, or from the own property NumberFormat.
LabelPosition
ChartAxisLabelPosition LabelPosition;
Usage Restrictions
optional
Description
Determines where the axis labels are placed.
TextRotation
long TextRotation;
Description
Determines the rotation of the text elements (axis description) in 100th degrees.
ArrangeOrder
ChartAxisArrangeOrderType ArrangeOrder;
Description
The axis description may be arranged in a special order for a better placement.
TextBreak
boolean TextBreak;
Description
Determines if long text is broken into multiple lines.
TextCanOverlap
boolean TextCanOverlap;
Description
Determines if certain labels are hidden, if they would otherwise overlap. In this case, the value of this property must be set to false.
Overlap
long Overlap;
Description
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.

GapWidth
long GapWidth;
Description
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%.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.