Skip to main content

ItemUnderlyingData Interface

Represents a list of records from the dashboard data source.

#Declaration

TypeScript
export interface ItemUnderlyingData

#Methods

#getDataMembers Method

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

#Declaration

TypeScript
getDataMembers(): Array<string>

#Returns

Type Description
string[]

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

#Remarks

See the following examples that show how to use the getDataMembers method: View Example: ASP.NET Core View Example: ASP.NET Web Forms View Example: ASP.NET MVC

#getDisplayNames Method

#Declaration

TypeScript
getDisplayNames(): Array<string>

#Returns

Type
string[]

#getRequestDataError Method

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

#Declaration

TypeScript
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

TypeScript
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

TypeScript
getRowValue(
    rowIndex: number,
    columnName: string
): DevExpress.Dashboard.Data.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

TypeScript
isDataReceived(): boolean

#Returns

Type Description
boolean

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