変更点

非推奨に変更されたメソッド

ActiveReportsJSの「V4J」より、レポートパラメータのデフォルト値をプログラムで設定、検証、解決するための新しいAPIが導入されました。これにより、既存のAPIが廃止されたので、次のリリースするメジャーバージョンから廃止する予定です。以下は、V4Jで非推奨に変更されたメンバと、その代わりに使用できるメンバを紹介します。

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

レポートパラメータをプログラムで制御する際のプロパティが変更されました。旧バージョンでは、次のようにPageReportクラスのparametersプロパティを使用して、レポートパラメータを設定していました。

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

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
report.parameters["Header"].values = ["製品リスト"]; // 文字列の単一値パラメータ
report.parameters["SupplierIds"].values = [1,2,3]; // 整の数多値パラメータ

「V4J」では、parametersプロパティが非推奨に変更され、代わりに次のいずれかの方法を使用します。

方法1：レポートパラメータをloadメソッドに渡す

loadメソッドのオプションを使用してレポートパラメータを設定することができます。

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]
    }]
});

方法2：reportParametersオブジェクトのapplyStepsメソッドを使用する

PageReportクラスのreportParametersオブジェクトのapplyStepsメソッドを使用して、様々なシナリオでレポートパラメータを設定できるようになりました。

var report = new Core.PageReport();
await report.load(`assets/Products.rdlx-json`);
report.reportParameters.applySteps([
  {
    Name: "Header",
    Value: "製品リスト",
    Type: "Set",
  },
  {
    Name: "SupplierIds",
    Value: [1, 2, 3],
    Type: "Set",
  },
]);

レポートパラメータのデフォルト値の問題対応

旧バージョンでは、レポートパラメータにデフォルト値がある場合、レポートをエクスポートする前にPageReportクラスのresolveParametersValuesメソッドを呼び出す必要がありました。「V4J」では、このメソッドが廃止され、デフォルト値は自動的に解決されるようになりました。

レポートパラメータの検証

PageReportクラスのvalidateParametersメソッドが廃止されました。代わりに、reportParametersオブジェクトのvalidateメソッドを使用できるようになりました。

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]
    }]
});
const validationResult = report.reportParameters.validate();
if(!validationResult['SupplierIds'].isValid)
  console.log('Invalid SupplierIds value: ', validationResult['SupplierIds'].message);

サポート終了する対応JSフレームワーク

ActiveReportsJSの「V4J」より、サポートする対応JSフレームワークより以下のバージョンが削除されます。

• Angular（11～12）

日付型データの和暦変換方法

ActiveReportsJSの「V3J」より、日付型データの取り扱い方法が変更されました。日付型データを和暦で表示する場合は各コントロールのインターナショナルカテゴリにある言語プロパティに'Japanese - Japan'を設定する必要があります。

IE11サポートの終了

ActiveReportsJSの「V3J」より、サポート環境よりInternet Explorer11が削除されます。それに伴いJSライブラリとして配布していた「 ie-polyfills.js 」ファイルが削除されました。

サポート終了する対応JSフレームワーク

ActiveReportsJSの「V3J」より、サポートする対応JSフレームワークより以下のバージョンが削除されます。

• Angular（8～10）

  ※Angular 7はV2.1J（v2.1.3）まで対応。V2.2J（v2.2.1）以降は未対応。

ビューワの初期化

ActiveReportsJSの「V1J」では、次のコードを使用してビューワのインスタンスを初期化できましたが、「V2J」では構造が変更され、初期化できなくなりました。

import { Viewer } from "@grapecity/activereports/viewer"
const viewer = new Viewer("#viewer-host");

const viewer = new GC.ActiveReports.Viewer.Viewer("#viewer-host");

const viewer = ActiveReports.Viewer("#viewer-host");

「v2J」では、次のようにコードを記述する必要があります。

import { Viewer } from '@grapecity/activereports/reportviewer';
const viewer = new Viewer("#viewer-host");

const viewer = new GC.ActiveReports.ReportViewer.Viewer("#viewer-host");

const viewer = new ActiveReports.Viewer("#viewer-host"); 

ビューワのスタイルシート

ビューワの表示に必要なスタイルシートが、2つ（ar-js-ui.css、ar-js-viewer.css）に変更されました。詳細については、 テーマ を参照してください。

将来的に廃止されるメソッド

以下のAPIが次のリリースするメジャーバージョンから廃止される予定です。

• Core.PageReport.LicenseKeyメソッド: 代替としてCore.setLicenseKeyメソッドを使用できます。詳細についてはライセンスを参照してください。

• Core.registerFontメソッド: 代替としてCore.FontStore.registerFontsメソッドを使用できます。詳細については、フォント登録 を参照してください。

• Viewer.registerFontメソッド: 代替としてCore.FontStore.registerFontsメソッドを使用できます。詳細については、フォント登録 を参照してください。

• registerPdfFontメソッド: 代替としてCore.FontStore.registerFontsメソッドを使用できます。詳細については、フォント登録 を参照してください。