TIBCO Cloud™ Spotfire® Web Client User Guide

Using document, data table or column properties in an analysis

A property, especially a document property, can be used as a variable to drive configurations of visualizations and calculations and make them easy to modify by others. Adding a property control that can change the property value to a text area (installed client only) further simplifies the update process. The property controls can be used to give web client consumer users a possibility to change the axes of visualizations or modify the analysis in other ways.

About this task

This section collects different ways that you can use properties to enhance or simplify a Spotfire analysis.

Before you begin

Some of the functionality described here can only be authored or accessed using the installed Spotfire client.

About this task

For example, a document property can be used to specify a column name. This property can then be used to define what is shown on one or more visualization axes, either directly or as a part of a custom expression. By using a property instead of simply placing the column name directly on the axes, you only need to change a single value (the property value) to change all axes where the property is used.

Property expressions can also be used to define a line or a curve. If a property used in expressions is updated, the property will be updated in all currently used locations.

The process to follow when setting up property controls is usually as follows:

  1. Decide which values in the analysis people should be able to control from the text area.
  2. Create a property, which can assume these variations in values, and its property control.
  3. Hook the property to the place where user control is wanted, for example, an axis selector or an expression.

The best way to explain these steps is through examples. They also give you a hint of what is possible to do.