# Parameters

## Content

# Namespace: Parameters

## Table of contents

### Type aliases

- [NoValueType](Parameters#novaluetype)
- [ParameterDataType](Parameters#parameterdatatype)
- [ParameterDescriptor](Parameters#parameterdescriptor)
- [ParameterValue](Parameters#parametervalue)
- [ParameterVariant](Parameters#parametervariant)
- [SelectAllType](Parameters#selectalltype)
- [ValidationResult](Parameters#validationresult)
- [ValidationResults](Parameters#validationresults)

### Variables

- [noValue](Parameters#novalue)
- [selectAll](Parameters#selectall)

## Type aliases

### NoValueType

Ƭ **NoValueType**: typeof [`noValue`](Parameters#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`](Parameters#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`](Parameters#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`](Parameters#novaluetype) \| [`SelectAllType`](Parameters#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`](Parameters#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`](Parameters#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