jsx3.chart.CategoryAxisAPI
| Object |
|---|
| Object Type | The JSX foundation class that this object is an instance of. |
| ID | The unique, system-assigned ID for this object. |
| Name | Sets the name assigned by the developer to identify this object. |
| Axis |
|---|
| Orientation | Sets whether the axis is horizontal or vertical. |
| Width | Sets the amount of space in pixels that the axis ticks, labels, and title occupy. |
| Tick |
|---|
| Show Axis | Sets whether to show a line along the axis. |
| Axis Stroke | Sets the vector stroke to use for drawing the line along the axis. |
| Mj Tick Length | Sets the length of major ticks. |
| Mj Tick Stroke | Sets the vector stroke to use for drawing major ticks. |
| Mj Tick Placement | Sets the placement of major ticks. |
| Mn Tick Length | Sets the length of minor ticks. |
| Mn Tick Stroke | Sets the vector stroke to use for drawing minor ticks. |
| Mn Tick Placement | Sets the placement of minor ticks. |
| Mn Tick Divisions | Sets the number of minor tick divisions between major ticks. |
| Label |
|---|
| Show Labels | Sets whether to show data labels along the axis. |
| Label Gap | Sets the gap between tick marks and labels in pixels. |
| Label Placement | Sets the placement of axis labels with respect to the axis. |
| Label Function | A function that formats the labels to be displayed next to major ticks with signature function(value) : String. |
| Label CSS Class | Sets the jsxname of a CSS class to use to format major tick labels. |
| Label CSS Styles | Sets the additional styles attribute to use to format the axis value labels. |
| Interaction |
|---|
| Bound Menu | Sets the jsxname property for the context menu instance to display on a right-click. |
Read-Only. The JSX foundation class that this object is an instance of.
Read-Only. The unique, system-assigned ID for this object.
Getter: getId()
Sets the name assigned by the developer to identify this object.
Getter: getName()
Setter: setName()
Property: jsxname
Sets whether the axis is horizontal or vertical.
Default Value: Horizontal (jsx3.Boolean.TRUE)
Getter: getHorizontal()
Setter: setHorizontal()
Property: horizontal
Allowed Values: - Horizontal (
jsx3.Boolean.TRUE) - Vertical (
jsx3.Boolean.FALSE)
Sets the amount of space in pixels that the axis ticks, labels, and title occupy.
Default Value: 50 vertical, 12 horizontal
Getter: getDisplayWidth()
Setter: setDisplayWidth()
Property: displayWidth
Sets whether to show a line along the axis.
Default Value: FALSE (jsx3.Boolean.FALSE)
Getter: getShowAxis()
Setter: setShowAxis()
Property: showAxis
Allowed Values: - TRUE (
jsx3.Boolean.TRUE) - FALSE (
jsx3.Boolean.FALSE)
Sets the vector stroke to use for drawing the line along the axis. Specified as color width alpha. For example, black 1 1.
Default Value: black 1 1
Getter: getAxisStroke()
Setter: setAxisStroke()
Property: axisStroke
Sets the length of major ticks.
Default Value: 0
Getter: getTickLength()
Setter: setTickLength()
Property: tickLength
Sets the vector stroke to use for drawing major ticks. Specified as color width alpha. For example, black 1 1. If empty, ticks aren't rendered.
Default Value: Empty
Getter: getTickStroke()
Setter: setTickStroke()
Property: tickStroke
Sets the placement of major ticks.
Default Value: none (jsx3.chart.Axis.TICK_NONE)
Getter: getTickPlacement()
Setter: setTickPlacement()
Property: tickPlacement
Allowed Values: - inside (
jsx3.chart.Axis.TICK_INSIDE) - outside (
jsx3.chart.Axis.TICK_OUTSIDE) - cross (
jsx3.chart.Axis.TICK_CROSS) - none (
jsx3.chart.Axis.TICK_NONE)
Sets the length of minor ticks.
Default Value: 0
Getter: getMinorTickLength()
Setter: setMinorTickLength()
Property: minorTickLength
Sets the vector stroke to use for drawing minor ticks. Specified as color width alpha. For example, black 1 1. If empty, ticks aren't rendered.
Default Value: Empty
Getter: getMinorTickStroke()
Setter: setMinorTickStroke()
Property: minorTickStroke
Sets the placement of minor ticks.
Default Value: none (jsx3.chart.Axis.TICK_NONE)
Getter: getMinorTickPlacement()
Setter: setMinorTickPlacement()
Property: minorTickPlacement
Allowed Values: - inside (
jsx3.chart.Axis.TICK_INSIDE) - outside (
jsx3.chart.Axis.TICK_OUTSIDE) - cross (
jsx3.chart.Axis.TICK_CROSS) - none (
jsx3.chart.Axis.TICK_NONE)
Sets the number of minor tick divisions between major ticks. The number of minor ticks shown are less than this value.
Default Value: 0
Getter: getMinorTickDivisions()
Setter: setMinorTickDivisions()
Property: minorTickDivisions
Sets whether to show data labels along the axis.
Default Value: FALSE (jsx3.Boolean.FALSE)
Getter: getShowLabels()
Setter: setShowLabels()
Property: showLabels
Allowed Values: - TRUE (
jsx3.Boolean.TRUE) - FALSE (
jsx3.Boolean.FALSE)
Sets the gap between tick marks and labels in pixels.
Default Value: 0
Getter: getLabelGap()
Setter: setLabelGap()
Property: labelGap
Sets the placement of axis labels with respect to the axis.
Default Value: axis (jsx3.chart.Axis.LABEL_AXIS)
Getter: getLabelPlacement()
Setter: setLabelPlacement()
Property: labelPlacement
Allowed Values: - axis (
jsx3.chart.Axis.LABEL_AXIS) - high (
jsx3.chart.Axis.LABEL_HIGH) - low (
jsx3.chart.Axis.LABEL_LOW)
A function that formats the labels to be displayed next to major ticks with signature function(value) : String. Static methods in jsx3.chart.Axis can be used here.
Getter: getLabelFunction()
Setter: setLabelFunction()
Property: labelFunction
Sets the jsxname of a CSS class to use to format major tick labels.
Default Value: Empty
Getter: getLabelClass()
Setter: setLabelClass()
Property: labelClass
Sets the additional styles attribute to use to format the axis value labels.
Default Value: Empty
Getter: getLabelStyle()
Setter: setLabelStyle()
Property: labelStyle
Sets the jsxname property for the context menu instance to display on a right-click.
Getter: getMenu()
Setter: setMenu()
Property: jsxmenu
Copyright © 2001-2007, TIBCO Software Inc.