Parameters
Namespace: Parameters
Table of contents
Type aliases
- NoValueType
- ParameterDataType
- ParameterDescriptor
- ParameterValue
- ParameterVariant
- SelectAllType
- ValidationResult
- ValidationResults
Variables
Type aliases
NoValueType
Ƭ NoValueType: typeof noValue
Defines special value to indicate that value is not set.
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4574
ParameterDataType
Ƭ ParameterDataType: "Boolean" | "String" | "Integer" | "Float" | "Date" | "DateTime"
Defines parameter data type.
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4568
ParameterDescriptor
Ƭ ParameterDescriptor: Object
Defines report parameter descriptor
Type declaration
| Name | Type | Description |
|---|---|---|
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 |
selectAllValue? |
any |
For multivalue parameter special value to indicate that all available values are selected |
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4591
ParameterValue
Ƭ ParameterValue: Object
Defines parameter value
Type declaration
| Name | Type | Description |
|---|---|---|
label |
string |
Label to display |
value |
ParameterVariant |
Value |
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4584
ParameterVariant
Ƭ ParameterVariant: string | number | boolean | Date | null | NoValueType | SelectAllType
Type of parameter value
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4580
SelectAllType
Ƭ SelectAllType: Object
Defines special value for multivalue parameter to indicate that all values are set.
Type declaration
| Name | Type |
|---|---|
selectAll |
"$selectAll" |
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4576
ValidationResult
Ƭ ValidationResult: Object
Parameter validation result
Type declaration
| Name | Type | Description |
|---|---|---|
isValid |
boolean |
Indicates whether validation success or not. |
message? |
string |
The error text in case of validation fails. |
value? |
any |
New validated parameter value. |
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:367
ValidationResults
Ƭ ValidationResults: Object
Parameters validation result
Index signature
▪ [parameter: string]: ValidationResult
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:363
Variables
noValue
• noValue: undefined
Special value to indicate that value is not set.
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4572
selectAll
• selectAll: SelectAllType
Special value for multivalue parameter to indicate that all values are set.
Defined in
node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:4570