V1
PageReport ActiveReportsJS API Class

PageReport Class

PageReport class

Heirarchy

  • PageReport

Constructors

constructor

  • new PageReport(options?: Partial<object>): PageReport
  • Create new instance of PageReport class.

    Parameters

    • Optional options: Partial<object>

      pageReport options

      - language: report language. Default language is 'en'.

    Returns PageReport

Properties

name

name: string

Gets the report name.

parameters

parameters: ReportParameters

Gets the report parameters collection.

resourceLocator

resourceLocator: ResourceLocator

Gets the report resource locator instance.

Static LicenseKey

LicenseKey: string

ARJS license key

Methods

load

  • load(report: string | RDLReportDefinition, options?: undefined | object): Promise<void>
  • Loads the report template.

    Parameters

    • report: string | RDLReportDefinition

      URI or the report template or template object.

    • Optional options: undefined | object

      Execution time settings.

    Returns Promise<void>

run

  • Starts rendering the report.

    Returns Promise<PageDocument>

validateParameters