[]
Core.PageReport
PageReport class
• new PageReport(options?
)
Create new instance of PageReport class.
Name | Type | Description |
---|---|---|
options? |
Partial <{ i18n : i18n ; language : string ; memoizeData : boolean }> |
pageReport options - language: report language. Default language is 'en'. |
• Readonly
name: string
• Readonly
parameters: Object
▪ [name: string
]: Parameter
• Readonly
reportParameters: ReportParameters
• Readonly
resourceLocator: ResourceLocator
• Readonly
viewSettings: ViewSettings
▪ Static
LicenseKey: string
▸ load(report
, options?
): Promise
<void
>
Loads the report template.
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 > |
- |
Promise
<void
>
▸ run(): Promise
<PageDocument
>
Starts rendering the report.
Promise
<PageDocument
>
▸ validateParameters(): ValidationResults
deprecated
use "reportsParameters.validate()" instead.
Validates the parameter values.
Validation result.