valueAxis

Configures the value axis.

Type:

Object

|

Array

DevExtreme HTML5 Charts Axis Axes

The valueAxis object, which is described here, configures the value axis individually. To specify common settings for all axes in a chart, use the commonAxisSettings object. Axis-specific settings override common settings.

View Demo

axisDivisionFactor

Specifies the minimum distance between two neighboring major ticks in pixels. Applies only to the axes of the "continuous" and "logarithmic" types.

Type:

Number

Default Value: 30

For axes displaying numbers, the distance between major ticks depends on two interconnected options: axisDivisionFactor and tickInterval. Consider that you have specified both these options. If the specified tick interval leads the pixel distance between two ticks to being less than the axisDivisionFactor value, this tick interval will be ignored.

Use the axisDivisionFactor option only if you need to set the distance between ticks not knowing the axis values. Otherwise, use the tickInterval option.

NOTE
If the axisDivisionFactor value leads axis labels to overlapping, this value will be ignored.

categories

Specifies the order of categories on an axis of the "discrete" type.

Type:

Array

By default, values on a discrete axis keep the order of objects in the data source. To change it, assign an array of properly sorted values to the categories option.

NOTE
Values missing from the categories array will be added to its end automatically.

color

Specifies the color of the axis line.

Type:

String

Default Value: '#d3d3d3'

This option supports the following colors.

constantLines[]

Declares a collection of constant lines belonging to the value axis.

Type:

Array

Cannot be used in themes.

DevExtreme HTML5 Charts ConstantLines

Each object in the constantLines array configures a single constant line. Setting the value option is necessary for a constant line to be displayed.

See Also
  • valueAxis | constantLineStyle - specifies the appearance of those constant lines that belong to the value axis.
  • commonAxisSettings | constantLineStyle - specifies the appearance of all constant lines in the widget.
Show Example:
jQuery

In the following example, each value axis constant line is drawn in a different color and width.


                                    

                                    

constantLineStyle

Specifies the appearance of those constant lines that belong to the value axis.

Type:

Object

DevExtreme HTML5 Charts ConstantLines

See Also
  • valueAxis | constantLines[] - configures individual constant lines. Overrides the options of the valueAxis | constantLineStyle object, which is described here.
  • commonAxisSettings | constantLineStyle - specifies the appearance of all constant lines in the widget.

discreteAxisDivisionMode

Specifies whether ticks and grid lines should cross axis labels or lie between them. Applies only to the axes of the "discrete" type.

Type:

String

Default Value: 'betweenLabels'
Accepted Values: 'betweenLabels' | 'crossLabels'
See Also
  • argumentAxis | type - sets the type of the argument axis.
  • valueAxis | type - sets the type of the value axis.
Show Example:
jQuery

In this example, you can change the value of the discreteAxisDivisionMode option using the select box under the chart. Note how the grid lines change their position in accordance with the value of this option.


                                    

                                    

grid

Configures the grid.

Type:

Object

A grid is a set of mutually-crossing vertical and horizontal lines that stretch throughout the entire chart. Visually, grid lines can be considered extensions of major ticks. The grid improves the readability of chart data.

DevExtreme HTML5 Charts GridLines

The commonAxisSettings | grid object specifies common settings for all grid lines in the chart. To configure only those grid lines that descend from a particular axis, use the following objects.

Axis-specific settings override common settings.

See Also
  • commonAxisSettings | minorGrid - configures the minor grid built on minor ticks.

inverted

Inverts the axis.

Type:

Boolean

Default Value: false

When an axis is inverted (that is, when this option is set to true), its maximum and minimum values swap their places. As a result, axis values ascend in the opposite direction. Along with the axis, series also become inverted.

See Also
Show Example:
jQuery

Use the check box at the bottom to invert the value axis.


                                    

                                    

label

Configures the labels of the value axis.

Type:

Object

Axis labels display the values of major axis ticks.

DevExtreme HTML5 Charts AxisLabels

See Also
  • commonAxisSettings | label - configures the labels of all axes in the widget.

logarithmBase

Specifies the value to be raised to a power when generating ticks for an axis of the "logarithmic" type.

Type:

Number

Default Value: 10

By default, ticks on a logarithmic axis are generated on a base of 10, i.e., 0.1, 1, 10, 100, 1000 etc. But you can specify the needed base using the logarithmBase option. For example, if you set this option to 5, the following ticks will be generated: 0.5, 5, 25, 125, 625, etc.

NOTE
This value should be greater than 1.
Show Example:
jQuery

Use the set of radio buttons located under the chart to change the value axis' logarithmBase option at runtime.


                                    

                                    

max

Coupled with the min option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type.

Type:

Number

|

Date

|

String

Default Value: undefined

