Skip to main content
RSS feed Subscribe to feed

 

Skip Navigation LinksHome  Extending the Spotfire Platform  Creating Extensions to the Spotfire Platform  Integrating with Spotfire Web Player

©Spotfire 2011

Integrating with Spotfire Web Player

The JavaScript API can be used to create Web Player mashups. The Web Player can be integrated with other applications and programmed to handle Web Player interactions.

Overview

The Spotfire Web Player JavaScript API, available from v2.1.0, can be used for a diverse set of mashup scenarios:

  • Integrate the Web Player into a corporate web site.
  • Open an analysis from a link, and configure the data or the analysis depending on the user.
  • Integrate the Web Player with an external online source. This may work both ways: Responding to events and user interaction in the analysis, and propagating events or data to the external source.
Preconditions
  • Installing and Configuring the JavaScript API
    Before the Web Player JavaScript API can be used to create mashups, the Web Player must be installed and configured to enable the JavaScript API.
  • Mashup Development with Multiple Servers
    JavaScript in mashup calls from the same server as the Web Player does not compromise domain security. If the mashup and the Web Player reside on different servers, attention to domain attributes is essential.
Recommended Background
  • Web Architecture
    The Web Player JavaScript API integrates solutions with the Spotfire Web Player. It enables event handling, data data marking and filter manipulation.
  • spotfire.webPlayer Namespace
    This namespace contains the classes defining the Web Player JavaScript API.

Features Added from 3.1

Web Player mashups added in 3.1.

The HTML and javascript files are available for download in the following mashup descriptions:

Features Available from 2.1

  • How to Control Spotfire Web Player – Part 1
    The CRM mashup in this tutorial has three components: the Web Player, an external control panel from which it is possible to control the Web Player, and an external table in which markings are displayed. Until the mashup is loaded, all controls are disabled.
  • How to Create a Parameterized Dashboard
    A simple ASP.NET page can be used to render a mashup page. The page in this tutorial displays a list of files to choose from.
  • How to Create a Map Mashup
    The Map mashup in this tutorial has two components: the Web Player and the Virtual Earth map. The user may hide the Web Player or the map via two buttons at the top of the page.

The API can be used both to integrate the Web Player with other web applications at browser level, and perform typical Spotfire actions. The following code samples show how to solve common tasks:

  • Web Player: Open File
    This example shows how to add a reference to the JavaScript API, and how to load an analysis. An open parameter block is used to set a parameter in the information link and to run a bookmark.
  • Web Player: Register Event Handlers
    This example shows how to register event handlers when the active page changes, or when the user marks in a visualization.