The requested page is not available for the requested platform. You are viewing the content for Default platform.
All docs
V19.1
19.2 (EAP/Beta)
19.1
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

IParameter Interface

Provides a report parameter's model.

Declaration

interface IParameter

Properties

allowNull Property

Specifies whether the parameter's value can be unspecified.

Declaration

allowNull: any

Property Value

Type Description
any

true, to allow the parameter to be unspecified; otherwise, false.

getParameterDescriptor Property

Returns an object that provides general information about a report parameter.

Declaration

getParameterDescriptor: () => IParameterDescriptor

Property Value

Type Description
() => IParameterDescriptor

An object storing report parameter information.

isMultiValue Property

Specifies whether a parameter can have multiple values.

Declaration

isMultiValue: any

Property Value

Type Description
any

true, if a parameter can have multiple values; otherwise, false.

tag Property

Specifies data about the report parameter.

Declaration

tag?: any

Property Value

Type Description
any

Data about the report parameter.

type Property

Specifies a report parameter's value type.

Declaration

type: any

Property Value

Type Description
any

The report parameter type.

value Property

Specifies the current value of a report parameter.

Declaration

value: ko.Observable | ko.Computed

Property Value

Type Description
ko.Observable
ko.Computed