The min and max options specify custom limits for the value axis, thus focusing the widget on a specific chart segment. By default, these options equal to the minimum and maximum values on the axis.

NOTE
If the valueMarginsEnabled option is true, the value axis extends slightly beyond the min and max values.

maxValueMargin

Controls the empty space between the maximum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type.

Type:

Number

Default Value: undefined

By default, the axes extend slightly beyond their extrema generating an empty space between the axes and the minimum/maximum series points. It prevents cutting off parts of those points. To control this empty space, use the minValueMargin and maxValueMargin options. These options are used in the following formulas for the actual start and end axis values.

startAxisValue = min - (max - min) * minValueMargin
endAxisValue = max + (max - min) * maxValueMargin

For example, consider that min is 1960 and max is 2010. If you set the minValueMargin and maxValueMargin options to 0.1, the axis will start in 1955 and end in 2015.

startAxisValue = 1960 - (2010 - 1960) * 0.1 = 1960 - 50 * 0.1 = 1960 - 5 = 1955
endAxisValue = 2010 + (2010 - 1960) * 0.1 = 2010 + 50 * 0.1 = 2010 + 5 = 2015

See Also

min

Coupled with the max option, focuses the widget on a specific chart segment. Applies only to the axes of the "continuous" and "logarithmic" type.

Type:

Number

|

Date

|

String

Default Value: undefined

The min and max options specify custom limits for the value axis, thus focusing the widget on a specific chart segment. By default, these options equal to the minimum and maximum values on the axis.

NOTE
If the valueMarginsEnabled option is true, the value axis extends slightly beyond the min and max values.

minorGrid

Configures the minor grid.

Type:

Object

In addition to the major grid built on major ticks, the Chart widget provides the minor grid built on minor ticks.

DevExtreme HTML5 Charts MinorGridLines

NOTE
Neither minor ticks, nor the minor grid can be displayed if the axis is of the "discrete" type.

The commonAxisSettings | minorGrid object specifies common settings for all minor grid lines in the chart. To configure only those grid lines that descend from a particular axis, use the following objects.

Axis-specific settings override common settings.

NOTE
Displaying the minor grid without the major grid may impair the readability of a chart. To prevent this situation, we recommend you use the minor grid only in conjunction with the major grid.

minorTick

Configures the appearance of minor axis ticks.

Type:

Object

Along with major ticks, the Chart widget supports minor ticks. They divide an axis segment limited by two neighboring major ticks.

DevExtreme HTML5 Charts MinorTicks

The commonAxisSettings | minorTick object specifies common settings for all minor ticks in the chart. To configure only those minor ticks that belong to a particular axis, use the following objects.

Axis-specific settings override common settings.

NOTE
Minor ticks cannot be displayed on an axis of the "discrete" type.
See Also
  • argumentAxis | minorTickInterval - specifies the minor tick interval of the argument axis.
  • valueAxis | minorTickInterval - specifies the minor tick interval of the value axis.

minorTickCount

Specifies how many minor ticks to place between two neighboring major ticks.

Type:

Number

Default Value: undefined
See Also
  • valueAxis | minorTickInterval - specifies the interval between minor ticks. Has a higher priority than the minorTickCount option.

minorTickInterval

Specifies the interval between minor ticks. Applies only to the axes of the "continuous" type.

Type:

Number

|

Object

|

String

Default Value: undefined
Accepted Values: 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'

Minor ticks divide the segment between two neighboring major ticks into smaller segments. Minor ticks are generated automatically, unless the minorTickInterval option is set.

If the axis displays numbers, assign a number to this option. If the axis displays date-time values, assign one of the accepted string values or an object to this option. The object should contain only one of all fields described in this section, for example:

JavaScript
var chartOptions = {
    // ...
    valueAxis: {
        // ...
        minorTickInterval: { days: 5 }
    }
};
See Also
  • valueAxis | minorTickCount - specifies how many minor ticks to place between two neighboring major ticks.
  • valueAxis | minorTick - configures the appearance of minor ticks.
  • valueAxis | tickInterval - specifies the interval between major ticks.

minValueMargin

Controls the empty space between the minimum series points and the axis. Applies only to the axes of the "continuous" and "logarithmic" type.

Type:

Number

Default Value: undefined

By default, the axes extend slightly beyond their extrema generating an empty space between the axes and the minimum/maximum series points. It prevents cutting off parts of those points. To control this empty space, use the minValueMargin and maxValueMargin options. These options are used in the following formulas for the actual start and end axis values.

startAxisValue = min - (max - min) * minValueMargin
endAxisValue = max + (max - min) * maxValueMargin

For example, consider that min is 1960 and max is 2010. If you set the minValueMargin and maxValueMargin options to 0.1, the axis will start in 1955 and end in 2015.

