V1
PageReport ActiveReportsJS API Class

PageReport Class

PageReport class

Heirarchy

  • PageReport

Accessors

Constructors

Properties

Methods

Accessors

name

  • get name(): string
  • Gets the report name.

    Returns string

parameters

resourceLocator

  • get resourceLocator(): ResourceLocator
  • Gets the report resource locator instance.

    Returns ResourceLocator

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

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