Core.PageReport
Class: PageReport
Core.PageReport
PageReport class
Table of contents
Constructors
Properties
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'. |
Properties
name
• Readonly
name: string
parameters
• Readonly
parameters: ReportParameters
resourceLocator
• Readonly
resourceLocator: ResourceLocator
LicenseKey
▪ Static
LicenseKey: string
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.
Feedback
Submit and view feedback for