Type class
CategoryAxis is the class which displays category axis for the Serial Chart. The chart can have only one category axis. If you do not add category axis to the Serial chart, it will be created automatically.
Inheritance
CategoryAxis extends AxisBase
.
CategoryAxis is not extended by any other symbol.
Properties
boldPeriodBeginning # |
Type Default When parse dates is on for the category axis, the chart will try to highlight the beginning of the periods, like month, in bold. Set this to false to disable the functionality. |
---|---|
categoryFunction # |
Type specifies a method that returns the value that should be used as categoryValue for current item. If this property is set, the return value of the custom data function takes precedence over categoryField. When a chart calls this method, it passes category value, data item from chart's data provider and reference to categoryAxis: categoryFunction(category, dataItem, categoryAxis); This method can be used both when category axis parses dates and when it doesn't. If axis parses dates, your categoryFunction should return Date object. For example, if you have date strings in your data, you can use this method to convert these strings into Date objects. |
centerLabelOnFullPeriod # |
Type Default This setting works only when parseDates is set to true and equalSpacing is set to false. In case you set it to false, labels will never be centered between grid lines. |
dateFormats # |
Type Default Date formats of different periods. Possible period values: fff - milliseconds, ss - seconds, mm - minutes, hh - hours, DD - days, MM - months, WW - weeks, YYYY - years. Check this page for date formatting strings. |
equalSpacing # |
Type Default In case your category axis values are Date objects and parseDates is set to true, the chart will parse dates and will place your data points at irregular intervals. However if you want dates to be parsed (displayed on the axis, baloons, etc), but data points to be placed at equal intervals (omiting dates with no data), set equalSpacing to true. |
forceShowField # |
Type Field in data provider which specifies if the category value should always be shown. For example: categoryAxis.forceShowField = "forceShow"; And in data: {category:"one", forceShow:true, value:100} Note, this works only when parseDates is set to false. |
gridPosition # |
Type Default Specifies if a grid line is placed on the center of a cell or on the beginning of a cell. Possible values are: "start" and "middle" This setting doesn't work if parseDates is set to true. |
labelFunction # |
Type You can use this function to format Category axis labels. If this function is set, then it is called with the following parameters passed: if dates are not parsed: labelFunction(valueText, serialDataItem, categoryAxis) if dates are parsed: labelFunction(valueText, date, categoryAxis) Your function should return string which will be displayed on the axis. |
markPeriodChange # |
Type Default If you set it to false, the start of longer periods won't use a different date format and won't be bold. |
minPeriod # |
Type Default Specifies the shortest period of your data. This should be set only if parseDates is set to "true". Possible period values: fff - milliseconds, ss - seconds, mm - minutes, hh - hours, DD - days, MM - months, YYYY - years. It's also possible to supply a number for increments, i.e. "15mm" which will instruct the chart that your data is supplied in 15 minute increments. |
parseDates # |
Type Default In case your category axis values are Date objects, set this to true. In this case the chart will parse dates and will place your data points at irregular intervals. If you want dates to be parsed, but data points to be placed at equal intervals, set both parseDates and equalSpacing to true. |
startOnAxis # |
Type Default Specifies whether the graph should start on axis or not. In case you display columns, it is recommended to set this to false. If parseDates is set to true, startOnAxis will allways be false, unless equalSpacing is set to true. |
autoGridCount # |
Type Default Inherited from Specifies whether number of gridCount is specified automatically, acoarding to the axis size. |
axisAlpha # |
Type Default Inherited from Axis opacity. Value range is 0 - 1. |
axisColor # |
Type Default Inherited from Axis color. |
axisThickness # |
Type Default Inherited from Thickness of the axis. |
color # |
Type Default Inherited from Color of axis value labels. Will use chart's color if not set. |
dashLength # |
Type Default Inherited from Length of a dash. 0 means line is not dashed. |
fillAlpha # |
Type Default Inherited from Fill opacity. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills. |
fillColor # |
Type Default Inherited from Fill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills. |
fontSize # |
Type Default Inherited from Size of value labels text. Will use chart's fontSize if not set. |
gridAlpha # |
Type Default Inherited from Opacity of grid lines. |
gridColor # |
Type Default Inherited from Color of grid lines. |
gridCount # |
Type Default Inherited from Number of grid lines. In case this is value axis, or your categoryAxis parses dates, the number is approximate. The default value is 5. If you set autoGridCount to true, this property is ignored. |
gridThickness # |
Type Default Inherited from Thickness of grid lines. |
guides # |
Type Default Inherited from The array of guides belonging to this axis. |
ignoreAxisWidth # |
Type Default Inherited from If autoMargins of a chart is set to true, but you want this axis not to be measured when calculating margin, set ignoreAxisWidth to true. |
inside # |
Type Default Inherited from Specifies whether values should be placed inside or outside plot area. |
labelFrequency # |
Type Default Inherited from Frequency at which labels should be placed. Doesn't work for CategoryAxis if parseDates is set to true. |
labelRotation # |
Type Default Inherited from Rotation angle of a label. Only horizontal axis' values can be rotated. If you set this for vertical axis, the setting will be ignored. |
labelsEnabled # |
Type Default Inherited from Specifies whether axis displays category axis' labels and value axis' values. |
offset # |
Type Default Inherited from The distance of the axis to the plot area, in pixels. Negative values can also be used. |
position # |
Type Default Inherited from Possible values are: "top", "bottom", "left", "right". If axis is vertical, default position is "left". If axis is horizontal, default position is "bottom". |
showFirstLabel # |
Type Default Inherited from Whether to show first axis label or not. |
showLastLabel # |
Type Default Inherited from Whether to show last axis label or not. |
tickLength # |
Type Default Inherited from Length of the tick marks. |
title # |
Type Default Inherited from Title of the axis. |
titleBold # |
Type Default Inherited from Specifies if title should be bold or not. |
titleColor # |
Type Default Inherited from Color of axis title. Will use text color of chart if not set any. |
titleFontSize # |
Type Default Inherited from Font size of axis title. Will use font size of chart plus two pixels if not set any. |
There are 28 inherited items currently hidden from this list. |
Methods
addGuide( |
Returns Inherited from Adds guide to the axis. guide - instance of Guide |
---|---|
categoryToCoordinate( |
Returns returns coordinate of a category. Works only if parseDates is false. If parseDates is true, use dateToCoordinate method. category - String |
coordinateToDate( |
Returns Returns Date of the coordinate, in case parseDates is set to true and equalSpacing is set to false. coordinate - Number |
dateToCoordinate( |
Returns Returns coordinate of the date, in case parseDates is set to true. if parseDates is false, use categoryToCoordinate method. date - Date object |
removeGuide( |
Returns Inherited from Removes guide from the axis. guide - instance of Guide |
xToIndex( |
Returns Returns index of the category which is most close to specified coordinate. x - coordinate |
There are 2 inherited items currently hidden from this list. |
Events
CategoryAxis does not have any events.
Adapters
CategoryAxis does not have any adapters.