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

Parameter Class

A dashboard parameter.

Declaration

export class Parameter extends TypedSerializableModel

Inheritance

constructor

Initializes a new instance of the Parameter class.

Declaration

constructor(modelJson?: any, serializer?: DxDesigner.Analytics.Utils.ModelSerializer, _allParameters?: ko.ObservableArray<Parameter>)

Optional Parameters

Name Type Default Description
modelJson any null

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

serializer DxDesigner.Analytics.Utils.ModelSerializer null

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

_allParameters ko.ObservableArray<Parameter> null

Properties

SelectAllValue Property

Declaration

static SelectAllValue: string

Property Value

Type Description
string

allowMultiselect Property

Specifies whether multi-selection is enabled for the current parameter.

Declaration

allowMultiselect: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

true, to allow end-users to select the multiple parameter values; otherwise, false.

Remarks

See Pass a Multi-Value Parameter Value to a Query for details.

The following limitations are applied to parameters with multi-selection enabled:

  • Use the is any of or is none of operators to pass a multi-select parameter to a filter criteria or to the Expression format condition.
  • Use the In or Not In operators to pass a multi-select parameter to a calculated field expression.
  • Custom SQL queries do not support multi-select parameters.
  • Stored procedures used in SQL and Entity Framework data sources do not support multi-select parameters.

allowNull Property

Specifies whether a null value can be passed as a parameter value.

Declaration

allowNull: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

true, to allow passing a null value as a parameter value; otherwise, false.

containsDisplayMember Property

Declaration

containsDisplayMember: ko.Computed<boolean>

Property Value

Type Description
ko.Computed<boolean>

defaultValue Property

Specifies the parameter's value.

Declaration

defaultValue: ko.Observable<any>

Property Value

Type Description
ko.Observable<any>

An array of parameter values.

Remarks

You can select multiple parameter values when the allowMultiselect is set to true.

For static and dynamic lists, use the defaultValues property.

defaultValues Property

Specifies the default parameter values for static and dynamic lists.

Declaration

defaultValues: ko.ObservableArray<LookUpValue>

Property Value

Type Description
ko.ObservableArray<LookUpValue>

An array of LookUpValue values.

Remarks

Enable the allowMultiselect property to select multiple values.

description Property

Specifies the parameter's description displayed to an end-user.

Declaration

description: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

A string that contains the parameter's description displayed to an end-user.

Remarks

The parameter's description is the value displayed in the Parameter Name column of the Dashboard Parameters dialog.

dynamicListLookUpSettings Property

Specifies look-up settings for the dynamic list.

Declaration

dynamicListLookUpSettings: ko.Observable<DynamicListLookUpSettings>

Property Value

Type Description
ko.Observable<DynamicListLookUpSettings>

A DynamicListLookUpSettings object that contains look-up settings for the dynamic list.

lookUpSourceType Property

Declaration

lookUpSourceType: ko.Subscribable

Property Value

Type Description
ko.Subscribable

name Property

Specifies the parameter name.

Declaration

name: ko.Observable<string>

Property Value

Type Description
ko.Observable<string>

A string that contains the parameter name.

Remarks

When creating and modifying parameter names, follow the rules below:

  • A name can contain letters, numbers and underscores.
  • A name cannot contain spaces.
  • A name cannot be an empty string.
  • The dashboard cannot contain parameters with the same name.
  • Names are case-sensitive. For example, you can create the names Parameter and PARAMETER.

parameterVisible Property

Specifies whether the parameter is visible in the Dashboard Parameters dialog.

Declaration

parameterVisible: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

true, to display a parameter in the Dashboard Parameters dialog; otherwise, false.

selectAllValues Property

Declaration

selectAllValues: ko.Observable<boolean>

Property Value

Type Description
ko.Observable<boolean>

staticListLookUpSettings Property

Specifies look-up settings for the static list.

Declaration

staticListLookUpSettings: ko.Observable<StaticListLookUpSettings>

Property Value

Type Description
ko.Observable<StaticListLookUpSettings>

A StaticListLookUpSettings object that contains look-up settings for the static list.

type Property

Specifies a parameter type.

Declaration

type: ko.Computed<string>

Property Value

Type Description
ko.Computed<string>

A string that specifies a parameter type (boolean, number, date, etc).

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationInfoArray

Returns

Type Description
DxDesigner.Analytics.Utils.ISerializationInfoArray

 

grabFrom(another) Method

Declaration

grabFrom(another: Parameter): void

Parameters

Name Type Description
another Parameter

isPropertyDisabled(propertyName) Method

Declaration

isPropertyDisabled(propertyName: string): boolean

Parameters

Name Type Description
propertyName string

Returns

Type Description
boolean

isPropertyVisible(propertyName) Method

Declaration

isPropertyVisible(propertyName: string): boolean

Parameters

Name Type Description
propertyName string

Returns

Type Description
boolean