Getting Started

Tutorial Video

Prerequisites

To use the mod, a working instance of Tibco Spotfire is necessary. This could be either the desktop client Tibco Spotfire® Analyst, or the web client, TIBCO Spotfire® Business Author. To get Tibco Spotfire, you can move to their home page where you can start a trial or get started with a membership.

If you wish to download the source code found on GitHub, you also need to have node.js installed on your machine in order use the mod. A description of how to do this, written by Tibco themselves, can be found here.

How do I download it?

To download the mod, there are two options. The first option, which is also the easiest, is to download and use the release. The other option is to download the source code and run it on a development server. The second option is required if you wish to make changes to the mod.

1. Release Download

To download the release, first head to the GitHub Release Page. Here you will want to grab the latest release, which should have the highest vesion number, for instance 0.1.1.

Once you have downloaded the release, you want to start up Spotfire. Now you have two options. Firstly, you can drag and drop the mod-file (the one you just downloaded) into the Spotfire canvas. The other option is to click on the three bars on the left side, which will open a pop-up menu. In this pop-up menu, click on the three dots in the top right, select "Browse for Visualiation" and find the mod-file. You should now see the visualization in your client!

2. Source Code Download

To download the source code, navigate to GitHub and click the code button to download the code using your preffered method. Next you need to install node.js, which is described on their website found here. After you have downloaded the code and installed node.js, you want to navigate to the project code folder in two terminals, and run:

1. npm start
2. npm run server

Once you have executed these commands, your development server is up and running. In order to connect it to Spotfire®, there are a couple of steps we need to execute.

Firstly, make sure Spotfire® is set to editing instead of viewing mode. Next, you want to click Tools > Development > Create visualization mod... In the canvas that just popped up, you want to click "Connect to project". Then click Development Server, enter the url that you got in your terminal when setting up the server, and connect. Now you should be able to see the mod in your local Spotfire®!

Settings and Features

A list of the features and settings currently available in the mod can be found below. A description of these features and settings can be found here.

Features:

• Left Mouse and Ctrl-clicking subsets of data.
• Click-hold-drag selection for multiple subsets.
• Unselect by clicking the mod background (canvas).
• Tooltip with dynamic information on mouseOver.
• Dynamic sum of values as center text.
• Labels showing ratios on each sector.
• Red lines visualizing negative values.
• Dynamic visualization based on sector and donut size.
• Outlined hover-effect when hovering a sector.
• Settings for adapting different visualization aspects of the mod.

Settings:

Show labels for:

• All
• Marked rows
• None

Show in labels:

• Sector percentage
• Sector value
• Sector category

Labels position:

• Inside donut
• Outside donut

Sorting:

• Sort sectors by size
• Sort sectors ascending
• Sort sectors descending

Circle type:

• Visualize whole circle
• Visualize semi-circle