How to Use a Visualization Mod

To save a visualization mod to the library:

You can save a visualization mod to the library. When the mod as been saved to the library, the visualization mod can be added to analyses and also pinned to the visualization flyout.

Make sure the visualization mod you want to save is available in the analysis, but not in development.
On the authoring bar, click to open the Visualization types flyout.
Locate the visualization mod you want to save, and click to the right to open the menu.
Select Save as Library Item.

Response: The Files and data flyout is opened.

Select a folder to save the mod in, type a name in the bottom part of the flyout, and click Save.

Comment: If you have the Develop mods license feature, you can also save the visualization mod from the Mods development tool. Make sure the mod is disconnected, and then select Save as > Library item.

To find where in the library a visualization mod is located, open the Visualization types flyout, click to the right of the visualization mod, and select View in library.

To save a visualization mod as a local file:

Make sure the visualization mod you want to save is available in the analysis, but not in development.
On the authoring bar, click to open the Visualization types flyout.
Locate the mod, click to open the menu.
Select Save as local file.
Specify a name of the visualization mod, and a location for the file, and click Save.

Response: The visualization mod is saved as a .mod file.

Comment: If you have the Develop mods license feature, you can also save the visualization mod from the Mods development tool. Make sure the mod is disconnected, and then select Save as > Local file.

To open a visualization mod that is saved locally:

A visualization mod can be saved as a .mod file and then distributed between users, via, for example, email or by publishing it on websites. You can download and save such a .mod file locally, and then open the visualization mod in an analysis.

On the authoring bar, click Files and data .
Response: The flyout opens.
In the flyout, click Browse local file, and locate the .mod file.
Select the .mod file, and click Open.
Response: The visualization mod is added to the analysis page.

Alternatively, drag the .mod file to the analysis page, or, you can click options in the Visualization types search field at the top of the flyout, and select Browse for visualization.

To pin a visualization mod to the visualization flyout:

Visualization mods that have been saved to the library can be pinned, which means they are added next to the list of native visualizations in the Visualization types flyout. When a visualization mod is part of the visualizations list, it becomes available for selection also in future analyses. In addition, the visualization mod will appear as a choice whenever you select a visualization type, for example, when you want to switch to another visualization or create a details visualization.

Make sure the visualization mod is saved in the library.

Comment: See 'To save a visualization mod to the library' above.

On the authoring bar, click to open the Visualization types flyout.

Comment: The upper part of the flyout, above the line, lists visualization mods that are not yet added to the list of pinned visualizations.

Hover over the visualization mod, click options , and select Pin.

Comment: If the visualization mod is not available in the flyout, you can click options in the Visualization types search field at the top of the flyout, and select Find visualizations in the library. Locate and right-click the visualization mod of interest, and select Pin to visualizations.

Response: The visualization mod is shown below the line, in the lower part of the flyout.

To get started with visualization mod development:

A developer of a visualization mod needs a running instance of a Spotfire client, and a source code editor. Examples of visualization mods, which can serve as starting points for developers, are available for download. The examples are built using the Visual Studio Code editor. Via a development server, Spotfire can be connected to the visualization mod in the editor to get a live preview of the mod within the Spotfire client while developing.

For more information about the actual development and the tools, see the Spotfire® Mods website on GitHub and Developing Mods.