Version

Using the Web SDK

Overview

When embedding Reveal into web applications, the architecture is slightly more complex than with native apps, as two components are always involved:

  • Reveal Client SDK: a set of JavaScript libraries and CSS files that needs to be integrated into the web application. The frameworks supported today are: jQuery, Angular and React.

  • Reveal Server SDK: the server-side component to be integrated into the server application, currently this is an ASP.NET Core application using .NET Runtime v4.6.2 or later. In the near future a library using .NET Core will be released.

In the following diagram you can see the architecture for a web application, embedding the Reveal Web SDK:

sdk_web_diagram_web

As shown above, the SDK works pretty much the same way as with native apps. The difference is that some of the callbacks are invoked in the client side (like the event sent when a data point is clicked) and others are invoked server side (like the callback to load the dashboard or to provide in-memory data).

Hosting the Client-side and Server-side Parts on Different Servers

You can host the client-side and the server-side parts separately i.e. on different urls.

To achieve this, set a property on the window object, as shown below:

window.IGAppBaseURL = "{back-end base url}";

Please, note that the trailing slash symbol is required in order to set the property successfully.

Set this property prior to the instantiation of the $.ig.RevealView.