Skip to main content

DynamicListLookUpSettings Class

#Declaration

TypeScript
export class DynamicListLookUpSettings extends SerializableModel implements IDataSourceConsumer

#Implements

IDataSourceConsumer

#Inherited Members

#Inheritance

SerializableModel
DynamicListLookUpSettings

#constructor

Initializes a new instance of the DynamicListLookUpSettings class.

#Declaration

TypeScript
constructor(
    modelJson?: any,
    serializer?: DevExpress.Analytics.Utils.ModelSerializer
)

#Parameters

Name Type Description
modelJson any

A JSON object used for dashboard deserialization. Do not pass this parameter directly.

serializer ModelSerializer

An object used for dashboard deserialization. Do not pass this parameter directly.

#Properties

#dataMember Property

Specifies the name of the data member for the parameter values.

#Declaration

TypeScript
dataMember: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string value that is the name of the data member with the parameter values.

#Remarks

The property is only in effect for SQL and Entity Framework data sources. For SQL data sources, the data member is a query used to select a subset of data.

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

See Also

#dataSource Property

Specifies the data source for the dashboard parameter.

#Declaration

TypeScript
dataSource: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string value that is the name of the data source.

#Remarks

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

See Also

#displayMemberName Property

Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description.

#Declaration

TypeScript
displayMemberName: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string value that is the name of the data field.

#Remarks

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

#modelName Property

#Declaration

TypeScript
static modelName: string

#Property Value

Type
string

#sortByMember Property

Specifies the data member used to sort parameter values.

#Declaration

TypeScript
sortByMember: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string value that is the name of the data field.

#Remarks

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

#sortOrder Property

Specifies the sort order.

#Declaration

TypeScript
sortOrder: ko.Observable<DevExpress.Dashboard.Model.DimensionSortOrder>

#Property Value

Type Description
Observable<DimensionSortOrder>

A DimensionSortOrder value that specifies the sort order.

#Remarks

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

#valueMemberName Property

Specifies the name of the data field for the parameter values.

#Declaration

TypeScript
valueMemberName: ko.Observable<string>

#Property Value

Type Description
Observable<string>

A string value that is the name of the data field.

#Remarks

You can specify a data source as a source for dashboard parameter values. To provide access to data source values, specify the following options:

UI Settings Description API
Data Source Specifies the data source for the dashboard parameter. dataSource
Data Member Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. dataMember
Value Member Specifies the name of the data field for the parameter values. valueMemberName
Display Member (optional) Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. displayMemberName
Sort By (optional) Specifies the data member used to sort parameter values. sortByMember
Sort Order (optional) Specifies the sort order. sortOrder

Note

You cannot use an OLAP data source as the data source for a dashboard parameter.

See Also

#Methods

#equals(target) Method

#Declaration

TypeScript
equals(
    target: DynamicListLookUpSettings
): boolean

#Parameters

Name Type
target DynamicListLookUpSettings

#Returns

Type
boolean

#getInfo Method

For internal use.

#Declaration

TypeScript
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray

#Returns

Type Description
ISerializationInfoArray

An array of objects that provide serialization info.

#isPropertyDisabled(propertyName) Method

#Declaration

TypeScript
isPropertyDisabled(
    propertyName: string
): boolean

#Parameters

Name Type
propertyName string

#Returns

Type
boolean