startAxisValue = 1960 - (2010 - 1960) * 0.1 = 1960 - 50 * 0.1 = 1960 - 5 = 1955
endAxisValue = 2010 + (2010 - 1960) * 0.1 = 2010 + 50 * 0.1 = 2010 + 5 = 2015

See Also

multipleAxesSpacing

Adds a pixel-measured empty space between two side-by-side value axes. Applies if several value axes are located on one side of the chart.

Type:

Number

Default Value: 5

The order of axes in the valueAxis array plays a significant role when you specify this option. When you need to add an empty space between two side-by-side axes, set the multipleAxesSpacing option for the axis declared last in the valueAxis array. For example, to add space between the second and the third axes, set the multipleAxesSpacing option for the third axis.

NOTE
Obviously, setting this option for the first axis takes no effect, because this axis is never the last one in any pair of axes.

name

Specifies the name of the value axis.

Type:

String

Default Value: undefined
Cannot be used in themes.

When there are multiple value axes in a chart, series need to know exactly which axis they are bound to. By default, all of them are bound to the first axis in the valueAxis array. To bind a series to another axis, name the axis and assign this name to the axis series property.

opacity

Specifies how transparent the axis line should be.

Type:

Number

Default Value: undefined

This option accepts a value from 0 to 1, where 0 makes the axis line completely transparent, and 1 makes it opaque.

pane

Binds the value axis to a pane.

Type:

String

Default Value: undefined
See Also
  • panes - declares an array of panes.

View Demo

placeholderSize

Reserves a pixel-measured space for the axis.

Type:

Number

Default Value: null

The reserved space will be occupied by the axis line and axis labels.

DevExtreme HTML5 Charts AxisPlaceholder

See Also
  • margin - generates space around the widget.

position

Relocates the value axis.

Type:

String

Default Value: 'left'
Accepted Values: 'right' | 'left' | 'top' | 'bottom'

Depending on the value of the rotated option, position accepts different values.

rotated position
false "left" or "right"
true "bottom" or "top"
Show Example:
jQuery

In the example below, the value axis is placed on the right side using the position option.


                                    

                                    

setTicksAtUnitBeginning

Rounds off date-time values to the nearest tick interval. Applies only to the axes of the "continuous" type containing date-time values.

Type:

Boolean

Default Value: true

This option impacts tick arrangement on axes that contain date-time values. The following table illustrates exactly how ticks will be arranged depending on the value of this option.

Tick Interval Start Axis Value setTicksAtUnitBeginning: true
2 hours 11h:35min:25s:10ms 13h:00min:00s:00ms
15h:00min:00s:00ms
17h:00min:00s:00ms
...
2 days 6d:11h:35min 8d:00h:00min
10d:00h:00min
12d:00h:00min
...
2 months March:13d May:1d
July:1d
September:1d
...
See Also
  • argumentAxis | tickInterval - sets a tick interval for the argument axis.
  • valueAxis | tickInterval - sets a tick interval for the value axis.

showZero

Specifies whether or not to show zero on the value axis.

Type:

Boolean

Default Value: undefined

By default, the value axis shows zero for area- and bar-like series, and hides it for others. To force showing zero regardless of the series type, set the showZero option to true. If you set this option to false, zero will be hidden until it is included in any series.

strips[]

Declares a collection of strips belonging to the value axis.

Type:

Array

Cannot be used in themes.

A strip is a colored piece of the chart's background that highlights a range of values. Strips allow a viewer to see whether a certain series point falls in or out of a range.

DevExtreme HTML5 Charts Strips

Each object in the strips array configures a single strip. To limit a strip, set its startValue and endValue options. You may set only one of them, in which case the strip will not have a limit at one end. Note that setting the color option is also necessary for a strip to be displayed.

See Also
  • valueAxis | stripStyle - specifies the appearance of those strips that belong to the value axis.
  • commonAxisSettings | stripStyle - specifies the appearance of all strips in the widget.
Show Example:
jQuery

In this example, the value axis strips are defined and colored in a custom color.


                                    

                                    

stripStyle

Configures the appearance of strips.

Type:

Object

DevExtreme HTML5 Charts Strips

The commonAxisSettings | stripStyle object specifies common settings for all strips in the chart. To configure only those strips that belong to a particular axis, use the following objects.

To configure individual strips, use the following arrays of objects.

Individual settings override axis-specific settings which, in their turn, override common settings.

synchronizedValue

Synchronizes two or more value axes with each other at a specific value.

Type:

Number

Default Value: undefined

A synchronizedValue produces an extra tick on the value axis. Such ticks of each value axis will be laid in one line thus synchronizing the axes with each other.

