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<{ animations: Partial<{ charts: Partial<{ highlight: { enabled: boolean } ; onHover: { enabled: boolean } ; onLoad: { enabled: boolean } }> ; table: { onHover: { backgroundColor: string ; enabled: boolean ; textColor?: string } | { enabled: boolean ; textColor: string } } }> ; 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
reportParameters
• get reportParameters(): ReportParameters
Gets the report parameters api.
Returns
resourceLocator
• get resourceLocator(): ResourceLocator
Gets the report resource locator instance.
Returns
viewSettings
• get viewSettings(): ViewSettings
Returns
ViewSettings
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.reportParameters? |
{ Name: string ; Value: ParameterVariant[] }[] |
- |
options.resourceLocator? |
Partial<ResourceLocator> |
- |
Returns
Promise<void>
run
▸ run(): Promise<PageDocument>
Starts rendering the report.
Returns
Promise<PageDocument>