Version: 2.0

Upgrading to 2.0.0

This guide covers the breaking changes introduced in Reveal SDK 2.0 and the steps required to upgrade an existing 1.x application to 2.0.

Coming from a version older than 1.8.4?

First follow the 1.x upgrade guides in the 1.8.4 documentation to bring your project up to 1.8.4, then return to this page to complete the move to 2.0.

Overview of Breaking Changes

jQuery and Day.js removed — the SDK no longer depends on jQuery or Day.js.
NPM delivery — the client SDK is now delivered as an npm package. Legacy script-tag delivery is no longer the recommended approach.
$.ig and RevealApi namespaces removed — all types are now imported directly from the reveal-sdk npm package. Replace $.ig.ClassName and RevealApi.ClassName with direct imports (e.g. import { ClassName } from "reveal-sdk").
Renamed and removed APIs
- DateFilter - removed deprecated property from RevealView, RVDashboard, RVDateDashboardFilter, RevealSettings, IExportOptions and classes implementing it.
- Reveal.Sdk.Dashboard.ToJsonStringAsync - renamed to ToJsonString.
Deprecated types — RVDashboardThumbnailView has been deprecated, in favor of RVThumbnail.

Step-by-Step Upgrade

1. Remove jQuery

The Reveal SDK no longer requires jQuery. Remove the jQuery script tag that was previously required by the SDK:

<!-- Remove this line -->
<script src="https://cdn.jsdelivr.net/npm/jquery@3.6.0/dist/jquery.min.js"></script>

info

If your own application code depends on jQuery you can keep it — the Reveal SDK simply no longer requires it.

Also remove Day.js, Quill.js and Spectrum.js if they are still present from older versions:

<!-- Remove these if present -->
<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. Switch client SDK to NPM

Replace the legacy script-tag installation with the npm package.

1.x (script tags)
2.0 (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>

npm install reveal-sdk

import { RevealSdkSettings, RevealView } from "reveal-sdk";

Still need script tags?

The SDK distribution zip is still available for non-bundler setups — jQuery and Day.js are no longer needed:

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

3. Update server SDK packages

ASP.NET
Java
Node.js

Update the Reveal.Sdk.* NuGet packages to version 2.0.0 or later.

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

1 - Update the pom.xml file, and add the Reveal Maven repository.

pom.xml
<repositories>
    <repository>
        <id>reveal.public</id>
        <url>https://maven.revealbi.io/repository/public</url>
    </repository>	
</repositories>

2 -Add the Reveal SDK as a dependency.

<dependency>
    <groupId>io.revealbi</groupId>
    <artifactId>reveal-sdk-servlet</artifactId>
    <version>2.0.0</version>
</dependency>

npm install reveal-sdk-node@2.0.0

4. Update API usage

`$.ig` / `RevealApi` → Direct imports

The $.ig and RevealApi global namespaces have been removed. All types are now imported directly from the reveal-sdk npm package. If you were using TypeScript with infragistics.reveal.d.ts for IntelliSense (e.g. new $.ig.RevealView), update all references to use direct imports instead.

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

import { RevealSdkSettings, RevealView } from "reveal-sdk";

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

`DateFilter` → `filters` + `RVDateRule`

The deprecated DateFilter property has been removed. Use the filters collection instead. DateFilter was eliminated from RevealView, RVDashboard, RVDateDashboardFilter, RevealSettings, IExportOptions and classes implementing it.

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

import { RVDateRule, RVPeriodRelation, RVPeriodType } from "reveal-sdk";

const myRule = new RVDateRule(RVPeriodRelation.Last, 3, RVPeriodType.Month);
const myDateFilter = dashboard.filters.findByTitle("My Date Filter");
myDateFilter.rule = myRule;

`RVDashboardThumbnailView` → `RVThumbnail`

Usage of RVDashboardThumbnailView is being deprecated. The class will continue to be available for some time, but we recommend that you migrate your code to use RVThumbnail instead.

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

import { RVThumbnail } from "reveal-sdk";

RVThumbnail.fromDashboard("#thumbnail", "Sales");

The new RVThumbnail API also supports runtime theme changes.

Removed APIs

API	Replacement
`$.ig` namespace	Direct imports from `reveal-sdk`
`RevealApi` namespace	Direct imports from `reveal-sdk`
`DateFilter` property	`filters` collection
`RVDashboardThumbnailView`	`RVThumbnail`
`Reveal.Sdk.Dashboard.ToJsonStringAsync`	`ToJsonString`
Legacy chart types (previously deprecated)	Use current Chart Types
Legacy Java engine	Java SDK (Spring Boot)

Summary Checklist

Need help?

If you run into issues during the upgrade, open an issue or reach out via the in-app chat.

Overview of Breaking Changes​

Step-by-Step Upgrade​

1. Remove jQuery​

2. Switch client SDK to NPM​

3. Update server SDK packages​

4. Update API usage​

$.ig / RevealApi → Direct imports​

DateFilter → filters + RVDateRule​

RVDashboardThumbnailView → RVThumbnail​

Removed APIs​

Summary Checklist​

Need help?​