Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

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

Exported Interfaces

com::sun::star::beans::XPropertySet
Description
provides information about and access to the properties from an implementation.

Properties' Summary

Max [ OPTIONAL ]
Contains the maximum value for the axis scale.
Min [ OPTIONAL ]
Contains the minimum value for the axis scale.
Origin [ OPTIONAL ]
Contains the origin of the axis scale.
StepMain [ OPTIONAL ]
Contains the distance between the main tick marks.
StepHelp [ OPTIONAL ]
Contains the distance between the help tick marks.
AutoMax [ OPTIONAL ]
The maximium value of the axis scale is calculated by the chart if this property is true .
AutoMin [ OPTIONAL ]
The minimum value of the axis scale is calculated by the chart if this property is true .
AutoOrigin [ OPTIONAL ]
The origin is calculated by the chart if this property is true .
AutoStepMain [ OPTIONAL ]
The distance between the main tick marks is calculated by the chart if this property is true .
AutoStepHelp [ OPTIONAL ]
The distance between the help tick marks is calculated by the chart if this property is true .
Logarithmic [ OPTIONAL ]
Determines if the axis is scaled logarithmically or not (linear).
DisplayLabels Determines whether to display text at the axis or not.
TextRotation Determines the rotation of the text elements (axis description) in 100th degrees.
Marks Determines the position of the marks.
HelpMarks Determines the position of the help marks.
Overlap Determines the overlap of the bars in a bar-type chart.
GapWidth Specifies the width of the gaps between each set of data points in a bar chart.
ArrangeOrder The axis description may be arranged in a special order for a better placement.
TextBreak Determines if long text is broken into multiple lines.
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 .
NumberFormat Contains the type id for the number formatter of the axis.

Properties' Details

Max
 
double Max;
[ OPTIONAL ]
Description
Contains the maximum value for the axis scale.
Min
 
double Min;
[ OPTIONAL ]
Description
Contains the minimum value for the axis scale.
Origin
 
double Origin;
[ OPTIONAL ]
Description
Contains the origin of the axis scale.
StepMain
 
double StepMain;
[ OPTIONAL ]
Description
Contains the distance between the main tick marks.
StepHelp
 
double StepHelp;
[ OPTIONAL ]
Description
Contains the distance between the help tick marks.
AutoMax
 
boolean AutoMax;
[ OPTIONAL ]
Description
The maximium value of the axis scale is calculated by the chart if this property is true .
AutoMin
 
boolean AutoMin;
[ OPTIONAL ]
Description
The minimum value of the axis scale is calculated by the chart if this property is true .
AutoOrigin
 
boolean AutoOrigin;
[ OPTIONAL ]
Description
The origin is calculated by the chart if this property is true .
AutoStepMain
 
boolean AutoStepMain;
[ OPTIONAL ]
Description
The distance between the main tick marks is calculated by the chart if this property is true .
AutoStepHelp
 
boolean AutoStepHelp;
[ OPTIONAL ]
Description
The distance between the help tick marks is calculated by the chart if this property is true .
Logarithmic
 
boolean Logarithmic;
[ OPTIONAL ]
Description
Determines if the axis is scaled logarithmically or not (linear).
DisplayLabels
 
boolean DisplayLabels;
Description
Determines whether to display text at the axis or not.
TextRotation
 
long TextRotation;
Description
Determines the rotation of the text elements (axis description) in 100th degrees.
Marks
 
long Marks;
Description
Determines the position of the marks.
See also
ChartAxisMarks
HelpMarks
 
long HelpMarks;
Description
Determines the position of the help marks.
See also
ChartAxisMarks
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%.

ArrangeOrder
 
com::sun::star::chart::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 .
NumberFormat
 
long NumberFormat;
Description
Contains the type id for the number formatter of the axis.
See also
com::sun::star::util::XNumberFormatter

Top of Page