DynamicListLookUpSettings Class
#Declaration
export class DynamicListLookUpSettings extends SerializableModel implements IDataSourceConsumer
#Implements
#Inheritance
#constructor
Initializes a new instance of the DynamicListLookUpSettings
class.
#Declaration
constructor(
modelJson?: any,
serializer?: DevExpress.Analytics.Utils.ModelSerializer
)
#Parameters
Name | Type | Description |
---|---|---|
model |
any | A JSON object used for dashboard deserialization. Do not pass this parameter directly. |
serializer | Model |
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
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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
#dataSource Property
Specifies the data source for the dashboard parameter.
#Declaration
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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
#displayMemberName Property
Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description.
#Declaration
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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
#modelName Property
#Declaration
static modelName: string
#Property Value
Type |
---|
string |
#sortByMember Property
Specifies the data member used to sort parameter values.
#Declaration
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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
#sortOrder Property
Specifies the sort order.
#Declaration
sortOrder: ko.Observable<DevExpress.Dashboard.Model.DimensionSortOrder>
#Property Value
Type | Description |
---|---|
Observable<Dimension |
A Dimension |
#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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
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
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. | data |
Data Member | Specifies the name of the data member with the parameter values for SQL and Entity Framework data sources. | data |
Value Member | Specifies the name of the data field for the parameter values. | value |
Display Member (optional) | Specifies the name of the data field displayed in the Dashboard Parameters dialog as a value description. | display |
Sort By (optional) | Specifies the data member used to sort parameter values. | sort |
Sort Order (optional) | Specifies the sort order. | sort |
Note
You cannot use an OLAP data source as the data source for a dashboard parameter.
#Methods
#equals(target) Method
#Declaration
equals(
target: DynamicListLookUpSettings
): boolean
#Parameters
Name | Type |
---|---|
target | Dynamic |
#Returns
Type |
---|
boolean |
#getInfo Method
For internal use.
#Declaration
getInfo(): DevExpress.Analytics.Utils.ISerializationInfoArray
#Returns
Type | Description |
---|---|
ISerialization |
An array of objects that provide serialization info. |
#isPropertyDisabled(propertyName) Method
#Declaration
isPropertyDisabled(
propertyName: string
): boolean
#Parameters
Name | Type |
---|---|
property |
string |
#Returns
Type |
---|
boolean |