レポートの実行

PageReportクラス

PageReportクラスは、レポートテンプレート、パラメータ値、およびランタイム設定を受け取り、レポート出力を生成するためのプロパティとメソッドを提供するレポートインスタンスを表します。

PageReportクラスのコンストラクタには、3つのプロパティを持つオプションのoptions引数があります。その中に、2つは内部使用のみですが、もう一つはmemoizeDataプロパティであり、レポートデータを保存して、レポートを再実行するときに再利用するかどうかを決定します。memoizeDataプロパティをtrue（デフォルト値）に設定すると、レポートデータが保存され、レポートを再実行するときに再利用されます。これにより、データを再取得する必要が減り、パフォーマンスが向上されます。falseに設定すると、レポートデータが保存されず、レポートが実行されるたびに新しく取得されます。レポートのデータ連結が動的であり、レポートを再実行するときに変更できるパラメータ値に依存している場合、memoizeDataの値は無視されます。以下のサンプルコードは、PageReportクラスの新しいインスタンスを初期化する方法を示しています。

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport({
    memoizeData: true
});

レポートテンプレートの読み込み

PageReportクラスのloadメソッドを使用して、レポートテンプレートを設定し、レポートを実行するときに必要な環境を構成できます。loadメソッドの最初の引数は、レポートテンプレートを取得するURLまたはReport型のオブジェクトです。2番目の引数はオプションであり、いくつかのプロパティを持つオブジェクトです。

resourceLocator ：リソースロケータの実装
environment ：{&ReportName}式を使用してレポートで参照できるReportNameプロパティを持つオブジェクト。

loadメソッドは、リモートリソースからレポートテンプレートを取得するため、Promiseオブジェクトを取得します。したがって、loadメソッドを呼び出すコードは、返されたPromiseが履行されるまで待機する必要があります。次に例を示します。

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`, {
  environment: {
    ReportName: "製品カタログ",
  },
});

レポートパラメータの設定

PageReportクラスには、レポートを実行するためのパラメータ値を指定できるparametersプロパティが存在しています。parametersプロパティは、レポートパラメータの名前と一致する動的キーを持つオブジェクトです。キーはレポートパラメータの構成に関する情報を提供し、パラメータの値を設定できる記述子です。パラメータの値は数値、文字列、Bool値、または日付の配列を使用可能です。パラメータの値が1つの場合でも、配列で指定する必要があります。

以下のサンプルコードは、PageReportクラスのインスタンスを作成し、レポートテンプレートを読み込み、パラメータ値を設定します。

import {Core} from "@grapecity/activereports";

var report = new Core.PageReport();
// レポートテンプレートを読込、パラメータ値を設定する
await report.load(`assets/Products.rdlx-json`, {
    reportParameters: [{
        Name: 'Header',
        Value: ['製品リスト']  // 文字列の単一値のパラメータ
    }, {
        Name: 'SupplierIds',
        Value: [1, 2, 3] // 整数の複数の値のパラメータ
    }]
});

または、ReportParametersオブジェクトのapplyStepsメソッドを使用して、様々なシナリオでパラメータ値を設定できます。

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);

// applyStepsメソッドでパラメータ値を設定する
report.reportParameters.applySteps([
  {
    Name: "Header",
    Value: ["製品リスト"],  // 文字列の単一値のパラメータ
    Type: "Set"
  },
  {
    Name: "SupplierIds",
    Value: [1, 2, 3], // 整数の複数の値のパラメータ
    Type: "Set"
  }
]);

レポートの実行

レポートテンプレートが読み込まれ、パラメータ値が設定された後、PageReportインスタンスのrunメソッドを呼び出すことができます。これは、PageDocumentインスタンスで実行されるPromiseオブジェクトを返します。

import {Core} from "@grapecity/activereports";

const report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
report.parameters["Header"].values = ["製品リスト"];
const document = await report.run();