Box
Map
Vue
A newer version of this page is available. Switch to the current version.

jQuery PolarChart - commonAxisSettings

An object defining the configuration properties that are common for all axes of the PolarChart UI component.

Type:

Object

Use this object's properties to set the properties for all chart axes at once. The property values will be applied to the argument axis and all values axes, which are defined in the valueAxis array. To set a common axis property for an axis individually, use the corresponding valueAxis or argumentAxis object. Values that are set individually override their corresponding common values.

allowDecimals

Specifies whether to allow decimal values on the axis. When false, the axis contains integer values only.

Type:

Boolean

Default Value: undefined

color

Specifies the color of the line that represents an axis.

Type:

String

Default Value: '#767676'

This property supports the following colors:

constantLineStyle

Specifies the appearance of all the UI component's constant lines.

Type:

Object

Use this object to set the appearance properties for the constant lines of both the argument and value axes. For example, you can change the color, dash style and width of the line using corresponding properties or define the look of the labels using the label object.

To specify styles for the constant lines of the argument and value axis separately, use the constantLineStyle object within the argumentAxis or valueAxis configuration object correspondingly. Note that the properties that are set within these objects override the corresponding properties that are set within the commonAxisSettings.constantLineStyle object.

In addition, you can define the appearance of each constant line individually. For more information, refer to the argumentAxis.constantLines or valueAxis.constantLines object description.

discreteAxisDivisionMode

Specifies whether ticks/grid lines of a discrete axis are located between labels or cross the labels.

Type:

String

Default Value: 'betweenLabels'
Accepted Values: 'betweenLabels' | 'crossLabels'

When a discrete axis is divided, its ticks/grid lines are located between labels by default. If this is not appropriate, use the discreteAxisDivisionMode property to set the required mode for positioning ticks and grid lines on a discrete axis.

NOTE
This property is not designed to work in the spider web mode.

View Demo

endOnTick

Specifies whether to force the axis to start and end on ticks.

Type:

Boolean

Default Value: undefined

grid

An object defining the configuration properties for the grid lines of an axis in the PolarChart UI component.

Type:

Object

Grid lines are the reference lines used to improve the readability of a chart's visual data. The grid object exposes the properties that allow you to specify visibility and appearance settings for axis grid lines. To learn more about axis grid lines and their properties, refer to the Grid topic.

PolarChart Grid Lines

inverted

Indicates whether or not an axis is inverted.

Type:

Boolean

Default Value: false

When an axis is inverted, the maximum and minimum values are reversed. As a result, the axis values increase in a direction that is opposite to the initial direction. The chart series are also inverted.

View Demo

label

An object defining the label configuration properties that are common for all axes in the PolarChart UI component.

Type:

Object

Axis labels represent textual values for axis ticks, which are not visible by default. Use the label object's properties to set common label properties for all axes simultaneously.

To set a common property for labels of a particular axis, use the label object within the argumentAxis or valueAxis configuration object. The values that are set individually override the corresponding common values.

minorGrid

Specifies the properties of the minor grid.

Type:

Object

In addition to the major grid built on major ticks, the PolarChart UI component provides the minor grid that is built on minor ticks. The lines of the minor grid extend from the minor ticks throughout the entire chart's plot.

NOTE
Neither minor ticks, nor the minor grid can be used if the axis is discrete.

To specify the appearance of grid lines, use the properties of the minorGrid object. Declared within the commonAxisSettings object, the minorGrid object changes the appearance of value and argument axes simultaneously. To change the appearance of the value or argument axis individually, declare the minorGrid object in the argumentAxis or valueAxis object respectively. Settings specified individually override those that are set in the commonAxisSettings object.

To make the minor grid visible, set the visible property of the minorGrid object to true. Additionally, you can change the color, opacity and width of the grid lines using the corresponding properties.

NOTE
We recommend you use the minor grid only in conjunction with the major grid.

minorTick

Specifies the properties of the minor ticks.

Type:

Object

In addition to major ticks, the PolarChart UI component provides the capability to draw minor ticks. Minor ticks divide an axis segment that lies between two neighboring major ticks. To specify how to generate minor ticks, use the minorTickInterval or minorTickCount properties.

To configure the appearance of minor ticks, use the properties of the minorTick object. Declared within the commonAxisSettings object, the minorTick object sets properties for all minor ticks. To change the appearance of the minor ticks that belong to the argument or value axis individually, declare the minorTick object in the argumentAxis or valueAxis object respectively. Settings specified individually override those that are set in the commonAxisSettings object.

By default, minor ticks are hidden. To make them visible, assign true to the visible property of the minorTick object. Additionally, you can change the color, opacity and width of the minor ticks using the corresponding properties.

NOTE
Minor ticks cannot be displayed on a discrete axis.

opacity

Specifies the opacity of the line that represents an axis.

Type:

Number

Default Value: undefined

stripStyle

An object defining configuration properties for strip style.

Type:

Object

Strips are the highlighted areas of a chart within a defined range of values (maximum and minimum) for an axis to which they belong. In general, strips are used to visually represent a range of values behind a series, to trace whether the series point values fall in or out of that range. For more details on strips, refer to the Strips topic.

To set properties for configuring strip style, define the stripStyle object within the argumentAxis or valueAxis configuration object. To set common properties for all strips in a chart, define the stripStyle object within the commonAxisSettings configuration object. Note that the values that are set for an individual axis override the corresponding common values.

tick

An object defining the configuration properties for axis ticks.

Type:

Object

Ticks divide an axis into equal sections by a step whose value is determined automatically, or by the tickInterval and axisDivisionFactor properties of an axis. Ticks improve the readability of charts, but are not visible in the PolarChart UI component by default. To set up tick configuration properties, define the tick object within the argumentAxis or valueAxis configuration object. To set common properties for all ticks in a chart, define the tick object within the commonAxisSettings configuration object. Note that the values that are set for an individual axis override the corresponding common values.

visible

Indicates whether or not the line that represents an axis in a chart is visible.

Type:

Boolean

Default Value: true

width

Specifies the width of the line that represents an axis in the chart.

Type:

Number

Default Value: 1