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.

IParameterType Interface

Provides information about a report parameter type.

Declaration

interface IParameterType

Properties

defaultVal Property

Provides access to the default value for parameters of the current type.

Declaration

defaultVal: any

Property Value

Type Description
any

An object that specifies the default value.

displayValue Property

Provides access to the text displayed to end-users when creating parameters of the current type.

Declaration

displayValue: string

Property Value

Type Description
string

A string displayed to end-users.

specifics Property

Provides access to the specifics of a current parameter type.

Declaration

specifics: string

Property Value

Type Description
string

Parameter type specifics.

Remarks

The specifics property defines which icon to draw for parameters of the current type in the Field List and Expression Editor, and in which cases parameters should be available in the Filter Editor.

The following standard values are available.

  • integer;
  • float;
  • date;
  • string;
  • bool;
  • guid.

value Property

Provides access to an actual parameter type.

Declaration

value: string

Property Value

Type Description
string

A string that specifies the parameter type.

valueConverter Property

Converts the specified parameter value to the current parameter type.

Declaration

valueConverter: (val: any) => any

Property Value

Type Description
(val: any) => any

An action that converts the specified parameter value to the current parameter type.