DevExtreme v23.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

ArgumentAxis

Configures the argument axis.

import { ArgumentAxis } from "devextreme/viz/chart"

aggregateByCategory Deprecated

Use the enabled instead.

Aggregates series points that fall into the same category.

Type:

Boolean

Default Value: true

aggregationGroupWidth

Specifies the length of aggregation intervals in pixels. Applies only to axes of continuous and logarithmic types. May be ignored in favor of the aggregationInterval property.

Type:

Number

Default Value: undefined

aggregationInterval

Specifies the length of aggregation intervals in axis units. Applies only to axes of continuous and logarithmic types.

argumentType

Casts arguments to a specified data type.

Default Value: undefined

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: 70

breaks

Declares a scale break collection. Applies only if the axis' type is "continuous" or "logarithmic".

Type:

Array<Object>

Default Value: undefined
Cannot be used in themes.

categories

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

Type:

Array<Number | String | Date>

Raised Events: optionChanged

constantLines

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

Type:

Array<Object>

Cannot be used in themes.

constantLineStyle

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

Type:

Object

customPosition

Specifies the position of the argument axis on the value axis.

Type:

Number

|

Date

|

String

Default Value: undefined

customPositionAxis

Specifies the name of a value axis on which the argument axis should be positioned. Applies only to multi-axis charts.

Type:

String

Default Value: undefined

endOnTick

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

Type:

Boolean

Default Value: false

holidays

Dates to be excluded from the axis when workdaysOnly is true.

Type:

Array<Date | String>

|

Array<Number>

Default Value: undefined

hoverMode

Specifies chart elements to be highlighted when a user points to an axis label.

Default Value: 'none'

label

Configures the labels of the argument axis.

Type:

Object

linearThreshold

Specifies a value used to calculate the range on a logarithmic axis within which the axis should be linear. Applies only if the data source contains negative values or zeroes.

Type:

Number

Default Value: undefined

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

minorTickCount

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

Type:

Number

Default Value: undefined

minorTickInterval

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

minVisualRangeLength

Specifies the minimum length of the visual range.

Default Value: undefined
Cannot be used in themes.

offset

Specifies the shift in pixels of the argument axis.

Type:

Number

Default Value: undefined

position

Relocates the argument axis.

Type:

Position

Default Value: 'bottom'

singleWorkdays

Dates to be included on the axis when workdaysOnly is true.

Type:

Array<Date | String>

|

Array<Number>

Default Value: undefined

strips

Declares a collection of strips belonging to the argument axis.

Type:

Array<Object>

Cannot be used in themes.

tickInterval

Specifies the interval between major ticks.

title

Configures the axis title.

Type:

String

|

Object

type

Specifies the type of the argument axis.

Default Value: undefined

visualRange

Defines the axis' displayed range. Cannot be wider than the wholeRange.

Type:

Object

|

Array<Number | String | Date>

Raised Events: optionChanged
Cannot be used in themes.

visualRangeUpdateMode

Specifies how the axis's visual range should behave when chart data is updated.

Default Value: 'auto'

wholeRange

Defines the range where the axis can be zoomed and panned.

Type:

Object

|

Array<Number | String | Date>

Default Value: undefined

workdaysOnly

Leaves only workdays on the axis: the work week days plus single workdays minus holidays. Applies only if the axis' argumentType is "datetime".

Type:

Boolean

Default Value: false

workWeek

Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true.

Type:

Array<Number>

Default Value: [1, 2, 3, 4, 5]