Skip to main content

ChartAxis Class

Serves as the base class for classes that represent chart axes.

#Declaration

TypeScript
export class ChartAxis extends SerializableModel

#Remarks

The ChartAxis class provides settings that allow you to specify the axis visibility (ChartAxis.visible) and title (ChartAxis.title).

#Inherited Members

#constructor

Initializes a new instance of the ChartAxis class.

#Declaration

TypeScript
constructor(
    JSON?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
JSON any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#numericFormat Property

Specifies the numeric display format the chart axis data uses.

#Declaration

TypeScript
numericFormat: DevExpress.Dashboard.Model.DataItemNumericFormat

#Property Value

Type Description
DataItemNumericFormat

A DataItemNumericFormat object that contains format settings for numeric values, including the precision, unit, currency, and format type.

#reverse Property

Specifies whether the axis is reversed.

#Declaration

TypeScript
reverse: ko.Observable<boolean>

#Property Value

Type Description
Observable<boolean>

true, to reverse the axis; otherwise, false.

#Remarks

If the Y-axis is reversed, its values are ordered from top to bottom.

#title Property

Specifies the title of the chart’s axis.

#Declaration

TypeScript
title: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string that specifies the title of the chart’s axis.

#Remarks

Use the titleVisible property to specify whether the title of the chart’s axis is visible.

#titleVisible Property

Specifies whether the title of the chart’s axis is visible.

#Declaration

TypeScript
titleVisible: ko.Observable<boolean>

#Property Value

Type Description
Observable<boolean>

true if the title of the chart’s axis is visible; otherwise, false.

#Remarks

Use the title property to set the axis title.

#visible Property

Specifies whether the chart’s axis is visible.

#Declaration

TypeScript
visible: ko.Observable<boolean>

#Property Value

Type Description
Observable<boolean>

true if the chart’s axis is visible; otherwise, false.

#Methods

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.