Parameter Class
A dashboard parameter.
Declaration
export class Parameter extends TypedSerializableModel
Inherited Members
constructor
Initializes a new instance of the Parameter
class.
Declaration
constructor(
modelJson?: any,
serializer?: ModelSerializer,
_allParameters?: ko.ObservableArray<Parameter>
)
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. |
_allParameters | ObservableArray<Parameter> |
Properties
allowMultiselect Property
Specifies whether multi-selection is enabled for the current parameter.
Declaration
allowMultiselect: ko.Observable<boolean>
Property Value
Type | Description |
---|---|
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 |
---|---|
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 |
---|
Computed<boolean> |
defaultValue Property
Specifies the parameter’s value.
Declaration
defaultValue: ko.Observable<any>
Property Value
Type | Description |
---|---|
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 |
---|---|
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 |
---|---|
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 |
---|---|
Observable<DynamicListLookUpSettings> | A DynamicListLookUpSettings object that contains look-up settings for the dynamic list. |
lookUpSourceType Property
Declaration
lookUpSourceType: ko.Subscribable
Property Value
Type |
---|
Subscribable |
name Property
Specifies the parameter name.
Declaration
name: ko.Observable<string>
Property Value
Type | Description |
---|---|
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 |
---|---|
Observable<boolean> | true, to display a parameter in the Dashboard Parameters dialog; otherwise, false. |
SelectAllValue Property
Declaration
static SelectAllValue: string
Property Value
Type |
---|
string |
selectAllValues Property
Declaration
selectAllValues: ko.Observable<boolean>
Property Value
Type |
---|
Observable<boolean> |
staticListLookUpSettings Property
Specifies look-up settings for the static list.
Declaration
staticListLookUpSettings: ko.Observable<StaticListLookUpSettings>
Property Value
Type | Description |
---|---|
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 |
---|---|
Computed<string> | A string that specifies a parameter type (boolean, number, date, etc). |
Methods
getInfo Method
For internal use.
Declaration
getInfo(): ISerializationInfoArray
Returns
Type | Description |
---|---|
ISerializationInfoArray | An array of objects that provide serialization info. |
grabFrom(another) Method
Declaration
grabFrom(
another: Parameter
): void
Parameters
Name | Type |
---|---|
another | Parameter |