# Core.PageReport

## Content

# Class: PageReport

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

PageReport class

## Table of contents

### Constructors

- [constructor](Core.PageReport#constructor)

### Properties

- [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

### <a id="constructor" name="constructor"></a> constructor

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

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

#### Parameters

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

## Properties

### <a id="name" name="name"></a> name

• `Readonly` **name**: `string`

___

### <a id="parameters" name="parameters"></a> parameters

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

___

### <a id="resourcelocator" name="resourcelocator"></a> resourceLocator

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

___

### <a id="licensekey" name="licensekey"></a> LicenseKey

▪ `Static` **LicenseKey**: `string`

## Methods

### <a id="load" name="load"></a> 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`\>

___

### <a id="run" name="run"></a> run

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

Starts rendering the report.

#### Returns

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

___

### <a id="validateparameters" name="validateparameters"></a> validateParameters

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

Validates the parameter values.

#### Returns

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

Validation result.