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

ItemData Interface

Multidimensional data visualized in the dashboard item.

Declaration

export interface ItemData

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. Use the getItemData(itemName) method to obtain multidimensional data visualized in the specified dashboard item.

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 that is represented by the ItemDataAxis class. For instance, a pivot grid has the "Row" and "Column" axes, a chart has the "Argument" and "Series" axes, etc.

Use the following methods to access the displayed data.

  • The getAxisNames property returns the names of available data axes. You can obtain the required axis using the getAxis(axisName) method.
  • Use the getPoints method to obtain the axis points that are placed on the obtained data axis.
  • Obtain the dimension value using the getDimensionValue method.

Methods

createTuple(values) Method

Declaration

createTuple(values: Array<ItemDataAxisPoint> | Array<{
    axisName: ItemDataAxisName;
    value: Array<PrimitiveType>;
}>): ItemDataAxisPointTuple

Parameters

Name Type Description
values Array<ItemDataAxisPoint> | Array<{axisName: ItemDataAxisName, value: Array<PrimitiveType>}>

Returns

Type Description
ItemDataAxisPointTuple

getAxis(axisName) Method

Declaration

getAxis(axisName: ItemDataAxisName): ItemDataAxis

Parameters

Name Type Description
axisName ItemDataAxisName

Returns

Type Description
ItemDataAxis

getAxisNames Method

Declaration

getAxisNames(): Array<ItemDataAxisName>

Returns

Type Description
Array<ItemDataAxisName>

getDataMembers Method

Declaration

getDataMembers(): Array<string>

Returns

Type Description
Array<string>

getDeltaValue(deltaId) Method

Declaration

getDeltaValue(deltaId: string): ItemDataDeltaValue

Parameters

Name Type Description
deltaId string

Returns

Type Description
ItemDataDeltaValue

getDeltas Method

Declaration

getDeltas(): Array<ItemDataDelta>

Returns

Type Description
Array<ItemDataDelta>

getDimensions(axisName) Method

Declaration

getDimensions(axisName: ItemDataAxisName): Array<ItemDataDimension>

Parameters

Name Type Description
axisName ItemDataAxisName

Returns

Type Description
Array<ItemDataDimension>

getMeasureValue(measureId) Method

Declaration

getMeasureValue(measureId: string): ItemDataMeasureValue

Parameters

Name Type Description
measureId string

Returns

Type Description
ItemDataMeasureValue

getMeasures Method

Declaration

getMeasures(): Array<ItemDataMeasure>

Returns

Type Description
Array<ItemDataMeasure>

getSlice(value) Method

Declaration

getSlice(value: ItemDataAxisPointTuple | ItemDataAxisPoint): ItemData

Parameters

Name Type Description
value ItemDataAxisPointTuple | ItemDataAxisPoint

Returns

Type Description
ItemData