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

ItemUnderlyingData Interface

Represents a list of records from the dashboard data source.

Declaration

export interface ItemUnderlyingData

Methods

getDataMembers Method

Returns an array of data members available in a data source.

Declaration

getDataMembers(): Array<string>

Returns

Type Description
Array<string>

An array of string values that represent data members available in a data source.

getRequestDataError Method

Returns a callstack containing the error caused by an unsuccessful request for underlying data.

Declaration

getRequestDataError(): string

Returns

Type Description
string

A string representing a callstack containing the error caused by an unsuccessful request for underlying data.

getRowCount Method

Gets the number of rows in the underlying data set.

Declaration

getRowCount(): number

Returns

Type Description
number

An integer value that specifies the number of rows in the underlying data set.

getRowValue(rowIndex, columnName) Method

Returns the value of the specified cell within the underlying data set.

Declaration

getRowValue(rowIndex: number, columnName: string): PrimitiveType

Parameters

Name Type Description
rowIndex number

An integer value that specifies the zero-based index of the required row.

columnName string

A string that specifies the required column's name.

Returns

Type Description
PrimitiveType

An object that represents the value of the specified cell

isDataReceived Method

Returns whether a request for underlying data was successful.

Declaration

isDataReceived(): boolean

Returns

Type Description
boolean

true, if the request for underlying data was successful; otherwise, false.