# Core.PageReport

## Content

# Class: PageReport

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

PageReport class

## Table of contents

### Constructors

- [constructor](Core.PageReport#constructor)

### Properties

- [LicenseKey](Core.PageReport#licensekey)

### Accessors

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

### 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/types/ar-js-core.d.ts:118

## Properties

### LicenseKey

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

ARJS license key

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:129

## Accessors

### name

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

Gets the report name.

#### Returns

`string`

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:123

___

### 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/types/ar-js-core.d.ts:125

___

### resourceLocator

• `get` **resourceLocator**(): `ResourceLocator`

Gets the report resource locator instance.

#### Returns

`ResourceLocator`

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:127

## 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; Language?: string \| undefined; DataElementName?: string \| undefined; Style?: ({} & { Language?: string \| undefined; ... 30 more ...; MinCondenseRate?: RDLExpr<...\> \| undefined; }) \| undefined; ... 16 more ...; UserSort?: ({} & { ...... ; `ConsumeContainerWhitespace`: `undefined` \| `boolean` ; `CustomProperties`: `undefined` \| { `Name`: `string`  } & { Value?: RDLExpr<RDLVariant\> \| undefined; }[] ; `DataElementName`: `undefined` \| `string` ; `DataElementStyle`: `undefined` \| `RDLDataElementStyle` ; `DataSets`: `undefined` \| { `Name`: `string`  } & { Filters?: ({} & { FilterExpression?: RDLExpr<RDLVariant\> \| undefined; Operator?: RDLFilterOperator \| undefined; FilterValues?: RDLExpr<RDLVariant\>[] \| undefined; })[] \| undefined; Fields?: ({ ...; } & { ...; })[] \| undefined; Query?: ({} & { ...; }) \| undefined; }[] ; `DataSources`: `undefined` \| { `Name`: `string`  } & { Transaction?: boolean \| undefined; DataSourceReference?: string \| undefined; ConnectionProperties?: ({} & { DataProvider?: string \| undefined; ConnectString?: string \| undefined; ... 4 more ...; WidthSensivity?: "Auto" \| ... 2 more ... \| 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"``  } & { Pages?: ({ Type: "fixedpagesection"; } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; ... 17 more ...; UserSort?: ({} & { ...; }) \| undefined; }) \| ... 18 more ... \| ({ ...; } & { ...; }))[] \| undefined; St... ; `Language`: `undefined` \| `string` ; `LocalizationResources`: `undefined` \| {} & { Language?: string \| undefined; Data?: ({ Name: string; } & { Value?: RDLExpr<RDLVariant\> \| undefined; })[] \| undefined; }[] ; `Page`: `undefined` \| {} & { Style?: ({} & { [x: string]: any; [x: number]: any; }) \| undefined; PageHeight?: string \| undefined; PageWidth?: string \| undefined; LeftMargin?: string \| undefined; RightMargin?: string \| undefined; TopMargin?: string \| undefined; BottomMargin?: string \| undefined; Columns?: number \| undefined; ColumnSpacing?: st... ; `PageFooter`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"pagesection"``  } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; Style?: ({} & { Language?: string \| undefined; ... 30 more ...; MinCondenseRate?: RDLExpr<...\> \| undefined; }) \| undefined; ... 16 more ...; UserSort?: ({} & { ...... ; `PageHeader`: `undefined` \| ``null`` \| { `Name`: `string` ; `Type`: ``"pagesection"``  } & { ReportItems?: (({ Type: "textbox"; Name: string; } & { Width?: string \| undefined; Language?: string \| undefined; DataElementName?: string \| undefined; Style?: ({} & { Language?: string \| undefined; ... 30 more ...; MinCondenseRate?: RDLExpr<...\> \| undefined; }) \| undefined; ... 16 more ...; UserSort?: ({} & { ...... ; `ReportParameters`: `undefined` \| { `Name`: `string`  } & { Multiline?: boolean \| undefined; DataType?: RDLReportParameterType \| undefined; Nullable?: boolean \| undefined; DefaultValue?: ({} & { Values?: ({} & { ...; }) \| undefined; DataSetReference?: ({} & { ...; }) \| undefined; }) \| undefined; ... 6 more ...; SelectAllValue?: RDLExpr<...\> \| 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` | - |
| `options.resourceLocator?` | `Partial`<`ResourceLocator`\> | - |

#### Returns

`Promise`<`void`\>

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:134

___

### run

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

Starts rendering the report.

#### Returns

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

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:145

___

### validateParameters

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

Validates the parameter values.

#### Returns

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

Validation result.

#### Defined in

node_modules/@grapecity/ar-js-pagereport/types/ar-js-core.d.ts:141