Core.PageReport
Class: PageReport
Core.PageReport
PageReport class
Table of contents
Constructors
Accessors
Methods
Constructors
constructor
• new PageReport(options?)
Create new instance of PageReport class.
Parameters
| Name | Type | Description |
|---|---|---|
options? |
Partial<{ i18n: i18n ; language: string ; memoizeData: boolean }> |
pageReport options - language: report language. Default language is 'en'. |
Accessors
name
• get name(): string
Gets the report name.
Returns
string
parameters
• get parameters(): ReportParameters
Gets the report parameters collection.
Returns
resourceLocator
• get resourceLocator(): ResourceLocator
Gets the report resource locator instance.
Returns
LicenseKey
• Static get LicenseKey(): string
deprecated Use setLicenseKey method instead.
Returns
string
• Static set LicenseKey(value): void
deprecated Use setLicenseKey method instead.
Parameters
| Name | Type |
|---|---|
value |
string |
Returns
void
Methods
load
▸ load(report, options?): Promise<void>
Loads the report template.
Parameters
| Name | Type | Description |
|---|---|---|
report |
string | Report |
URI or the report template or template object. |
options? |
Object |
Execution time settings. |
options.environment? |
Environment |
- |
options.resourceLocator? |
Partial<ResourceLocator> |
- |
Returns
Promise<void>
run
▸ run(): Promise<PageDocument>
Starts rendering the report.
Returns
Promise<PageDocument>
validateParameters
▸ validateParameters(): ValidationResults
Validates the parameter values.
Returns
Validation result.