The requested page is not available for the requested platform. You are viewing the content for Default platform.

ItemDataAxisPoint Interface

A point on the data axis.

Declaration

export interface ItemDataAxisPoint

Remarks

Each data-bound dashboard item uses a multidimensional representation of data (the ItemData class). This provides the capability to visualize information hierarchically. For instance, the pivot grid allows end-users to expand or collapse column/row field values to view data at different detail levels. The Drill-Down feature provides a common way to move between different detail levels in different dashboard items.

The value corresponding to a specific hierarchy level is stored in the ItemDataAxisPoint class that defines a data point in a multidimensional space. Such data points are placed on a specific data axis, represented by the ItemDataAxis class. For instance, the pivot grid has the "Row" and "Column" axes, the chart has the "Argument" and "Series" axes, etc.

To obtain the parent point for the current axis point, use the getParent method. The getChildren method returns the collection of child axis points.

To obtain axis point values, use the getDimensionValue method.

Methods

getAxisName Method

Declaration

getAxisName(): string

Returns

Type Description
string

getChildren Method

Declaration

getChildren(): Array<ItemDataAxisPoint>

Returns

Type Description
Array<ItemDataAxisPoint>

getDimension Method

Declaration

getDimension(): ItemDataDimension

Returns

Type Description
ItemDataDimension

getDimensionValue Method

Declaration

getDimensionValue(dimensionId?: string): ItemDataDimensionValue

Optional Parameters

Name Type Default Description
dimensionId string null

Returns

Type Description
ItemDataDimensionValue

getDimensions Method

Declaration

getDimensions(): Array<ItemDataDimension>

Returns

Type Description
Array<ItemDataDimension>

getDisplayText Method

Declaration

getDisplayText(): string

Returns

Type Description
string

getParent Method

Declaration

getParent(): ItemDataAxisPoint

Returns

Type Description
ItemDataAxisPoint

getUniqueValue Method

Declaration

getUniqueValue(): PrimitiveType

Returns

Type Description
PrimitiveType

getValue Method

Declaration

getValue(): PrimitiveType

Returns

Type Description
PrimitiveType