Getting started with visualization mod development
To get started, a developer of a mod needs a running instance of a Spotfire client, and a source code editor. Examples of visualization mods, which can serve as starting point for developers, are available for download. The examples are built using the Visual Studio Code editor, and it is possible to get a live preview of the mod within the Spotfire client while developing.
The procedure below covers the actions needed to create a new visualization mod. As a starting point, the js-dev-barchart example is used. It is one of the examples provided by Spotfire, and it can be downloadeded from GitHub. The procedure describes how to get started with mod development using Visual Studio Code as your code editor.
- Make sure data is loaded into an analysis.
- On the menu bar, select Tools > Development > Create visualization mod.
- Click GitHub to access and download a zip archive with the example mod projects to start the development from.
Extract the downloaded zip archive locally.
A number of examples are provided.
- In Visual Studio Code, open the folder containing the example mod project you want to start from (in this case the js-dev-barchart project).
- Select Terminal > Run Build Task to start a development server.
- Copy the server's URL that becomes available in a browser tab.
- In Spotfire, click Connect to project.
- Select Development server in the popup. Live previews will be available while developing.
Paste the copied URL in the text field
Add URL to connect to the development server, and click
The visualization mod is shown in the allocated area (this example shows a basic bar chart). The puzzle icon gets a green filled circle indicating that the visualization mod is connected to the development server.
- In Visual Studio Code, start editing the mod example project.
- To save the visualization, see Saving a visualization mod to the library.
Using a different version of Spotfire?This help describes the web client version of Spotfire on TIBCO Cloud™. If you're looking for documentation for the installed client or other versions of Spotfire, visit the TIBCO Documentation Portal.