メインコンテンツまでスキップ
バージョン: 2.0

2.0.0 へのアップグレード

このガイドでは、Reveal SDK 2.0 で導入された破壊的変更と、既存の 1.x アプリケーションを 2.0 にアップグレードするために必要な手順について説明します。

1.8.4 より前のバージョンをお使いですか?

まず 1.x アップグレード ガイド (1.8.4 ドキュメント) に従ってプロジェクトを 1.8.4 にアップグレードしてから、このページに戻って 2.0 への移行を完了してください。

破壊的変更の概要​

  • jQuery と Day.js の削除 — SDK は jQuery と Day.js に依存しなくなりました。
  • NPM 配信 — クライアント SDK は npm パッケージとして配信されるようになりました。レガシーなスクリプトタグによる配信は推奨されなくなりました。
  • $.ig と RevealApi 名前空間の削除 — すべての型は reveal-sdk npm パッケージから直接インポートするようになりました。$.ig.ClassName および RevealApi.ClassName を直接インポートに置き換えてください (例: import { ClassName } from "reveal-sdk")。
  • API の名前変更と削除
    • DateFilter - 削除 RevealView、RVDashboard、ExportOptionsBase から非推奨プロパティを削除
    • Reveal.Sdk.Dashboard.ToJsonStringAsync - 名前変更 ToJsonString に変更。
  • 非推奨の型 — RVDashboardThumbnailView は非推奨になりました。RVThumbnail を使用してください。

アップグレード手順​

1. jQuery を削除する​

Reveal SDK は jQuery を必要としなくなりました。SDK のためにロードしていた jQuery のスクリプトタグを削除してください:

<!-- この行を削除 -->
<script src="https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.min.js"></script>
備考

アプリケーション自体のコードが jQuery に依存している場合はそのまま使用できます — Reveal SDK が jQuery を必要としなくなっただけです。

また、古いバージョンから残っている Day.js、Quill.js、Spectrum.js も削除してください:

<!-- これらがある場合は削除 -->
<link href="https://cdnjs.cloudflare.com/ajax/libs/spectrum/1.8.0/spectrum.min.css" rel="stylesheet" type="text/css" >
<script src="https://cdnjs.cloudflare.com/ajax/libs/spectrum/1.8.0/spectrum.min.js"></script>
<link href="https://cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet" type="text/css" >
<script src="https://cdn.quilljs.com/1.3.6/quill.min.js"></script>
<script src="https://unpkg.com/dayjs@1.8.21/dayjs.min.js"></script>

2. クライアント SDK を NPM に切り替える​

レガシーなスクリプトタグによるインストールを npm パッケージに置き換えます。

<script src="https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.min.js"></script>
<script src="https://unpkg.com/dayjs@1.8.21/dayjs.min.js"></script>
<script src="https://dl.revealbi.io/reveal/libs/1.8.4/infragistics.reveal.js"></script>
スクリプトタグが必要ですか?

バンドラーを使用しない環境向けに SDK 配布 zip は引き続き利用可能ですが、jQuery と Day.js は不要になりました:

<script src="./assets/reveal/reveal-sdk.js"></script>

3. サーバー SDK パッケージを更新する​

Reveal.Sdk.* NuGet パッケージをバージョン 2.0.0 以降に更新します。

<PackageReference Include="Reveal.Sdk.AspNetCore" Version="2.0.0" />

4. API の使用方法を更新する​

$.ig / RevealApi → 直接インポート​

$.ig と RevealApi のグローバル名前空間は削除されました。すべての型は reveal-sdk npm パッケージから直接インポートするようになりました。TypeScript で infragistics.reveal.d.ts を使用して IntelliSense を利用していた場合 (例: new $.ig.RevealView)、すべての参照を直接インポートに更新してください。

$.ig.RevealSdkSettings.setBaseUrl("https://localhost:5111/");
var revealView = new $.ig.RevealView("#revealView");

DateFilter → filters + RVDateRule​

非推奨の DateFilter プロパティは削除されました。代わりに filters コレクションを使用してください。 DateFilter は RevealView、RVDashboard、RVDateDashboardFilter、IExportOptions、RevealSettings、ExportOptionsBase およびその子クラスから削除されました。

var myRule = new $.ig.RVDateRule($.ig.RVPeriodRelation.Last, 3, $.ig.RVPeriodType.Month);
dashboard.dateFilter = new $.ig.RVDateDashboardFilter(myRule);

RVDashboardThumbnailView → RVThumbnail​

var thumbnailView = new $.ig.RevealDashboardThumbnailView("#thumbnail");
$.ig.RevealUtility.getDashboardInfo("Sales", function (info) {
  thumbnailView.dashboardInfo = info.info;
});

新しい RVThumbnail API はランタイムでのテーマ変更もサポートしています。

削除された API​

API代替
$.ig 名前空間reveal-sdk からの直接インポート
RevealApi 名前空間reveal-sdk からの直接インポート
DateFilter プロパティfilters コレクション
RVDashboardThumbnailViewRVThumbnail
Reveal.Sdk.Dashboard.ToJsonStringAsyncToJsonString
レガシー チャート タイプ (以前に非推奨)現在のチャート タイプを使用
レガシー Java エンジンJava SDK (Spring Boot)

チェックリスト​

  • jQuery の <script> タグを削除
  • Quill.js と Spectrum.js の参照がある場合は削除
  • クライアント SDK を npm パッケージに切り替え (またはスクリプトタグ構成から jQuery を削除)
  • サーバー SDK パッケージを 2.0.0 に更新
  • すべてのクライアントコードで $.ig. と RevealApi. を reveal-sdk からの直接インポートに置き換え
  • DateFilter プロパティの使用を Filters リストで置き換え
  • RVDashboardThumbnailView を RVThumbnail に置き換え
  • Reveal.Sdk.Dashboard.ToJsonStringAsync を ToJsonString に置き換え
  • 削除されたレガシー チャート タイプを使用しているダッシュボードがないことを確認
  • レガシー Java エンジンを使用している場合は、サポートされているサーバー SDK に移行

お困りですか?​

アップグレード中に問題が発生した場合は、Issue を作成するか、アプリ内チャットからお問い合わせください。