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

Gets the name of the axis to which the current axis point belongs.

Declaration

getAxisName(): string

Returns

Type Description
string

A string that in the name of the axis.

getChildren Method

Gets the child axis points for the current axis point.

Declaration

getChildren(): Array<ItemDataAxisPoint>

Returns

Type Description
Array<ItemDataAxisPoint>

An array of ItemDataAxisPoint objects that are child axis points.

getDimension Method

Gets the last level dimension corresponding to the current axis point.

Declaration

getDimension(): ItemDataDimension

Returns

Type Description
ItemDataDimension

An ItemDataDimension object that contains the dimension metadata.

getDimensions Method

Gets the collection of dimensions used to create a hierarchy of axis points from the root point to the current axis point.

Declaration

getDimensions(): Array<ItemDataDimension>

Returns

Type Description
Array<ItemDataDimension>

An array of ItemDataDimension objects that contain the dimension metadata.

getDimensionValue Method

Gets the dimension values at the specified axis point.

Declaration

getDimensionValue(
    dimensionId?: string
): ItemDataDimensionValue

Parameters

Name Type Description
dimensionId string

A string that is the dimension’s unique identifier.

Returns

Type Description
ItemDataDimensionValue

An ItemDataDimensionValue object that contains the dimension values at the specified axis point.

getDisplayText Method

Gets the display text corresponding to the current axis point.

Declaration

getDisplayText(): string

Returns

Type Description
string

A string that is the display text corresponding to the current axis point.

getParent Method

Gets the parent axis point for the current axis point.

Declaration

getParent(): ItemDataAxisPoint

Returns

Type Description
ItemDataAxisPoint

An ItemDataAxisPoint objectthat is the parent axis point.

getUniqueValue Method

Gets the unique value corresponding to the current axis point.

Declaration

getUniqueValue(): PrimitiveType

Returns

Type Description
PrimitiveType

The unique value corresponding to the current axis point.

getValue Method

Gets the value corresponding to the current axis point.

Declaration

getValue(): PrimitiveType

Returns

Type Description
PrimitiveType

The value corresponding to the current axis point.