Core.PageReport
クラス: PageReport
Core.PageReport
PageReport クラス。
Table of contents
コンストラクタ
プロパティ
メソッド
コンストラクタ
constructor
• new PageReport(options?)
PageReportクラスの新しいインスタンスを作成します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
options? |
Partial<{ i18n: i18n ; language: string ; memoizeData: boolean }> |
pageReportオプション - 言語：レポートの言語。デフォルトの言語は「en」です。 |
プロパティ
name
• Readonly name: string
parameters
• Readonly parameters: Object
Index signature
▪ [name: string]: Parameter
reportParameters
• Readonly reportParameters: ReportParameters
resourceLocator
• Readonly resourceLocator: ResourceLocator
viewSettings
• Readonly viewSettings: ViewSettings
LicenseKey
▪ Static LicenseKey: string
メソッド
load
▸ load(report, options?): Promise<void>
レポートテンプレートをロードします。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
report |
string | Report |
URI、レポートテンプレートまたはテンプレートオブジェクト。 |
options? |
Object |
実行時間の設定。 |
options.environment? |
Environment |
- |
options.reportParameters? |
{ Name: string ; Value: ParameterVariant[] }[] |
- |
options.resourceLocator? |
Partial<ResourceLocator> |
- |
戻り値
Promise<void>
run
▸ run(): Promise<PageDocument>
レポート処理を開始します。
戻り値
Promise<PageDocument>
validateParameters
▸ validateParameters(): ValidationResults
deprecated 廃止されました。代替としてreportsParameters.validateメソッドを使用できます。パラメータ値を検証します。
戻り値
検証結果。