# ReportViewer.CancellationToken

## Content

# Class: CancellationToken

[ReportViewer](../modules/ReportViewer).CancellationToken

Cancellation token.

## Table of contents

### Properties

- [parentToken](ReportViewer.CancellationToken#parenttoken)

### Accessors

- [isCancellationRequested](ReportViewer.CancellationToken#iscancellationrequested)
- [promise](ReportViewer.CancellationToken#promise)

### Methods

- [register](ReportViewer.CancellationToken#register)
- [create](ReportViewer.CancellationToken#create)

## Properties

### parentToken

• `Optional` `Readonly` **parentToken**: [`CancellationToken`](ReportViewer.CancellationToken)

The parent token

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:191

## Accessors

### isCancellationRequested

• `get` **isCancellationRequested**(): `boolean`

Gets true if cancellation is being requested.

#### Returns

`boolean`

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:204

___

### promise

• `get` **promise**(): `Promise`<`any`\>

Gets a promise that is triggered when cancellation is requested.

#### Returns

`Promise`<`any`\>

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:208

## Methods

### register

▸ **register**(`callback`): `void`

Registers a new cancellation handler. Handler is invoked when cancellation is requested.

#### Parameters

| Name | Type |
| :------ | :------ |
| `callback` | (`reason`: `any`) => `any` |

#### Returns

`void`

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:213

___

### create

▸ `Static` **create**(`parentToken?`): `Object`

Creates a cancellation token and trigger function.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `parentToken?` | [`CancellationToken`](ReportViewer.CancellationToken) | The parent token. |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `token` | [`CancellationToken`](ReportViewer.CancellationToken) |
| `cancel` | (`e`: `any`) => `void` |

#### Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:197