Sisense.JS API Reference

Sisense.JS is a JavaScript-only embedding SDK for Sisense, which allows you to embed individual widgets from one or more Sisense dashboards into your web page/application.

Classes

• Sisense (static): Main entry point for the SDK
• SisenseApp: Represents a Sisense application instance
• SisenseDash: Represents an individual Dashboard
• SisenseWidget: Represents an individual Widget

Using the SDK

Prerequisites

• Ensure CORS is enabled (opens new window)
• Ensure version compatibility

Importing the library

Include the sisense.js runtime file in your page as defined below where https://example.com should be your Sisense Web Server's URL and port.

<script type="text/javascript" src="https://example.com/js/sisense.js"></script>

TIP

Starting from Sisense versions 8.1.1 & L8.2.1, a new version of Sisense.js is available. It provides the following improvements:

• Isolated scope: SisenseJS will not override any globals on the window and can work alongside other versions of the aforementioned libraries
• Isolated CSS classes: SisenseJS will not override or collide with any of your CSS classes or rules

To utilize the new version, all you have to do is modify the Sisense.js file path to its new location and file name:

 <script type="text/javascript" src="https://example.com/js/sisense.v1.js"></script>

The original version of the file is still available at the original file path.

AngularJS/React Support

Sisense.js can work in applications built with Angular or React, however some considerations must be taken.

Read more about this topic in the Sisense.js Guide

Add-on support

When embedding Sisense using the Sisense.js SDK, only widgets are being embedded. Thus, only add-ons (plugins) that apply to the widget level are supported.

Add-ons that affect the system UI or other scopes may have no effect, or have an undesirable effect on certain widgets if the add-on attempts to invoke APIs or components that are not available.

For example: The Funnel Widget (opens new window) add-on is compatible with Sisense.js because it is a widget type and can be embedded like any other widget; The Jump To Dashboard (opens new window) add-on is not compatible with Sisense.js because it is built to navigate to other dashboards, which do not exist in the Sisense.js scope.