Spotfire® User Guide

Working with dynamic titles and descriptions

Titles and descriptions of visualizations can be configured so that parts of the text are showing values that are updated somewhere else in the document. You can let the title or description of a visualization contain a value specified using either the built-in "axis visualization properties" or custom document properties.

For a description of the available axis properties, see Visualization properties in expressions. For more examples, see Titles and descriptions.

Page titles do not have access to any predefined properties, but can use custom document properties, if you type the correct syntax to call the property (${propertyname}) when editing the title, or edit the page title via the Rename page dialog in the installed client.

Tip: In the installed client, you get more support from the interface when adding or updating titles and descriptions. In the web client, you can type expressions directly, but you will not see the list of available properties, as described below. Instead you must know and type the syntax to use and the property or axis name yourself.

Creating or editing a visualization title with dynamic parts

  1. In the Visualization properties panel, click on the menu next to the title.
  2. Select Edit title expression.
  3. If desired, type a text in the Title expression field.
    Tip: If you know the name and syntax to use for the axes or properties of interest you can type the expression directly in the title field.
  4. In the installed client, when you want to add a dynamic part to the expression, you can select the axis or property of interest in the Available properties and axes list and double-click or click Insert to add it to the expression.
    Note: If one or more of the visualization properties that should be available for a certain visualization type is missing from the list, it is probably just because you have not defined any value for that axis yet. For example, the Axis.Color.DisplayName option will show up in the list when you have specified something under Color by in the visualization.
  5. When done, click OK.

    Example:

    If you insert the property Axis.X.DisplayName, it will be shown in the Title expression field as ${Axis.X.DisplayName}, and in a visualization where Year is selected on the X-axis, the title will simply be "Year". If the axis is updated to show a different column, the title will also be updated.

You can also access this dialog from the Visualization properties panel by clicking Edit title expression in the Title bar card.

Adding a description (with or without dynamic parts)

  1. In the Visualization properties panel, click and select Description.
  2. Type a text in the Description field directly, or click Open editor (installed client only).
    Tip: If you know the name and syntax to use for the axes or properties of interest you can type a dynamic expression directly in the expression field.
  3. In the installed client, when you want to add a dynamic part to the expression, click Open editor and select the axis or property of interest in the Available properties and axes list in the Edit Description dialog. Double-click or click Insert to add it to the expression.
  4. When done, click OK.

Using the main data table name as the visualization title

  1. Follow the steps for creating or editing a visualization title above.
  2. Type ${DataTable.DisplayName}, or, in the Edit Title dialog of the installed client, select DataTable.DisplayName in the Available properties and axes list and click Insert.
  3. Click OK.
    Tip: To specify a default title for all visualizations of a certain type, go to Tools > Options and go to the page for the visualization type of interest.