V1
Parameters ActiveReportsJS API Module

Parameters Module

Type aliases

NoValueType

NoValueType: undefined

Defines special value to indicate that value is not set.

ParameterDataType

ParameterDataType: "Boolean" | "String" | "Integer" | "Float" | "Date" | "DateTime"

Defines parameter data type.

ParameterDescriptor

ParameterDescriptor: object

Defines report parameter descriptor

Type declaration

  • allowBlank: boolean

    Allow blank

  • dataType: ParameterDataType

    Parameter data type

  • dependsOn: string[]

    Parameters on which parameter depends

  • multiValue: boolean

    Parameter is multivalue

  • name: string

    Parameter name

  • nullable: boolean

    Allow null

  • Optional selectAllValue?: any

    For multivalue parameter special value to indicate that all available values are selected

ParameterValue

ParameterValue: object

Defines parameter value

Type declaration

ParameterVariant

ParameterVariant: string | number | boolean | Date | null | NoValueType | SelectAllType

Type of parameter value

SelectAllType

SelectAllType: object

Defines special value for multivalue parameter to indicate that all values are set.

Type declaration

  • selectAll: "$selectAll"

ValidationResult

ValidationResult: object

Parameter validation result

Type declaration

  • isValid: boolean

    Indicates whether validation success or not.

  • Optional message?: undefined | string

    The error text in case of validation fails.

  • Optional value?: any

    New validated parameter value.

ValidationResults

ValidationResults: object

Parameters validation result

Type declaration

Variables

Const noValue

noValue: undefined

Special value to indicate that value is not set.

Const selectAll

selectAll: SelectAllType

Special value for multivalue parameter to indicate that all values are set.