A5.chartDefinition Axis Object
Description
Definition of an axis of a chart.
- Name
- Description
- A5.chart.Definition Axis.Interval Date Object
Definition of an axis of a chart.
- A5.chart.Definition Axis.Interval Discrete Object
Definition of an axis of a chart.
- A5.chart.Definition Axis.Interval Number Object
Definition of an axis of a chart.
Properties
- axisstring
If the axis is a "value" axis from either a "linear" or "radial" chart, then the axis the value will be drawn on needs to be specified. For "linear" the values are "x" or "y", and for "radial" the values are "angle" or "distance".
- reversestring
If true (the default is false) then the axis will be drawn in the reverse direction. For example, if the "x" axis wanted to have the negative values be to the right instead of the left, then reverse would be set to true.
- intervalobject
The definition for how the interval is calculated. See A5.chart Definition Axis Object - Interval Discrete Object, A5.chart Definition Axis Object - Interval Number Object and A5.chart Definition Axis Object - Interval Date Object.
- rangeobject
The range of the axis. If not specified then the "best-fit" will be chosen based on the interval and base.
- minnumberdate
The minimum value.
- maxnumberdate
The maximum value.
- titleobject
Defines the axis title. Only applies to "rect" and "linear" chart types.
- locationstring
The location of the title. Values can be "none", "center" (in the center of the chart), "base" (at the base value of the axis), "before", "inside-before", "inside-after" or "after".
- alignstring
The alignment of the title along the axis. Values can be "high" (aligned to the higher value on the axis), "low" (aligned to the lower value on the axis) or "center" (the default).
- offsetobject
The offset of the title.
- majornumber
The major offset perpendicular to the direction of the axis. The default value is 6.
- minornumber
The minor offset parallel to the direction of the axis. The default value is 0.
- outlineboolean
If true (the default) the the text will be outlined to help readability against unknown backgrounds.
- classNamestring
The CSS class name to apply to the title.
- stylestring
The CSS style to apply to the title.
- htmlstringfunction(data,temp)
The HTML to display in the axis title. Strings will be considered to be templates. See A5.chart Render Data Object for definition of the data and A5.u.template.
- attrsstringfunction(data,temp)
The HTML attributes to add to the axis title element. Strings will be considered to be templates. See A5.chart Render Data Object for definition of the data and A5.u.template.
- tipstringfunction(data,temp)
The help tip to add to the axis title element. Strings will be considered to be templates. See A5.chart Render Data Object for definition of the data and A5.u.template.
- marksobject
Defines the marks to draw on an axis.
- showstring
Which marks to show on the axis. The values can be "all" (the default), "interval" (only marks that fall on the interval), "base" (only the axis base line), "minimal" (the high, low and base) or "high-low".
- showboolean
If true (the default), then lines will be draw for each mark.
- bracketboolean
If true then the lines will bracket the mark location instead of being on the mark. The default is false. Bracketing can be useful for some chart types, such as bar charts where the lines would want to bracket the group of bars.
- lineobjectfunction(data,temp)
The line draw settings. See A5.chart Definition Line Object and A5.chart Render Data Object.
- labelsobject
Defines the mark labels.
- locationstring
Where to locate the axis labels. Values can be "none", "center" (in the center of the chart), "base" (at the base value of the axis), "before", "inside-before", "inside-after" or "after".
- alignstring
The alignment of the label along the axis. Values can be "auto" (the default), "high", "low", "center", "in" or "out" (the last two align the labels relative to the location of the base). Only applies to "rect" and "linear" chart types.
- rotatenumberstring
The rotation (in degrees) to apply to the label. If the chart is "polar" or "radial" then a string with the value of "auto", "normal" or "tangent" can be specified to dynamically calculate the angle base on the label location on the axis.
- processfunction(label)
Function to process the label HTML.
- offsetobject
The offset of the label.
- axisnumber
The offset perpendicular to the direction of the axis, or relative to the center in "polar" and "radial" charts. Offset is applied before rotation. The default value is 6.
- majornumber
The major offset relative to the axis and rotation. The default value is 0.
- minornumber
The minor offset relative to the axis and rotation. The default value is 0.
- outlineboolean
If true (the default) the the text will be outlined to help readability against unknown backgrounds.
- classNamestring
The CSS class name to apply to the label.
- stylestring
The CSS style to apply to the label.
- attrsstringfunction(data,temp)
The HTML attributes to add to the axis label element. Strings will be considered to be templates. See A5.chart Render Data Object for definition of the data and A5.u.template.
- tipstringfunction(data,temp)
The help tip to add to the axis label element. Strings will be considered to be templates. See A5.chart Render Data Object for definition of the data and A5.u.template.