CategoryAxesSettings

Type class

CategoryAxesSettings settings set's settings common for all CategoryAxes of StockPanels. If you change a property after the chart is initialized, you should call stockChart.validateNow() method in order for it to work. If there is no default value specified, default value of CategoryAxis class will be used.

Sources

This information about CategoryAxesSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

CategoryAxesSettings does not extend any other symbol.

CategoryAxesSettings is not extended by any other symbol.

Properties

#alwaysGroup

Type booleanDefault false

If this is set to true and groupToPeriods doesn't have CategoryAxesSettings.minPeriod value included, chart will always group values to the first period available.

#autoGridCount

Type booleanDefault true

Specifies whether number of gridCount is specified automatically, according to the axis size.

#axisAlpha

Type numberDefault 0

Axis opacity.

#axisColor

Type color

Axis color.

#axisHeight

Type numberDefault 28

Height of category axes. Set it to 0 if you set inside property to true.

#axisThickness

Type number

Thickness of the axis.

#boldLabels

Type boolean

Specifies if axis labels should be bold or not.

#boldPeriodBeginning

Type booleanDefault true

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.

#color

Type color

Text color.

#dashLength

Type number

Length of a dash.

#dateFormats

Type object[]

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 booleanDefault false

If you want data points to be placed at equal intervals (omiting dates with no data), set equalSpacing to true.

#fillAlpha

Type number

Fill opacity. Every second space between grid lines can be filled with fillColor.

#fillColor

Type color

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 number

Text size.

#gridAlpha

Type number

Opacity of grid lines.

#gridColor

Type color

Color of grid lines.

#gridCount

Type numberDefault 10

Approximate number of grid lines. You should set autoGridCount to false in order this property not to be ignored.

#gridThickness

Type number

Thickness of grid lines.

#groupToPeriods

Type string[]Default [ "ss", "10ss", "30ss", "mm", "10mm", "30mm", "hh", "DD", "WW", "MM", "YYYY" ]

Periods to which data will be grouped in case there are more data items in the selected period than specified in maxSeries property.

#inside

Type booleanDefault false

Specifies whether values should be placed inside or outside of plot area.

#labelOffset

Type numberDefault 0

You can use it to adjust position of axis labels.

#labelRotation

Type number

Rotation angle of a label.

#labelsEnabled

Type booleanDefault true

Specifies whether axis displays category axis' labels and value axis' values.

#markPeriodChange

Type booleanDefault true

Specifies if period period should be marked with a different date format.

#maxSeries

Type numberDefault 150

Maximum series shown at a time. In case there are more data points in the selection than maxSeries, the chart will group data to longer periods, for example - you have 250 days in the selection, and maxSeries is 150 - the chart will group data to weeks.

#minHorizontalGap

Type numberDefault 75

This property is used when calculating grid count. It specifies minimum cell width required for one span between grid lines.

#minorGridAlpha

Type number

Opacity of minor grid. In order minor to be visible, you should set minorGridEnabled to true.

#minorGridEnabled

Type boolean

Specifies if minor grid should be displayed.

NOTE: If equalSpacing is set to true, this setting will be ignored.

#minPeriod

Type stringDefault DD

Specifies the shortest period of your data. fff - millisecond, ss - second, mm - minute, hh - hour, DD - day, MM - month, YYYY - year.

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.

#position

Type string

"top" or "bottom".

#startOnAxis

Type booleanDefault false

Specifies whether the graph should start on axis or not. In case you display columns, it is recommended to set this to false. startOnAxis can be set to true only if equalSpacing is set to true.

#tickLength

Type numberDefault 0

Tick length.

#twoLineMode

Type booleanDefault false

Works only when parseDates is set to true and equalSpacing is false. If you set it to true, at the position where bigger period changes, category axis will display date strings of bot small and big period, in two rows.

Methods

CategoryAxesSettings does not have any methods.

Events

CategoryAxesSettings does not have any events.