Skip to main content

IParameterDescriptor Interface

Provides information about a report parameter.

Declaration

export interface IParameterDescriptor

Properties

allowNull Property

Specifies whether the parameter’s value can be unspecified.

Declaration

allowNull?: boolean

Property Value

Type Description
boolean

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

description Property

Specifies the parameter description.

Declaration

description: string

Property Value

Type Description
string

The parameter description.

enabled Property

Declaration

enabled: boolean

Property Value

Type
boolean

multiValue Property

Specifies whether a parameter can have multiple values.

Declaration

multiValue?: boolean

Property Value

Type Description
boolean

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

name Property

Specifies the parameter name.

Declaration

name: string

Property Value

Type Description
string

The parameter name.

selectAllValues Property

Declaration

selectAllValues?: boolean

Property Value

Type
boolean

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: string

Property Value

Type Description
string

The report parameter type.

value Property

Specifies the current value of a report parameter.

Declaration

value: any

Property Value

Type Description
any

The current value of a report parameter.

visible Property

Specifies the parameter’s visibility state.

Declaration

visible: boolean

Property Value

Type Description
boolean

true if the parameter is visible; otherwise false.