# 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:1678

## 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:1683

___

### 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:1685

___

### 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:1687

___

### 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:1689

• `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:1690

## Methods

### load

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

Loads the report template.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `report` | `string` \| { `Name`: `string` ; `Type`: ``"report"``  } & { `Author`: `undefined` \| `string` ; `Body`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"section"``  } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...\> \| undefined; }) \| ... 20 more ... \| ({ ...; } & { ...; }))[] \| undefined; Style?: ({} & { ...; }) \| undefin... ; `ConsumeContainerWhitespace`: `undefined` \| `boolean` ; `CustomProperties`: `undefined` \| { `Name`: `string`  } & { Value?: RDLExpr<Variant\> \| undefined; }[] ; `DataElementName`: `undefined` \| `string` ; `DataElementStyle`: `undefined` \| ``"Attribute"`` \| ``"Element"`` ; `DataSets`: `undefined` \| { `Name`: `string`  } & { Filters?: ({} & { FilterExpression?: RDLExpr<Variant\> \| undefined; Operator?: FilterOperator \| undefined; FilterValues?: RDLExpr<Variant\>[] \| undefined; })[] \| undefined; ... 6 more ...; WidthSensitivity?: ThreeStateBool \| undefined; }[] ; `DataSources`: `undefined` \| { `Name`: `string`  } & { Transaction?: boolean \| undefined; DataSourceReference?: string \| undefined; ConnectionProperties?: ({} & { Prompt?: string \| undefined; DataProvider?: string \| undefined; ConnectString?: string \| undefined; IntegratedSecurity?: boolean \| undefined; }) \| undefined; }[] ; `Description`: `undefined` \| `string` ; `DocumentMap`: `undefined` \| {} & { Levels?: string[] \| undefined; Source?: "None" \| "Labels" \| "Headings" \| "All" \| undefined; NumberingStyle?: string \| undefined; } ; `EmbeddedImages`: `undefined` \| { `Name`: `string`  } & { MIMEType?: string \| undefined; ImageData?: string \| undefined; }[] ; `FixedPage`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"fixedpage"``  } & { DataElementName?: string \| undefined; Pages?: ({ Type: "fixedpagesection"; } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; DataElementName?: string \| undefined; ... 18 more ...; Value?: RDLExpr<...\> \| undefined; }) \| ... 20 more ... \| ({ ...; } & { ...; }))[] \| undefined; S... ; `Language`: `undefined` \| `string` ; `Layers`: `undefined` \| { `Name`: `string` ; `Type`: ``"layer"``  } & { DesignerLock?: boolean \| undefined; DesignerTransparency?: number \| undefined; DesignerVisible?: boolean \| undefined; TargetDevice?: string \| undefined; }[] ; `LocalizationResources`: `undefined` \| {} & { Language?: string \| undefined; Data?: ({ Name: string; } & { Value?: RDLExpr<Variant\> \| undefined; })[] \| undefined; }[] ; `Page`: `undefined` \| {} & { BottomMargin?: string \| undefined; Columns?: number \| undefined; ColumnSpacing?: string \| undefined; LeftMargin?: string \| undefined; PageHeight?: string \| undefined; PageWidth?: string \| undefined; RightMargin?: string \| undefined; TopMargin?: string \| undefined; } ; `PageFooter`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"pagesection"``  } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...\> \| undefined; }) \| ... 20 more ... \| ({ ...; } & { ...; }))[] \| undefined; Style?: ({} & { ...; }) \| undefin... ; `PageHeader`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"pagesection"``  } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; DataElementName?: string \| undefined; DataElementStyle?: DataElementStyle \| undefined; ... 17 more ...; Value?: RDLExpr<...\> \| undefined; }) \| ... 20 more ... \| ({ ...; } & { ...; }))[] \| undefined; Style?: ({} & { ...; }) \| undefin... ; `ReportParameters`: `undefined` \| { `Name`: `string`  } & { Multiline?: boolean \| undefined; AllowBlank?: boolean \| undefined; DataType?: ReportParameterType \| undefined; DateOnly?: boolean \| undefined; DefaultValue?: ({} & { ...; }) \| ... 1 more ... \| undefined; ... 6 more ...; ValidValues?: ({} & { ...; }) \| ... 1 more ... \| undefined; }[] ; `StartPageNumber`: `undefined` \| `number` ; `ThemeUri`: `undefined` \| `string` ; `Width`: `undefined` \| `string`  } | 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:1698

___

### 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:1716

___

### 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:1705