Skip to content

ValueAxesSettings

Type class

ValueAxesSettings settings set's settings for all ValueAxes. 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 ValueAxis class will be used.

Sources

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

Inheritance

ValueAxesSettings does not extend any other symbol.

ValueAxesSettings is not extended by any other symbol.

Properties

autoGridCount

Type booleanDefault true

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

axisAlpha

Type numberDefault 0

Axis opacity.

axisColor

Type color

Axis color.

axisThickness

Type number

Thickness of the axis.

color

Type color

Label color.

dashLength

Type number

Length of a dash. By default, the grid line is not dashed.

fillAlpha

Type number

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

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.

gridAlpha

Type number

Opacity of grid lines.

gridColor

Type color

Color of grid lines.

gridCount

Type number

Approximate number of grid lines. autoGridCount should be set to false, otherwise this property will be ignored.

gridThickness

Type number

Thickness of grid lines.

includeGuidesInMinMax

Type boolean

Specifies whether guide values should be included when calculating min and max of the axis.

includeHidden

Type boolean

If true, the axis will include hidden graphs when calculating min and max values.

inside

Type booleanDefault true

Specifies whether values should be placed inside or outside plot area. In case you set this to false, you'll have to adjust marginLeft or marginRight in PanelsSettings in order labels to be visible.

Note, if you set this property to false, you might also consider setting showLastLabel to true.

integersOnly

Type boolean

Specifies whether values on axis can only be integers or both integers and doubles.

labelFrequency

Type number

Frequency at which labels should be placed.

labelOffset

Type numberDefault 0

You can use it to adjust position of axis labels.

labelsEnabled

Type boolean

Specifies whether value labels are displayed.

logarithmic

Type boolean

Set to true if value axis is logarithmic, false otherwise.

maximum

Type number

If you don't want max value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.

minimum

Type number

If you don't want min value to be calculated by the chart, set it using this property. This value might still be adjusted so that it would be possible to draw grid at rounded intervals.

minMaxMultiplier

Type number

If set value axis scale (min and max numbers) will be multiplied by it. I.e. if set to 1.2 the scope of values will increase by 20%.

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.

minVerticalGap

Type number

This property is used when calculating grid count (when autoGridCount is true). It specifies minimum cell height required for one span between grid lines.

offset

Type number

The distance of the axis to the plot area, in pixels. Useful if you have more then one axis on the same side.

position

Type string

Position of the value axis. Possible values are "left" and "right".

precision

Type number

Precision (number of decimals) of values.

reversed

Type boolean

Set to true if value axis is reversed (smaller values on top), false otherwise.

showFirstLabel

Type booleanDefault true

Specifies if first label of value axis should be displayed.

showLastLabel

Type booleanDefault false

Specifies if last label of value axis should be displayed.

stackType

Type string

Stacking mode of the axis. Possible values are: "none", "regular", "100%", "3d".

strictMinMax

Type boolean

If you set minimum and maximum for your axis, chart adjusts them so that grid would start and end on the beginning and end of plot area and grid would be at equal intervals. If you set strictMinMax to true, the chart will not adjust minimum and maximum of value axis.

tickLength

Type numberDefault 0

Tick length.

unit

Type string

Unit which will be added to the value label.

unitPosition

Type string

Position of the unit. Possible values are "left" or "right".

Methods

ValueAxesSettings does not have any methods.

Events

ValueAxesSettings does not have any events.