Parameter Class

Declaration

export class Parameter extends TypedSerializableModel

Inherited Members

itemType

constructor

Initializes a new instance of the Parameter class.

Declaration

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

Parameters

Name	Type	Description
modelJson	any	A JSON object used for a dashboard deserialization. Do not pass this parameter directly.
serializer	DxDesigner.Analytics.Utils.ModelSerializer	An object used for a dashboard deserialization. Do not pass this parameter directly.
_allParameters	KnockoutObservableArray<Parameter>

Properties

allowMultiselect Property

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

Declaration

allowMultiselect: KnockoutObservable<boolean>

Property Value

Type	Description
KnockoutObservable<boolean>	true, to allow end-users to use the multiple parameter values; otherwise, false.

Remarks

To learn more, see Pass a Multi-Value Parameter Value to a Query.

allowNull Property

Declaration

allowNull: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

containsDisplayMember Property

Declaration

containsDisplayMember: KnockoutComputed<boolean>

Property Value

Type
KnockoutComputed<boolean>

defaultValue Property

Declaration

defaultValue: KnockoutObservable<any>

Property Value

Type
KnockoutObservable<any>

defaultValues Property

Declaration

defaultValues: KnockoutObservableArray<LookUpValue>

Property Value

Type
KnockoutObservableArray<LookUpValue>

description Property

Declaration

description: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

dynamicListLookUpSettings Property

Declaration

dynamicListLookUpSettings: KnockoutObservable<DynamicListLookUpSettings>

Property Value

Type
KnockoutObservable<DynamicListLookUpSettings>

lookUpSourceType Property

Declaration

lookUpSourceType: KnockoutObservable<"None" | "StaticListLookUpSettings" | "DynamicListLookUpSettings">

Property Value

Type
" altProperty="fullName" displayProperty="name" />

name Property

Declaration

name: KnockoutObservable<string>

Property Value

Type
KnockoutObservable<string>

parameterVisible Property

Declaration

parameterVisible: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

SelectAllValue Property

Declaration

static SelectAllValue: string

Property Value

Type
string

selectAllValues Property

Declaration

selectAllValues: KnockoutObservable<boolean>

Property Value

Type
KnockoutObservable<boolean>

staticListLookUpSettings Property

Declaration

staticListLookUpSettings: KnockoutObservable<StaticListLookUpSettings>

Property Value

Type
KnockoutObservable<StaticListLookUpSettings>

type Property

Declaration

type: KnockoutComputed<string>

Property Value

Type
KnockoutComputed<string>

Methods

getInfo Method

For internal use.

Declaration

getInfo(): DxDesigner.Analytics.Utils.ISerializationsInfo

Returns

Type	Description
DxDesigner.Analytics.Utils.ISerializationsInfo

grabFrom(another) Method

Declaration

grabFrom(
    another: Parameter
): void

Parameters

Name	Type
another	Parameter

isPropertyDisabled(propertyName) Method

Declaration

isPropertyDisabled(
    propertyName: string
): boolean

Parameters

Name	Type
propertyName	string

Returns

Type
boolean

isPropertyVisible(propertyName) Method

Declaration

isPropertyVisible(
    propertyName: string
): boolean

Parameters

Name	Type
propertyName	string

Returns

Type
boolean