List Mod for Spotfire®

The list can be used to display a selectable list of unique values in a column or a hierarchy.

Data Requirements

Every mod handles missing, corrupted and/or inconsistent data in different ways. It is advised to always review how the data is visualized.

The list can display unique values in any categorical or hierarchical column.

Configuring the Mod

A basic list can be configured by just selecting a single categorical column. If a hierarchy is used each level of the hierarchy will be indented. The depth of the hierarchy will also affect the styling:

• The first level will be displayed in bold if the hierarchy has two levels
• The first level will be displayed in uppercase and the second level will be bold if the hierarchy has three or more levels.

Styling

The list will respond to changes in the Spotfire canvas style. Label fonts, sizes and text color are determined by visualization canvas settings.

Using the Mod

Marking

Clicking on an item will mark that item in the list and in all other visualizations that uses the same marking. You can mark several items by Ctrl-clicking on them.

Clicking on a hierarchy header will mark all items underneath it.

Clicking and dragging will mark a range of items in the list. You can mark several ranges by ctrl-clicking and dragging.

Sorting

The list is sorted alphabetically in ascending order by default. Each branch in the hierarchy is sorted independently. To change the sort order, move the mouse over the list and click on the small gear icon to the left of the first item in the list.

Select a column to sort by in order to sort the list by a column in your dataset. E.g. if your data set looks like this you can display a list with the month in correct order by Sorting the list by the Order column:

Hierarchies are sorted hierarchically. The value of each node in the hierarchy is taken to be the sum of the values in all the leaves below it.

Searching

Move the mouse over the list, click on the small gear icon to the left of the first item in the list and check the checkbox to make the search field visible. Start typing in the search box to filter the list.

The following subset of the Spotfire search syntax is supported:

• ab finds items that contains any word beginning with ab
• *ab finds items that contains any word ending with ab
• *ab* finds items that contains any word with ab in the middle
• ab ba finds items that contain a word beginning with ab AND a word beginning with ba
• "A Green Apple" finds items that contains the phrase A Green Apple
• Search is not case-sensitive

Scrolling

A scrollbar will appear when the mouse is over the list if all liste items can't fit into the list area. The height of the scrollbar handle indicates the number of visible items relative to the total number of items in the list.

Drag the handle or use the mouse wheel to scroll the list up or down.

Click above or below the handle to scroll one page up or down.

Click on the thumbnails to scroll one item up or down.

In a terminal window:

• npm install
• npm start

In a new terminal window:

• npm run server

• Community Exchange: A safe and trusted place to discover ready-to-use Mods
• Developer Documentation: Introduction and tutorials for Mods developers
• Mods code examples on GitHub: A public repository for example projects