NOTE
For full-stacked-like series, the synchronizedValue option accepts a value from 0 to 1, where 0 denotes 0% and 1 denotes 100%.

tick

Configures the appearance of major axis ticks.

Type:

Object

Ticks divide an axis into sections that measure off values on this axis.

DevExtreme HTML5 Charts MajorTicks

The commonAxisSettings | tick object specifies common settings for all major ticks in the chart. To configure only those major ticks that belong to a particular axis, use the following objects.

Axis-specific settings override common settings.

See Also
  • argumentAxis | tickInterval - specifies the tick interval of the argument axis.
  • valueAxis | tickInterval - specifies the tick interval of the value axis.
  • commonAxisSettings | minorTick - customizes the appearance of minor ticks.

tickInterval

Specifies the interval between major ticks.

Type:

Number

|

Object

|

String

Default Value: undefined
Accepted Values: 'millisecond' | 'second' | 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year'

Major ticks divide an axis into segments thus improving the viewer's perception of visualized data. Major ticks are generated automatically, unless the tickInterval option is set.

If the axis displays numbers, assign a number to this option. If the axis displays date-time values, assign one of the accepted string values or an object to this option. The object should contain only one of all fields described in this section, for example:

JavaScript
var chartOptions = {
    // ...
    valueAxis: {
        // ...
        tickInterval: { days: 5 }
    }
};

When you use an axis of the "logarithmic" type, ticks are generated on a base of powers. For example, assuming that the logarithm base is 10 and the tick interval is 1, ticks are generated at 10-2, 10-1, 100, 101, 102, 103, etc. If the tick interval becomes 2, ticks are generated at 10-1, 101, 103, etc.

NOTE
A custom tick interval can be ignored if it leads axis labels to being overlapped by each other. To force the widget to use it anyway, assign "ignore" to the valueAxis | label | overlappingBehavior option.
See Also
  • valueAxis | tick - configures the appearance of major ticks.
  • valueAxis | minorTickInterval - specifies the interval between minor ticks.

title

Configures the axis title.

Type:

String

|

Object

The axis title is a short text displayed alongside the axis. Usually, the axis title shows units of measurement for values displayed by the axis. You can put any text in the axis title though.

DevExtreme HTML5 Charts AxisTitles

If you assign an object to the title option, specifying the text field of this object is necessary for the axis title to be displayed. Besides the object, the title option accepts a string, thus providing a shortcut for setting the axis title. Therefore, this:

title: 'Axis Title'

is the same as this:

title: {
    text: 'Axis Title'
}
See Also
  • commonAxisSettings | title - configures all axis titles in the widget.

type

Specifies the type of the value axis.

Type:

String

Default Value: undefined
Accepted Values: 'discrete' | 'continuous' | 'logarithmic'

The value axis can have one of the following types.

  • Continuous
    Displays numeric and date-time values. To divide this axis into intervals, use the tickInterval option.
  • Discrete
    Displays string values called "categories". To sort them, use the categories array.
  • Logarithmic
    Displays numeric values. Each value is the logarithmBase value raised to some power. For example, logarithmBase equaling to 5 produces the following values: 50, 51, 52, 53 etc. The logarithmic axis is useful when you visualize a dataset of rapidly-growing values.

Normally, there is no need to specify this option, because the axis type is determined automatically depending on the type of values. However, you may force the use of a specific axis type, for example, to employ the "discrete" axis type with numeric or date-time values.

View Demo

valueMarginsEnabled

Adds an empty space between the axis and the minimum and maximum series points.

Type:

Boolean

Default Value: true

By default, the value axis extends slightly beyond its extrema. It prevents cutting off parts of the minimum and maximum series points. To disable this feature, set the valueMarginsEnabled option to false.

See Also
  • valueAxis | minValueMargin - sets a custom margin for minimum series points.
  • valueAxis | maxValueMargin - sets a custom margin for maximum series points.
Show Example:
jQuery

Use the check box at the bottom to enable/disable value margins for the value axis.


                                    

                                    

valueType

Casts values to a specified data type.

Type:

String

Default Value: undefined
Accepted Values: 'numeric' | 'datetime' | 'string'

If your data source stores, for example, numbers as strings, specify the proper data type using the valueType option.

NOTE
If dates in your data source are stored as strings, make sure that they have a valid format.
See Also
  • argumentAxis | argumentType - casts arguments to a proper data type.
  • valueAxis | type - specifies the axis type.
  • dataPrepareSettings | checkTypeForAllData - validates the type of each value coming from the data source.
  • dataPrepareSettings | convertToAxisDataType - allows you to disable the type cast in favour of the widget performance.

visible

Makes the axis line visible.

Type:

Boolean

Default Value: false

width

Specifies the width of the axis line in pixels.

Type:

Number

Default Value: 1