# Core.PageReport

## Content

# Class: PageReport

[Core](../modules/Core).PageReport

PageReport class

## Table of contents

### Constructors

- [constructor](Core.PageReport#constructor)

### Accessors

- [name](Core.PageReport#name)
- [parameters](Core.PageReport#parameters)
- [resourceLocator](Core.PageReport#resourcelocator)
- [LicenseKey](Core.PageReport#licensekey)

### Methods

- [load](Core.PageReport#load)
- [run](Core.PageReport#run)
- [validateParameters](Core.PageReport#validateparameters)

## Constructors

### constructor

• **new PageReport**(`options?`)

Create new instance of [PageReport](Core.PageReport) class.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `options?` | `Partial`<{ `i18n`: `i18n` ; `language`: `string`  }\> | pageReport options  - language: report language. Default language is 'en'. |

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:379

## Accessors

### name

• `get` **name**(): `string`

Gets the report name.

#### Returns

`string`

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:384

___

### parameters

• `get` **parameters**(): [`ReportParameters`](../modules/Core#reportparameters)

Gets the report parameters collection.

#### Returns

[`ReportParameters`](../modules/Core#reportparameters)

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:386

___

### resourceLocator

• `get` **resourceLocator**(): [`ResourceLocator`](../modules/Core#resourcelocator)

Gets the report resource locator instance.

#### Returns

[`ResourceLocator`](../modules/Core#resourcelocator)

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:388

___

### LicenseKey

• `Static` `get` **LicenseKey**(): `string`

**`deprecated`** Use setLicenseKey method instead.

#### Returns

`string`

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:390

• `Static` `set` **LicenseKey**(`value`): `void`

**`deprecated`** Use setLicenseKey method instead.

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `string` |

#### Returns

`void`

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:391

## Methods

### load

▸ **load**(`report`, `options?`): `Promise`<`void`\>

Loads the report template.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `report` | `string` \| [`Report`](../modules/Core.Rdl#report) | URI or the report template or template object. |
| `options?` | `Object` | Execution time settings. |
| `options.environment?` | [`Environment`](../modules/Core#environment) | - |
| `options.resourceLocator?` | `Partial`<[`ResourceLocator`](../modules/Core#resourcelocator)\> | - |

#### Returns

`Promise`<`void`\>

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:399

___

### run

▸ **run**(): `Promise`<[`PageDocument`](Core.PageDocument)\>

Starts rendering the report.

#### Returns

`Promise`<[`PageDocument`](Core.PageDocument)\>

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:417

___

### validateParameters

▸ **validateParameters**(): [`ValidationResults`](../modules/Core#validationresults)

Validates the parameter values.

#### Returns

[`ValidationResults`](../modules/Core#validationresults)

Validation result.

#### Defined in

node_modules/@grapecity/ar-js-pagereport/lib/ar-js-core.d.ts:406