Table of contents
  1. Pages and Layout
    1. Visualization Layout
    2. Arranging Visualizations
    3. Pages
    4. Cover Page
      1. Cover Page
      2. Text Area Edit Mode
    5. Details-on-Demand
      1. What is the Details-on-Demand?
      2. Details-on-Demand Properties
        1. Details-on-Demand Properties
        2. Details-on-Demand Properties - Appearance
        3. Details-on-Demand Properties - Fonts
        4. Details-on-Demand Properties - Columns
        5. Details-on-Demand Properties - Virtual Columns
        6. Details-on-Demand Properties - Sorting
    6. Document Properties
      1. How to Edit Document Properties
      2. Details on Document Properties – General
      3. Details on Document Properties – Library
      4. Details on Document Properties – Markings
      5. Details on Document Properties – Filtering Schemes
      6. Details on Document Properties – Data Functions
      7. Details on Document Properties – Properties
      8. Details on New/Edit Document Property
    7. Setting Defaults
      1. How to Specify Default Values
      2. Options
        1. Options – Application
        2. Options – Fonts
        3. Options – Document
        4. Options – Visualization
        5. Options – Axis Formatting
        6. Options – Table
        7. Options – Cross Table
        8. Options – Graphical Table
        9. Options – Bar Chart
        10. Options – Line Chart
        11. Options – Combination Chart
        12. Options – Pie Chart
        13. Options – Scatter Plot
        14. Options – 3D Scatter Plot
        15. Options – Map Chart
        16. Options – Treemap
        17. Options – Heat Map
        18. Options – Parallel Coordinate Plot
        19. Options – Summary Table
        20. Options – Box Plot
        21. Options – Data Functions
        22. Options – Compatibility
        23. Details
          1. Details on Renderer Settings
          2. Details on Add/Edit Default Renderer
          3. Details on Apply Font Settings to Document
          4. Details on Edit Symbol Sets
          5. Details on Add/Rename Symbol Set
          6. Details on Add/Edit Symbol
          7. Details on Reference Points
          8. Details on Statistics Table
    8. Panels and Popovers
  2. Filters
    1. What is a Filter?
    2. Filter Types
      1. Range Filter
      2. Item Filter
      3. Radio Buttons
      4. Check Boxes
      5. Text Filter
      6. List Box Filter
      7. Hierarchy Filter
        1. What is a Hierarchy Filter?
        2. Creating a Hierarchy Filter
    3. Filters Panel
      1. Searching for Filters
      2. Changing Filter Name
      3. Showing and Hiding Filters
      4. Moving and Sorting Filters
      5. Grouping Filters
      6. Filters Panel
        1. Filters Panel Properties
          1. Details on Filtering Scheme Properties
          2. Details on Organize Filters
          3. Details on New Group
          4. Details on Rename Column
          5. Details on Rename Group
          6. Details on Apply Filter Organization
      7. Filtering Schemes
      8. Filtering in Related Data Tables
  3. Tags
    1. What are Tags?
    2. How to Work with Tags
    3. Details
      1. Details on New Tag Collection
      2. Details on New Tag
      3. Details on Edit Tag Collection
      4. Details on Edit Tag
      5. Tags Pop-up Menus
  4. Bookmarks
    1. What are Bookmarks?
    2. How to Use Bookmarks
    3. Bookmarks Example Scenarios
    4. Bookmarks Pop-up Menu
    5. Details on Add Bookmark Special
    6. 3.2 Bookmarks
      1. What are 3.2 Bookmarks?
      2. How to Use 3.2 Bookmarks
      3. Details
        1. Details on New Folder (3.2 Bookmarks)
        2. Details on Capture Bookmark (3.2 Bookmarks)
        3. Details on Edit Bookmark (3.2 Bookmarks)
  5. Lists
    1. What are Lists?
    2. How To Use Lists
      1. Selecting Lists and List Items
      2. Marking Items in Visualizations
      3. Creating Lists
      4. Modifying Lists
      5. Importing Lists and Items
      6. Exporting Lists and Items
      7. Creating Tag Collections from Lists
      8. Searching the Lists Panel
      9. Working with Annotations
    3. Details
      1. Details on New List from Marked
      2. Details on New List from List Logic
      3. Details on List/List Item Properties
      4. Details on New/Edit Annotation
  6. Collaboration
    1. Collaboration Panel
      1. What is the Collaboration Panel?
      2. How to Use the Collaboration Panel
      3. Details on Configure Collaboration Panel
    2. Share
      1. What is the Share Menu?
      2. Details on Log into tibbr®
      3. Details on Share to tibbr®

Pages and Layout

Last modified
Table of contents
  1. Pages and Layout
    1. Visualization Layout
    2. Arranging Visualizations
    3. Pages
    4. Cover Page
      1. Cover Page
      2. Text Area Edit Mode
    5. Details-on-Demand
      1. What is the Details-on-Demand?
      2. Details-on-Demand Properties
        1. Details-on-Demand Properties
        2. Details-on-Demand Properties - Appearance
        3. Details-on-Demand Properties - Fonts
        4. Details-on-Demand Properties - Columns
        5. Details-on-Demand Properties - Virtual Columns
        6. Details-on-Demand Properties - Sorting
    6. Document Properties
      1. How to Edit Document Properties
      2. Details on Document Properties – General
      3. Details on Document Properties – Library
      4. Details on Document Properties – Markings
      5. Details on Document Properties – Filtering Schemes
      6. Details on Document Properties – Data Functions
      7. Details on Document Properties – Properties
      8. Details on New/Edit Document Property
    7. Setting Defaults
      1. How to Specify Default Values
      2. Options
        1. Options – Application
        2. Options – Fonts
        3. Options – Document
        4. Options – Visualization
        5. Options – Axis Formatting
        6. Options – Table
        7. Options – Cross Table
        8. Options – Graphical Table
        9. Options – Bar Chart
        10. Options – Line Chart
        11. Options – Combination Chart
        12. Options – Pie Chart
        13. Options – Scatter Plot
        14. Options – 3D Scatter Plot
        15. Options – Map Chart
        16. Options – Treemap
        17. Options – Heat Map
        18. Options – Parallel Coordinate Plot
        19. Options – Summary Table
        20. Options – Box Plot
        21. Options – Data Functions
        22. Options – Compatibility
        23. Details
          1. Details on Renderer Settings
          2. Details on Add/Edit Default Renderer
          3. Details on Apply Font Settings to Document
          4. Details on Edit Symbol Sets
          5. Details on Add/Rename Symbol Set
          6. Details on Add/Edit Symbol
          7. Details on Reference Points
          8. Details on Statistics Table
    8. Panels and Popovers
  2. Filters
    1. What is a Filter?
    2. Filter Types
      1. Range Filter
      2. Item Filter
      3. Radio Buttons
      4. Check Boxes
      5. Text Filter
      6. List Box Filter
      7. Hierarchy Filter
        1. What is a Hierarchy Filter?
        2. Creating a Hierarchy Filter
    3. Filters Panel
      1. Searching for Filters
      2. Changing Filter Name
      3. Showing and Hiding Filters
      4. Moving and Sorting Filters
      5. Grouping Filters
      6. Filters Panel
        1. Filters Panel Properties
          1. Details on Filtering Scheme Properties
          2. Details on Organize Filters
          3. Details on New Group
          4. Details on Rename Column
          5. Details on Rename Group
          6. Details on Apply Filter Organization
      7. Filtering Schemes
      8. Filtering in Related Data Tables
  3. Tags
    1. What are Tags?
    2. How to Work with Tags
    3. Details
      1. Details on New Tag Collection
      2. Details on New Tag
      3. Details on Edit Tag Collection
      4. Details on Edit Tag
      5. Tags Pop-up Menus
  4. Bookmarks
    1. What are Bookmarks?
    2. How to Use Bookmarks
    3. Bookmarks Example Scenarios
    4. Bookmarks Pop-up Menu
    5. Details on Add Bookmark Special
    6. 3.2 Bookmarks
      1. What are 3.2 Bookmarks?
      2. How to Use 3.2 Bookmarks
      3. Details
        1. Details on New Folder (3.2 Bookmarks)
        2. Details on Capture Bookmark (3.2 Bookmarks)
        3. Details on Edit Bookmark (3.2 Bookmarks)
  5. Lists
    1. What are Lists?
    2. How To Use Lists
      1. Selecting Lists and List Items
      2. Marking Items in Visualizations
      3. Creating Lists
      4. Modifying Lists
      5. Importing Lists and Items
      6. Exporting Lists and Items
      7. Creating Tag Collections from Lists
      8. Searching the Lists Panel
      9. Working with Annotations
    3. Details
      1. Details on New List from Marked
      2. Details on New List from List Logic
      3. Details on List/List Item Properties
      4. Details on New/Edit Annotation
  6. Collaboration
    1. Collaboration Panel
      1. What is the Collaboration Panel?
      2. How to Use the Collaboration Panel
      3. Details on Configure Collaboration Panel
    2. Share
      1. What is the Share Menu?
      2. Details on Log into tibbr®
      3. Details on Share to tibbr®

  1. Pages and Layout
    1. Visualization Layout
    2. Arranging Visualizations
    3. Pages
    4. Cover Page
      1. Cover Page
      2. Text Area Edit Mode
    5. Details-on-Demand
      1. What is the Details-on-Demand?
      2. Details-on-Demand Properties
        1. Details-on-Demand Properties
        2. Details-on-Demand Properties - Appearance
        3. Details-on-Demand Properties - Fonts
        4. Details-on-Demand Properties - Columns
        5. Details-on-Demand Properties - Virtual Columns
        6. Details-on-Demand Properties - Sorting
    6. Document Properties
      1. How to Edit Document Properties
      2. Details on Document Properties – General
      3. Details on Document Properties – Library
      4. Details on Document Properties – Markings
      5. Details on Document Properties – Filtering Schemes
      6. Details on Document Properties – Data Functions
      7. Details on Document Properties – Properties
      8. Details on New/Edit Document Property
    7. Setting Defaults
      1. How to Specify Default Values
      2. Options
        1. Options – Application
        2. Options – Fonts
        3. Options – Document
        4. Options – Visualization
        5. Options – Axis Formatting
        6. Options – Table
        7. Options – Cross Table
        8. Options – Graphical Table
        9. Options – Bar Chart
        10. Options – Line Chart
        11. Options – Combination Chart
        12. Options – Pie Chart
        13. Options – Scatter Plot
        14. Options – 3D Scatter Plot
        15. Options – Map Chart
        16. Options – Treemap
        17. Options – Heat Map
        18. Options – Parallel Coordinate Plot
        19. Options – Summary Table
        20. Options – Box Plot
        21. Options – Data Functions
        22. Options – Compatibility
        23. Details
          1. Details on Renderer Settings
          2. Details on Add/Edit Default Renderer
          3. Details on Apply Font Settings to Document
          4. Details on Edit Symbol Sets
          5. Details on Add/Rename Symbol Set
          6. Details on Add/Edit Symbol
          7. Details on Reference Points
          8. Details on Statistics Table
    8. Panels and Popovers
  2. Filters
    1. What is a Filter?
    2. Filter Types
      1. Range Filter
      2. Item Filter
      3. Radio Buttons
      4. Check Boxes
      5. Text Filter
      6. List Box Filter
      7. Hierarchy Filter
        1. What is a Hierarchy Filter?
        2. Creating a Hierarchy Filter
    3. Filters Panel
      1. Searching for Filters
      2. Changing Filter Name
      3. Showing and Hiding Filters
      4. Moving and Sorting Filters
      5. Grouping Filters
      6. Filters Panel
        1. Filters Panel Properties
          1. Details on Filtering Scheme Properties
          2. Details on Organize Filters
          3. Details on New Group
          4. Details on Rename Column
          5. Details on Rename Group
          6. Details on Apply Filter Organization
      7. Filtering Schemes
      8. Filtering in Related Data Tables
  3. Tags
    1. What are Tags?
    2. How to Work with Tags
    3. Details
      1. Details on New Tag Collection
      2. Details on New Tag
      3. Details on Edit Tag Collection
      4. Details on Edit Tag
      5. Tags Pop-up Menus
  4. Bookmarks
    1. What are Bookmarks?
    2. How to Use Bookmarks
    3. Bookmarks Example Scenarios
    4. Bookmarks Pop-up Menu
    5. Details on Add Bookmark Special
    6. 3.2 Bookmarks
      1. What are 3.2 Bookmarks?
      2. How to Use 3.2 Bookmarks
      3. Details
        1. Details on New Folder (3.2 Bookmarks)
        2. Details on Capture Bookmark (3.2 Bookmarks)
        3. Details on Edit Bookmark (3.2 Bookmarks)
  5. Lists
    1. What are Lists?
    2. How To Use Lists
      1. Selecting Lists and List Items
      2. Marking Items in Visualizations
      3. Creating Lists
      4. Modifying Lists
      5. Importing Lists and Items
      6. Exporting Lists and Items
      7. Creating Tag Collections from Lists
      8. Searching the Lists Panel
      9. Working with Annotations
    3. Details
      1. Details on New List from Marked
      2. Details on New List from List Logic
      3. Details on List/List Item Properties
      4. Details on New/Edit Annotation
  6. Collaboration
    1. Collaboration Panel
      1. What is the Collaboration Panel?
      2. How to Use the Collaboration Panel
      3. Details on Configure Collaboration Panel
    2. Share
      1. What is the Share Menu?
      2. Details on Log into tibbr®
      3. Details on Share to tibbr®

Pages and Layout

Visualization Layout


You can insert several visualizations on a page. Each new visualization will be inserted at the top of the page.

Often you will want to adjust the layout of the visualizations, as you might want some to be larger than others, or some visualization to be placed beside another instead of above it.

  • To resize visualizations:

  1. Position the mouse pointer between the visualizations you want to resize.

    Response: The mouse pointer changes appearance to MousePointer.png.

  2. Click and drag the mouse to resize the visualizations.

Note: If the visualization becomes too small in either direction, controls such as the legend, zoom sliders, axis selectors, etc., are hidden and cannot be viewed until the size of the visualization is increased.

Moving visualizations

You can also change the layout of the visualizations using a drag-and-drop operation. Click on a visualization title and drag the mouse over another visualization. A shaded box will appear over a part of that visualization, and when you release the mouse the layout will be updated as shown below.

  • To place a visualization beside another:

Click on the title of the bar chart and drag it onto the scatter plot. Drag it to the right side of the scatter plot and a shaded area will indicate that by dropping the bar chart, it will be placed to the right of the scatter plot. Release the mouse, and the bar chart will be placed to the right of the scatter plot. All the visualizations will automatically adjust to fill the entire window.

VisualizationLayout1.png

  • To place a visualization below another:

Click on the title of the scatter plot and drag it onto the bar chart. Drag it to the bottom part of the bar chart and a shaded area will indicate that by dropping the scatter plot, it will be placed below the bar chart. Release the mouse, and the scatter plot will be placed below the bar chart. All the visualizations will automatically adjust to fill the entire window.

VisualizationLayout2.png

  • To switch places between two visualizations:

Click on the title of the bar chart and drag it onto the line chart. Drag it to the center of the line chart and a shaded area will cover the entire line chart, indicating that by dropping the bar chart, the visualizations will switch places. Release the mouse, and the visualizations will switch places. The window layout will stay the same since the switched visualizations take each other's size and position.

VisualizationLayout3.png

Tip: If the title bar of a visualization has been hidden, it can be shown by right-clicking on the visualization and selecting Properties. On the General page, select the Show title bar check box.

See also:

Arranging Visualizations

Drag-and-Drop

Arranging Visualizations


Apart from positioning the visualizations on a page using a drag-and-drop operation, there are some shortcuts to apply a basic layout.

  • To arrange visualizations:

Select View > Arrange Visualizations > ...  or click on one of the corresponding buttons on the toolbar.

ArrangingVisualizations.png

 

Arrange Evenly

Arranges the visualizations as evenly as possible.

Arrange Side-by-side

Arranges the visualizations side by side.

Arrange Stacked

Arranges the visualizations stacked on top of each other.

Maximize Active

Makes the active visualization as large as possible, and minimizes all other visualizations which are placed as thumbnails at the bottom of the page.

Tip: Use Maximize Active and drag to switch visualizations in order to view one visualization at a time.

See also:

Visualization Layout

Pages


You can work with several pages in your analysis if you want to keep information about different topics separated, or if you simply need more space. Navigation between pages can be done using three different modes; titled tabs, step-by-step, or history arrows, as described below.

  • To add a new page to the document:

  1. Click on the New Page button on the toolbar, NewPageButton.png.

    Comment: You can also select Insert > New Page from the menu.

    Note: New pages can only be added in tab mode.

    Comment: When a new page is added, the filtering scheme and organize filters settings are inherited from the active page.

Titled Tabs

In tab mode, pages are indicated by tabs at the top of the screen, and clicking on these tabs switches page. You can also click on the small arrow icon to the right of the tabs to open a drop-down list where you can switch between all pages in the analysis. Tab mode is useful when you want to see the titles of each page and choose in what order to look at the pages.

Pages1.png

On each page, you can insert one or many visualizations, and arrange these as you like. Perhaps you want to see both a table and a bar chart next to each other on one page to compare details, and then be able to switch pages to see a pie chart. When in tab mode, you can change the order of your pages using drag-and-drop.

  • To change page title:

  1. Right-click on a page tab.

  2. Select Rename Page... from the pop-up menu.

  3. Type a new name for the page.

  4. Click OK.

Step-by-Step

You can also select to show the pages as numeric links instead of tabs. This is called Step-by-Step mode. Step-by-Step mode is useful when the order of the pages is important and you want to present your analysis as a guided flow.

Pages2.png

The pages are now reached by clicking on the numbered links or the Previous/Next links. This is useful if you want to create a guided analysis and share it with other colleagues, and you intend for your colleagues to go through the analysis in a certain order. See also What is a Guided Analysis?

History arrows

If you want to set up your own navigation in the analysis you can select Page Navigation > History Arrows. This will give you a similar look as in the step-by-step case, but all links will be hidden.

Pages3.png

When this option is selected you can keep pages in the analysis that are not shown to Web Player users at all. All connections between the available pages must then be separately specified using actions in the text area or on dynamic items in graphical tables. The page history arrows to the left of the page name makes it possible to return to a previously visited page.

  • To change the page navigation mode:

  1. Right-click in the area containing the tabs or links.

  2. Select Page Navigation > Step-by-Step or Titled Tabs or History Arrows from the pop-up menu.

Filtering in different pages

You can specify whether or not filtering on one page will affect the visualizations on a different page by using the same or different filtering schemes on the pages. You can also specify which filters will be visible on each page using the Organize Filters dialog. The filtering scheme of new pages is inherited from the active page, but it can be changed by displaying the filtering scheme menu in the Filters panel.

Showing and hiding panels

The visibility of all panels such as the filters panel, and the bookmarks panel is controlled per page. For each page, you can switch on or off the panels of interest by clicking on their corresponding toolbar button (and clicking Dock if the panel is in popover mode) or by selecting it from the View menu. The panel visibility of new pages is inherited from the active page.

See also:

Filters Panel Properties

Cover Page

Cover Page

Cover Page


The cover page is a page meant to serve as an introduction to your analysis. It contains a text area in which you can enter information about the purpose of your analysis as well as other useful information, before you share your analysis with your colleagues. If desired, it can be automatically created each time you make a new document, see below. If you are creating a guided analysis in step-by-step mode, and have selected to use a cover page, this should be the first page in the sequence of links.

  • To change whether or not to create a cover page in new documents:

  1. Select Tools > Options....

  2. Go to the Document page.

  3. Clear or select the Create cover page for new analysis check box.

  • To edit text in the cover page:

  1. Right-click in the cover page.

  2. Select Edit from the pop-up menu.

  3. Type text in the text area.

  4. Right-click and select Edit again, to leave the edit mode.

  • To change the cover page name:

  1. Right-click on the Cover Page tab.

  2. Select Rename Page... from the pop-up menu.

  3. Type a new name for the cover page.

  4. Click OK.

See also:

Text Area Edit Mode

Details on Insert/Edit Action Control

Details on Insert/Edit Property Control

What is a Guided Analysis?

Text Area Edit Mode


The text area can only be edited when the Toggle Edit Mode button, ToggleEditModeButton.png, in the visualization title bar has been clicked, or, when Edit Text Area has been selected from the pop-up menu.

When in edit mode, you will see a toolbar at the top of the text area where a number of options are available:

Option

Description

CutButton.png

Cuts the selected object from the current position, to be pasted somewhere else.

CopiesSelectedObjectButton.png

Copies the selected object.

PastesSelectedObjectButton.png

Pastes the selected object in the text area.

Font

Specifies the font of the text.

Size

Specifies the font size of the text.

BoldfaceButton.png

Sets the selected text to boldface.

ItalicsButton.png

Sets the selected text to italics.

UnderlineButton.png

Underlines the selected text.

OpenColorDialogueButton.png

Opens the Color dialog where you can specify the text color.

AlignLeftButton.png

Aligns the selected paragraph to the left of the text area.

AlignCenterButton.png

Aligns the selected paragraph to the center of the text area.

AlignRightButton.png

Align the selected paragraph to the right of the text area.

NumberedListButton.png

Creates a numbered list of the selected paragraph.

BulletListButton.png

Creates a bulleted list of the selected paragraph.

RemoveIndentButton.png

Removes the indent characters from the selected text.

IndentTextButton.png

Indents the text of the selected paragraph.

InsertImageButton.png

Opens a dialog where you can browse to locate an image to insert.

Including images can be very costly to memory, so it is recommended to keep images small.

InsertWebLinkButton.png

Opens the Insert Web Link dialog where you can type or paste the link to any website which might be of interest for the analysis.

You can also use this button to add a mailto link opening a new message in your standard email client, or a tibcospotfire link which links to a different analysis.

 

Examples:

http://www.tibco.com

mailto:person@example.com?subject=Test

tibcospotfire:server:http\://myspotfireserver/:analysis:/Data/My Analysis

RemoveWebLinkButton.png

Removes the web link but leaves the text intact.

FiltersButton.png

Opens the Insert  Filter dialog where you can select a filter to add to the text area.

ActionControlButton.png

Opens the Action Control dialog where you can insert an action link or button which applies a bookmark, switches page or runs a script, etc.

PropertyControlButton.png

Opens the Property Control dialog where you can insert input fields, drop-down lists, list boxes, etc., which can easily change the values of custom properties.

InsertDynamicControlButton.png

Allows you to insert a dynamic item (a sparkline, a calculated value, an icon, or a bullet graph) into the text area.

To change the name of the Text Area, or to show or hide the title bar, right-click on the text area and select Properties.

See also:

How to Use the Text Area

Text Area Pop-up Menus

What is a Guided Analysis?

Details-on-Demand

What is the Details-on-Demand?


The Details-on-Demand display the actual values of marked items in the active visualization. If you mark a bar in a bar chart, all the rows of data included in that bar are presented. Marking a record in a scatter plot might only display information about a single row of data.

You can view and manage Details-on-Demand in a popover, in a docked panel, or as a floating window. Click on the Details-on-Demand button, , on the toolbar, or select View > Details-on-Demand to open Details-on-Demand. They will open in the mode they were opened last time you had them open.

The Details-on-Demand works just like any other table—you can click on column headings to sort the presented details, drag and drop column headings to change the order, and change the width of the columns by moving the mouse over the column separator line and dragging.

WhatistheDetails-on-Demand.png

If more than one data table is available within the analysis, a color stripe showing the relations color for the active data table is shown on the right hand side of the Details-on-Demand.

Note: For analyses with multiple data tables, settings for the Details-on-Demand must be defined in the Details-on-Demand properties dialog for each data table.

See also:

Details-on-Demand Properties

How to Use the Table

Panels and Popovers

Details-on-Demand Properties

Details-on-Demand Properties

The Details-on-Demand Properties dialog consists of several pages:

  • Appearance

  • Fonts

  • Columns

  • Virtual Columns

  • Sorting

  • To reach the Details-on-Demand Properties dialog:

  1. Right-click on the Details-on-Demand.

  2. Select Properties from the pop-up menu.

Note: For analyses with multiple data tables, settings for the Details-on-Demand must be defined in the Details-on-Demand properties dialog for each data table.

See also:

What is the Details-on-Demand?

Details-on-Demand Properties - Appearance

Details-on-DemandProperties-Appearance.png

Option

Description

Header row height (number of lines)

Specifies the height of the header row in number of lines.

Data row height (number of lines)

Specifies the height of all data rows in number of lines.

Number of frozen columns

Specifies how many columns on the left-hand side will be frozen, that is, not scroll out of sight when the scroll bar is moved to the right.

Show cell borders

Specifies whether or not cell borders should be visible between the cells in the table.

Allow table data export in Web Player

Specifies whether or not Web Player users should be able to export data from the Details-on-Demand table. If you do not have the appropriate license you cannot change this setting. Contact your Spotfire administrator if you have questions regarding licenses.

Column orientation

Specifies whether the columns should be displayed side-by-side (Vertical) in the Details-on-Demand or stacked (Horizontal), so that each column forms a row in the Details-on-Demand. The Automatic option will display the result vertically ("stacked") if a single row is marked, otherwise the columns are oriented side-by-side.

See also:

Details-on-Demand Properties

What is the Details-on-Demand?

Details-on-Demand Properties - Fonts

Details-on-DemandProperties-Fonts.png

Option

Description

Settings for

Lists all items for which you can change the font settings. Click to select an item in the list to change the font settings for that text in the visualization. Press Ctrl and click on more items to change the settings for multiple items simultaneously.

Font

Specifies the font to use for the selected items.

Font style

Specifies the font style to use for the selected items.

Size

Specifies the font size to use for the selected items.

 

See also:

Details-on-Demand Properties

What is the Details-on-Demand?

Details-on-Demand Properties - Columns

Details-on-DemandProperties-Columns.png

Option

Description

Available columns

Lists all columns in the data table available for selection.

[Type to search]

Type a search string to limit the number of items in the Available columns list. It is possible to use the wildcard character * in the search. See Searching in TIBCO Spotfire for more information.

Selected columns

Lists the columns selected to be displayed in the table, as well as the selected aggregation method used on each column (if any aggregation has been specified).

Add >

Adds the columns selected in the Available columns list to the Selected columns list.

< Remove

Removes the selected columns from the Selected columns list and sends them back to the Available columns list.

Remove All

Removes all columns from the Selected columns list.

Move Up

Moves the selected column up in the Selected columns list. The order of the columns in this list determines the order of the Y-axes in the table.

Move Down

Moves the selected column down in the Selected columns list. The order of the columns in this list determines the order of the Y-axes in the table.

Renderer

Lists the available renderers for the chosen column.

Settings...

Opens the settings dialog for the chosen renderer.

Add new columns automatically

Select the check box to make sure that any new columns added to the selected data table are also automatically added to the Details-on-Demand table.
New columns can appear when refreshing an information link, calculating new columns, etc.

See also:

Details-on-Demand Properties

What is the Details-on-Demand?

Details-on-Demand Properties - Virtual Columns

Details-on-DemandProperties-VirtualColumns.png

Option

Description

Available virtual columns

Lists the available virtual columns.

Add

Lets you add virtual columns.

Edit...

Opens the edit dialog for the chosen virtual column.

Remove

Removes the chosen virtual column.

Display name

Type the name to be displayed for the chosen virtual column.

See also:

Details-on-Demand Properties

What is the Details-on-Demand?

Virtual Columns

Details-on-Demand Properties - Sorting

Details-on-DemandProperties-Sorting.png

Option

Description

Sort by

Specifies the primary column you wish to sort the rows by.

Then by

Specifies the secondary and tertiary columns you wish to sort the rows by.

Ascending

Sorts the rows from the lowest to the highest value in the selected column.

Descending

Sorts the rows from the highest to the lowest value in the selected column.

Note: You cannot sort by a virtual column.

See also:

Details-on-Demand Properties

What is the Details-on-Demand?

Document Properties

How to Edit Document Properties


The dialog found under Edit > Document Properties contains settings that apply to the entire document. However, settings that affect the visualizations are found in the Properties dialog for a specific visualization. These dialogs are reached by clicking on the visualization of interest to make it active, and then selecting Edit > Visualization Properties.

The Document Properties dialog is divided into a number of different tabs. A number of common procedures are listed for each tab below.

General

  • To update the description or keywords for an analysis:

  1. Select Edit > Document Properties.

  2. On the General tab, make the desired changes in the Description or Keywords field.

    Comment: Keywords can be used to used to enhance organization and search capabilities in the library. Multiple keywords are separated by semicolons.

  3. Click OK.

  • To change the page navigation:

  1. Select Edit > Document Properties.

  2. On the General tab, select whether to use Titled tabs or Step-by-step navigation, or to remove the page navigation controls by selecting None.

    Comment: Titled tabs will show all pages as separate tabs, which can be dragged and dropped to change the order of pages. Step-by-step will show pages as numbered links to support a specific flow throughout the analysis. Use None if you want to define your own page navigation using actions in text areas. See also Pages.

  3. Click OK.

    Response: The layout is updated.

  • To specify a particular visualization area size:

If you are preparing an analysis for a different platform than the one you are currently using, you may want to lock the visualization area to a specific size.

  1. Select Edit > Document Properties.

  2. On the General tab, select the desired size under Visualization area size.

    Comment: If the desired size is not available, use the Custom size... option to specify an exact size in pixels. To find out the current visualization area size for a device, see below. An administrator can store specific sizes in the preferences to have them show up like any other presets in the Visualization area size drop-down list, see below.

  3. Click OK.

  • To find out the currently available visualization area size in TIBCO Spotfire:

If you know that you are going to present an analysis using a particular equipment (for example, a large screen in a conference room) you can look up the current visualization area size on that device and then design your analysis so that it is optimized for that particular screen size.

  1. On the device to use, open the analysis in TIBCO Spotfire.

  2. Select Help > Support Diagnostics and Logging.

  3. Go to the Diagnostic Information tab

  4. Look at the Visualization Area Size.

  • To find out the currently available visualization area size in Web Player:

You can optimize the analysis for usage in TIBCO Spotfire Web Player. For example, you may be designing a Web Player based dashboard to be viewed by end users with identical tablet devices (and identically configured web browsers).

  1. On the device to use, open the analysis in TIBCO Spotfire Web Player.

  2. Click on the arrow at the top right corner of the application, .

    Response: The Web Player menu is displayed.

  3. Select Other Tools > Current Visualization Area Size.

    Comment: Note that the current visualization area size is dependant on what browser and which toolbars and items are shown in the browser, so make sure that you are using the same settings as will be used in the presentation.

  4. Click Close.

  • To store a fixed size configuration in the preferences:

If you have administrative rights you can store a specific size in the preferences to have it show up like any other presets in the Visualization area size drop-down list of the Document Properties dialog.

  1. Select Tools >  Administration Manager.

  2. Go to the Preferences tab.

  3. In the Selected group list, click on the group for which to set the preferences.

  4. In the Preferences list to the right, click on the plus sign next to Application to expand the group.

  5. Click on ApplicationPreferences.

  6. Click Edit.

  7. Click Fixed Visualization Area Sizes.

    Response: A small button is displayed to the right of the preference.

  8. Click on the button.

    Response: The String Collector Editor is displayed.

  9. Enter the desired fixed size configurations and click OK.

Library

  • To view the URL for an analysis in the library:

  1. Select Edit > Document Properties.

  2. Go to the Library tab.

  3. Look at the Library URL or Web Player URL field.

  4. Click OK.

  • To determine who gets to add bookmarks for an analysis:

The creator of an analysis can specify the folder permissions required to add bookmarks in the Document Properties dialog.

  1. Select Edit > Document Properties.

  2. Go to the Library tab.

  3. Select an option in the Allow users to add new bookmarks drop-down list, or clear the check box to disable bookmarks for the analysis.

    Comment: See Details on Document Properties - Library for more information about the various options.

  4. Click OK.

  • To manually specify a preview image for an analysis:

  1. Select Edit > Document Properties.

  2. Go to the Library tab.

  3. Under Select preview image, select Manually.

  4. Click Browse....

  5. Locate the image to use and click Open.

    Comment: Switching back to Automatically will change the preview image to a snapshot of the active page when saving to the library. Select (No preview) if you do not want to show a preview.

  6. Click OK.

Markings

  • To change the color of marked items:

  1. Select Edit > Document Properties.

  2. Go to the Markings tab.

  3. Click to select the marking color you wish to change under Available markings.

  4. Click Edit....

  5. Change color using the drop-down list.

  6. Click OK twice.

    Response: The color of marked items is updated in all visualizations that use the selected marking.

    Comment: See Marking in Visualizations for more information about how you can use several different markings in your analysis.

  • To add a new marking:

Sometimes, you want to be able to mark items in one visualization without changing the marking in the other visualizations. This is especially useful when you have more than one data table in the document, or, when you create details visualizations. See Marking in Visualizations for more information.

  1. Select Edit > Document Properties.

    Comment: You can also define new markings from the Data page of any Visualization Properties dialog.

  2. Go to the Markings tab.

  3. Click on the New... button next to the Available markings list.

  4. Specify a Color for the new marking.

  5. Specify a Name.

  6. Click OK twice.

  • To change the default marking:

  1. Select Edit > Document Properties.

  2. Go to the Markings tab.

  3. Click on the marking that you want to use as default.

  4. Click on the Set as Default button below the Available markings list.

  5. Click OK.

Filtering Schemes

  • To show the filtering scheme menu in Filters panel:

Sometimes, you want to be able to filter items in one visualization without changing the filtering in the other visualizations. By showing the filtering scheme menu in the Filters panel you can easily change which filtering scheme to modify. See Filtering Schemes for more information.

  1. Select Edit > Document Properties.

  2. Go to the Filtering Schemes tab.

  3. Select the Show filtering scheme menu in Filters panel check box.

  • To create a new filtering scheme:

Sometimes, you want to be able to filter items in one visualization without changing the filtering in the other visualizations. Then it may be useful to add more than one filtering scheme to the analysis. See Filtering Schemes for more information.

  1. Select Edit > Document Properties.

  2. Go to the Filtering Schemes tab.

  3. Click New....

  4. Type a name and click OK.

  • To change the filtering scheme to use on a page:

If you want to use different filtering schemes on different pages, an easy way to switch filtering schemes is to show the filtering scheme menu in the filters panel, as described below. If you want one or two visualizations to use a different filtering scheme only, then this can be specified on the Data  page of the Visualization Properties dialog.

  1. Make sure that the filtering scheme menu is visible at the top of the filters panel.

    Comment: If the filtering scheme menu has been hidden, it can be shown by selecting Edit > Document Properties > Filtering Schemes tab and the check box Show filtering scheme menu in Filters panel.

  2. Click on the filtering scheme menu.

  3. Select the desired filtering scheme.

  • To rename a filtering scheme:

  1. Select Edit > Document Properties.

  2. Go to the Filtering Schemes tab.

  3. Click to select the filtering scheme to rename in the list.

  4. Click Rename....

  5. Type a name and click OK.

Data Functions

  • To refresh a data function:

If you have inserted a data function in your analysis and the underlying data has been changed you can update the calculation without needing to insert the data function again.

  1. Select Edit > Document Properties.

  2. Go to the Data Function tab.

  3. Click on the data function of interest.

  4. Click Refresh.

  5. Click OK.

  • To sync a data function with the library:

If a newer version of the data function in the document is available in the library you can click sync to update the data function.

  1. Select Edit > Document Properties.

  2. Go to the Data Function tab.

  3. Click on the data function of interest.

  4. Click Sync.

  5. Click OK.

Properties

  • To create a new document property:

Document properties can be used inside expressions controlling the visualizations. See Using Properties in the Analysis for more information.

  1. Select Edit > Document Properties.

  2. Go to the Data Function tab.

  3. Click on the data function of interest.

  4. Click Refresh.

  5. Click OK.

See also:

Details on Document Properties - General

Details on Document Properties - Library

Details on Document Properties - Markings

Details on Document Properties - Filtering Schemes

Details on Document Properties - Data Functions

Details on Document Properties - Properties

What is a Guided Analysis?

Details on Document Properties – General


The General tab of the Document Properties dialog is where you can add a description of the analysis and keywords to describe the content of the analysis. You can also specify what kind of page navigation to use in the analysis.

  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the General tab.

General Tab

DetailsonDocumentProperties–General.png

Option

Description

Description

An optional description of the analysis. The description could contain detailed information about the analysis enabling quick overviews.

Keywords (separated by semicolons)

Keywords specific to the content of the analysis. Keywords are separated by semicolons. This means that if you write "sales representatives; cost" it will be interpreted as two keywords, "sales representatives" and "cost".

Keywords are used to enhance organization and search capabilities.

Page navigation

Determines which type of page navigation to use in the analysis. See Pages to learn more about the different navigation modes. You can change the default page navigation for all new analyses on the Document page in the Tools > Options dialog.

   Titled tabs

Shows all pages as separate tabs, which can be dragged and dropped to change the order of the pages. See also What is a Guided Analysis?

   Step-by-step

Shows all pages as numbered links to support a specific flow throughout the analysis. See also What is a Guided Analysis?

   History arrows

Hides the page navigation, except for the page history arrows. Use this mode if you want to create your own flow throughout the analysis, by adding actions directly on the pages. See also What is a Guided Analysis?

Visualization area size

Determines the size of the area where visualizations are shown. Use Fit to window to automatically resize the visualization area after the current size of the Spotfire window.

If you are preparing an analysis for a different platform than the one you are currently using, you may want to lock the visualization area to a specific size. For example, use iPad Landscape or iPad Portrait to reduce the available visualization area size for each page and optimize the analysis for that platform.

An administrator can define other preset sizes using Administration Manager under Preferences > [Group] > Application > ApplicationPreferences > Fixed Visualization Area Sizes.

Tip: When Custom size... is selected the current visualization area size is shown by default, if no other custom sizes have been used previously.

Tip: The visualization area size is persisted in bookmarks so a set of bookmarks with different layouts can be used to switch between different area sizes.

Show tooltips as black text on light background

Select the check box if you want to display tooltips as black text on a light background rather than the default white text on black background.

Auto-hide scroll bars in table visualizations

Select the check box if you want scroll bars in tabular visualizations to be displayed only on mouse-over. If you clear the check box, then scroll bars will always be shown in tabular visualizations where some of the content does not fit on screen.

See also:

Details on Document Properties - Library

Details on Document Properties - Markings

Details on Document Properties - Filtering Schemes

Details on Document Properties - Data Functions

Details on Document Properties - Properties

How to Edit Document Properties

Details on Document Properties – Library


The Library tab of the Document Properties dialog is where you handle settings for how the document should behave in the library. This is also where you can copy links to the analysis to be used in other analyses, or to be provided to other people using e-mails.

  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the Library tab.

Library Tab

DetailsonDocumentProperties–Library.png

Option

Description

Library URL

If the analysis has been saved in the library, this URL allows you to open the file in TIBCO Spotfire. Copy the URL to send the link to a colleague.

Web Player URL

If the analysis has been saved in the library and Spotfire Web Player has been set up, this URL allows you to open the analysis in the Web Player. Copy the URL to send the link to a colleague.

Remember personalized view for each Web Player user

 

Select this check box if you want to allow users to continue where they left off from one time to another when working on the analysis in the Web Player. For example, a user can open the analysis in the Web Player, change the view (by filtering out some data, for instance), close the analysis, and then open the analysis again with the same filter settings.

Note: To make sure this works completely, it is necessary to define key columns for all the data tables in the analysis even if they are embedded.

Allow users to add new bookmarks

The ability to add and modify bookmarks can be restricted on two levels: the user licenses and the property settings on an analysis level. This check box determines the analysis level settings based on the users' library folder permissions.

Clear the check box if you do not want anyone to be able to add bookmarks to the analysis.

Select the check box to allow some or all users to add bookmarks and specify the permitted level using the drop-down list:

Private bookmarks only (all users) – allows all users to add private bookmarks but no public bookmarks are allowed.

Private (all users), public (write permissions needed) – allows all users to add private bookmarks but only users with Modify folder permissions or higher will be able to make bookmarks public.

Private and public bookmarks (write permissions needed) – allows only users with Modify folder permissions or higher to add any bookmarks.

Private and public bookmarks (all users) – allows all users to add both private and public bookmarks.

Select preview image

Select whether or not to show a preview image for this analysis when browsing for analyses in the library.

Automatically - sets the preview image to a snapshot of the active page when saving the analysis to the library.

Manually - allows you to manually select a previously saved image.

(No preview) - use this option to prevent any preview image from being shown in the library.

Browse...

When Select preview image has been set to Manually you can browse for an image to use in the preview.

Current preview image

Displays the currently selected preview image. If Select preview image has been set to Automatically and the analysis has not yet been saved to the library, then no preview will be visible. However, once saved to the library the active page when saving will be used as a preview image.

See also:

Details on Document Properties - General

Details on Document Properties - Markings

Details on Document Properties - Filtering Schemes

Details on Document Properties - Data Functions

Details on Document Properties - Properties

How to Edit Document Properties

Details on Document Properties – Markings


The Markings tab of the Document Properties dialog is where you specify which data table and marking to use as default when new visualizations are created. You can also add, edit or remove markings.

  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the Markings tab.

Markings Tab

DetailsonDocumentProperties–Markings.png

Option

Description

Available markings

Lists all markings available in the document. A marking is what specifies the color of marked items from one or more data tables.

New...

Opens a dialog where you can specify the name and color of the new marking.

Edit...

Opens a dialog where you can change the name and color of the selected marking.

Delete

Deletes the selected marking. If any visualizations use the deleted marking, they will be set to not allow marking. This can be changed on the Data page of the Visualization Properties dialog for each visualization concerned.

Set as Default

Sets the selected marking to be the default marking, that is, the marking that is used when new visualizations are created.

See also:

Details on Document Properties - General

Details on Document Properties - Library

Details on Document Properties - Filtering Schemes

Details on Document Properties - Data Functions

Details on Document Properties - Properties

How to Edit Document Properties

Marking in Visualizations

Details on Document Properties – Filtering Schemes


  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the Filtering Schemes tab.

DetailsonDocumentProperties–FilteringSchemes.png

Option

Description

Show filtering scheme menu in Filters panel

Select this check box to show the filtering scheme menu in the filters panel. You need to display this menu if you are to change the filtering scheme used on a page. However, when sending the finished document to a coworker for further analysis, you may want to hide the menu in order to save space in the filters panel and to reduce the risk of changing the filtering schemes by mistake.

Available filtering schemes

Lists all filtering schemes that have been defined in the document.

New...

Opens a dialog where you can add a new filtering scheme.

Rename...

Allows you to change the name of the selected filtering scheme.

Delete

Deletes the selected filtering scheme.

Note: You can create multiple different filtering schemes in the document. The filtering scheme can be specified per page or per visualization and it can be the same or different for different pages and visualizations. See Filtering Schemes for more information.

See also:

Details on Document Properties - General

Details on Document Properties - Library

Details on Document Properties - Markings

Details on Document Properties - Data Functions

Details on Document Properties - Properties

How to Edit Document Properties

Pages

Details on Document Properties – Data Functions


Once a data function has been executed  in an analysis it will be available for editing in the Data Functions tab of the Document Properties dialog. This is where you can change the input and output handlers, or refresh the calculation if anything has changed.

  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the Data Functions tab.

DetailsonDocumentProperties–DataFunctions.png

Option

Description

Available data functions

Lists all data functions that have been used in the current analysis.

Note that if a previously used data function has been replaced by a subsequent data function and all outputs from the first data function has been removed, then the first data function will no longer remain in this list.

Edit...

Opens a dialog where you can edit the input parameters of the selected data function. The output cannot be changed here. Execute the data function again if you need to change some output parameter settings.

Refresh

Refreshes the data function calculation, so that any changes to the input values are reflected in the output results.

Note: You need to click OK in the Document Properties dialog to actually start the data refresh.

Sync

Makes the document use an updated version of the function definition if a newer version is available in the library.

Note that synchronizing is only possible for data functions that have been saved to the library and executed via Insert > Data Functions. The Sync button will be unavailable for data functions run from the Register Data Functions Dialog. If the analysis is expected to have a long life span, it is recommended to only keep saved data functions in the analysis, so that they can be updated.

Delete

Deletes the selected data function.

See also:

Details on Document Properties - General

Details on Document Properties - Library

Details on Document Properties - Markings

Details on Document Properties - Filtering Schemes

Details on Document Properties - Properties

How to Edit Document Properties

Details on Document Properties – Properties


On the Properties tab it is possible to specify document properties, which are applicable throughout the document. For example, this could be a currency rate which can be used in calculations on several different columns. The document properties can be used inside expressions, using Insert Calculated Column or Custom Expressions, or, in reference lines in visualizations. You can also add property controls to a text area for an easy way of changing the property value. See Using Properties in the Analysis for more information.

  • To reach the Document Properties dialog:

  1. Select Edit > Document Properties.

  2. Click on the Properties tab.

DetailsonDocumentProperties–Properties.png

Option

Description

Property Name

Lists all properties that are currently available in the document.

MaxMissingTimeParts – Allows you to specify the maximum number of missing time parts that should be allowed to be replaced using the Compensate for missing values setting, available on the Appearance tab of some visualizations. See Working with Time Hierarchies for more information.

If you have defined custom properties for the document, these properties are also listed here.

Value

Lists the values of the defined document properties.

New...

Opens a dialog where you can add new document properties to the document.

Edit...

Opens a dialog where you can edit the selected document property.

Delete

Deletes the selected property.

See also:

Details on Document Properties - General

Details on Document Properties - Library

Details on Document Properties - Markings

Details on Document Properties - Filtering Schemes

Details on Document Properties - Data Functions

How to Edit Document Properties

Details on New/Edit Document Property


Custom document properties can be used throughout the analysis. For example, this could be a currency exchange rate which can be used in calculations on several different columns. Document properties can be used inside expressions, using Insert Calculated Column or Custom Expressions, or, in reference lines in visualizations. You can also add property controls  to a text area, for an easy way of changing the property value. See Using Properties in the Analysis for more information.

  • To reach the New Property dialog:

  1. Select Edit > Document Properties.

    Comment: The New Property dialog is also available by right-clicking in the Available properties list in the Insert Calculated Column and Custom Expression dialogs, as well as from the dialogs used when adding property controls to a text area.

  2. Click on the Properties tab.

  3. Click New....

NewProperty2.png

Option

Description

Property name

Specifies the name of the custom document property.

Data type

Specifies the type of the property.

Description

Optional. A description of the intended use of the property.

Value

Specifies the value of the property.

  • To reach the Edit Property dialog:

  1. Select Edit > Document Properties.

    Comment: The Edit Property dialog is also available by right-clicking in the Available properties list in the Insert Calculated Column and Custom Expression dialogs, as well as from the dialogs used when adding property controls to a text area.

  2. Click on the Properties tab.

  3. Click to select the property you wish to edit in the list of available properties.

  4. Click Edit...

EditProperty2.png

Option

Description

Property name

Specifies the name of the custom document property.

Data type

Specifies the type of the property.

Description

Optional. A description of the intended use of the property.

Edit...

Opens the Edit Value dialog where you can edit the description of the property.

Value

Specifies the value of the property.

Note: The only thing you can change using Edit Property is the description and the value of the selected property. If other settings are wrong, you need to delete the custom property and create a new one instead.

See also:

Details on Document Properties - Properties

Setting Defaults

How to Specify Default Values


Sometimes, you may want to reuse settings from one time to another. For example, you may want to specify that the marked items color should always be red when you start TIBCO Spotfire, or that the default visualization should be a table. This is done in the Options dialog. The default values you set are also saved for your profile on the server, so your default settings will be available even if you are using a different computer.

An administrator can also configure which settings should be default for certain user groups on the server. If you are a member of such a group, these defaults will take effect for you, unless you have made an active choice and set your own default value in the Options dialog.

  • To reach the Options dialog:

  1. Select Tools > Options....

See also:

Application

Fonts

Document

Visualization

Axis Formatting

Table

Cross Table

Graphical Table

Bar Chart

Line Chart

Combination Chart

Pie Chart

Scatter Plot

3D Scatter Plot

Map Chart

Treemap

Heat Map

Parallel Coordinate Plot

Summary Table

Box Plot

Data Functions

Compatibility

Options

Options – Application

 Options–Application.png

Option

Description

Show welcome screen when no file is loaded

Select this option to display the welcome screen when starting TIBCO Spotfire without a file loaded.

Number of recent files in File menu

Specifies how many of the most recently used files that should be shown in the File menu.

Toolbars

Select which toolbars should be visible when TIBCO Spotfire is started. Changes here take effect the next time TIBCO Spotfire is started.

Language

Select which language should be used for TIBCO Spotfire when it is started. This setting affects the language used in the application, but not in the data itself. Language settings for the data are controlled by the Column Properties. Changes here take effect the next time TIBCO Spotfire is started.

Renderer Settings...

Opens the Renderer Settings dialog that sets the default renderer for different content types. This is applicable when displaying links, images, geometries, etc. in table visualizations or as labels or tooltips.

Animations

Select this check box to enable smooth animations in the visualizations when data are filtered and visualizations are modified. Clear the check box if you experience performance problems when modifying the visualizations, to get a slight performance boost. This setting takes effect immediately.

Hardware acceleration

Select this option to enable hardware graphics acceleration. You should only disable the option if you experience odd problems relating to graphics in TIBCO Spotfire. If disabling this option alleviates the problem, you may have some problems with your graphics card or its software drivers. Try updating these and see if you can enable hardware acceleration again, as this greatly improves performance of TIBCO Spotfire. This setting takes effect immediately.

Anti-aliased lines and markers

Only available when Hardware acceleration has been switched off. Select this check box to render smooth lines and markers using anti-aliasing. Clearing the check box may increase the performance of the visualization rendering.

Set as Default Spotfire Version

Click on this button to make sure that the current version of TIBCO Spotfire is used when you open Spotfire analysis files via links to the library. Registering a default version is only necessary if you are running several different versions of TIBCO Spotfire on your computer (e.g., a gold version and a beta version).

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Fonts

Options–Fonts.png

Option

Description

Settings for

Lists all items for which you can change the font settings. Click to select an item in the list to change the settings for that text in the visualization. Press Ctrl and click on more items to change the settings for multiple items simultaneously.

Font

Specifies the font to use for the selected items.

Font style

Specifies the font style to use for the selected items.

Size

Specifies the font size to use for the selected items.

Apply to Document...

Opens the Apply Font Settings to Document dialog which allows you to update the text styles for the selected items in all visualizations on one or more pages at the same time. Note that this will override any font settings you may have made directly in a visualization.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Details on Apply Font Settings to Document

Options – Document

These settings generally take effect when you open new data and create a new document in TIBCO Spotfire.

Options–Document.png

Option

Description

Initial visualization when loading data

Select which visualization should be the default visualization to appear when loading new data.

Note: When you load map data into Spotfire, the initial visualization is always a map chart.

Create cover page for new analysis

Select whether or not a cover page should be created by default when creating a new analysis.

Filters panel open by default

Select whether or not the filters panel should be open when creating a new analysis.

Details-on-Demand open by default

Select whether or not the Details-on-Demand should be open when creating a new analysis.

Data panel open by default for in-memory data

Select whether or not the data panel should be open by default when adding a new in-memory data tables. (The data panel is always open by default when adding in-db data tables.)

 

List box filter size (number of rows shown)

Type or click to the number of rows you want to display in the list box filter.

Show tooltips as black text on light background

Select the check box if you want to display tooltips as black text on a light background rather than the default white text on black background.

Auto-hide scroll bars in table visualizations

Select the check box if you want scroll bars in tabular visualizations to be displayed only on mouse-over. If you clear the check box, then scroll bars will always be shown in tabular visualizations where some of the content does not fit on screen.

Save to library

 

   Override all in-memory data storage settings and embed all data

This setting specifies whether the "Override these settings and embed all data" check box in the Save as Library Item wizard should be selected by default or not.

Embedding all data may be useful if you are publishing analyses with in-memory data to the library and not all end users of the analyses have access to the original data source. See Preparing Analyses for TIBCO Spotfire Web Player for some useful tips.

Page navigation

Select whether to use Titled tabs, Step-by-step mode or no page navigation as default when creating a new analysis. See Pages and What is a Guided Analysis? to learn more about working with the different navigation modes.

   Titled tabs

Shows all pages as separate tabs, which can be dragged and dropped to change the order of the pages.

   Step-by-step

Shows all pages as numbered links to support a specific flow throughout the analysis.

   History arrows

Hides the page navigation, except for the page history arrows. Use this mode if you want to create your own flow throughout the analysis, by adding actions directly on the pages.

Default marking color

Select which color should be used for marked items as default.

Filters for in-memory data tables

This setting specifies whether or not filters should be created automatically for new in-memory data tables. In-database data tables are always managed manually.

   Create automatically for all columns
  

Select this option for automatic creation of filters for all columns.

   Manage manually

Select this option to manage the filters manually.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Titled tabs mode or Step-by-step mode

Global filters or Local filters

Options – Visualization

These settings take effect when creating a new visualization.

Options–Visualization.png

Option

Description

Visualization title visible by default

Select whether or not the title bar for new visualizations should be visible by default.

Visualization description visible by default

Select whether or not the description for new visualizations should be visible by default.

Gridlines visible by default

Select whether or not gridlines should be visible in new visualizations (where applicable) by default.

Zoom for axes

Select whether zooming should be automatic or require the use of manual zoom sliders, when creating a new visualization.

Tooltip format

Select whether the tooltip should show "Value names and values" or "Visualization properties and values". Generally speaking, the first option means that the tooltip will show the column names and corresponding values for the highlighted row. The second option means that the tooltip will show the name of the properties (rather than the corresponding columns) and the values.

Example "Value names and values":

Product: Bananas

Month: March

Sales: 3300

Example "Visualization properties and values":

Color: Bananas

X: March

Y: 3300

Default fixed color

Select which color should be used as the fixed color in all visualizations.

Default categorical color scheme

Select which scheme should be the default categorical color scheme for all visualizations. If the color scheme is categorical, only the colors from the color scheme will be used in the visualizations. No values will be matched between the color scheme and the visualizations. And if the selected color scheme contains any rules, they will not be included.

Note: Changing the default color scheme will not affect any already existing visualizations. The new default scheme will only be used in visualizations created after the change.

Default continuous color scheme

Select which scheme should be the default continuous color scheme for all visualizations. If the color scheme is categorical, only the colors from the color scheme will be used in the visualizations. No values will be matched between the color scheme and the visualizations. And if the selected color scheme contains any rules, they will not be included.

Note: Changing the default color scheme will not affect any already existing visualizations. The new default scheme will only be used in visualizations created after the change.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Axis Formatting

These settings take effect when creating a new visualization and affect only the axes in visualizations. For general information about formatting, see Formatting Overview.

Options–AxisFormatting.png

Option

Description

Default axis formatting

Defines the default settings that should be used for the axes.

Note: Settings are applied to visualizations created after the settings are made. Already existing visualizations will not be affected.

   Data type

Defines which data type the formatting should be applied to.

   Category

Lists the available categories for the selected data type. Each category in this list has separate settings. What categories are available depends on the data type. See Formatting Settings for a full description of all possible options.

Short number format

Short number format lets you format values with many digits to take up less space on the axis. For example, by using short number format you can set 1,000 to be displayed as 1k. You can define your own sets of symbols to use as short number format, but a standard symbol set is already defined. To learn more, see Short Number Format.

   Edit Symbol Sets...

Opens a dialog where you can edit or add symbol sets to use when you apply short number format.

Note: It is not possible to edit or delete the Standard symbol set.

Reset

Resets all properties, except added symbol sets, on this page to the default values. Symbol sets must be deleted manually by opening the Edit Symbol Sets dialog.

See also:

How to Specify Default Values

Formatting Overview

Column Properties - Formatting

Short Number Format

Details on Edit Symbol Sets

Details on Add/Edit Symbol

Details on Add/Rename Symbol Set

Options – Table

Options–Table.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new table.

Header row height

 

Specifies the height of the header row in number of lines.

Data rows height

Specifies the height of all data rows in number of lines.

Number of frozen columns

Specifies the number of columns on the left-hand side to be frozen, that is, they will not scroll out of sight when the scroll bar is moved to the right.

Show cell borders

Specifies whether or not cell borders should be visible in the table.

Allow table data export in Web Player

Specifies whether or not a Web Player user is allowed to export the data from the table.

Add new columns automatically

Select the check box to change the default setting so that any new columns in a data table are also automatically added to table visualizations using that data table.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Cross Table

Options–CrossTable.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new cross table.

Show cell borders

Specifies whether or not cell borders should be visible in the cross table.

Grand total for columns

Specifies whether or not the sum of all values in a column should be displayed.

Grand total for rows

Specifies whether or not the sum of all values in a row should be displayed.

Allow table data export in Web Player

Specifies whether or not a Web Player user is allowed to export the data from the cross table.

Display subtotals

 

   Before values

Places the subtotal values before the cell values on each level in the hierarchy of the vertical axis.

   After values

Places the subtotal values after the cell values on each level in the hierarchy of the vertical axis.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Graphical Table

Options–GraphicalTable.png


Option

Description

Legend visible by default

 

Specifies whether or not the legend should be open when creating a new bar chart.

Initial column when inserting new graphical table

Specifies the default column type to show up initially when inserting a new graphical table visualization.

Show

 

   Header row

Specifies whether or not the column headers at the top of the graphical table should be visible.

Tip: If you want to show or hide a specific column header, instead of the entire row of headers, open the Settings dialog for the column of interest, go to the General page and then select or clear the check box Show name in header.

   Row header name

Specifies whether or not the row header name should be visible.

This is the left-most header in the header row, displayed above the column containing the row headers in the graphical table. By default, the row header name is the name of the column on the row axis. If the row axis has a hierarchy of columns, then the row header name is the column at the lowest level in the hierarchy.

   Cell borders

Specifies whether or not cell borders should be visible in the graphical table.

   Only the n first rows

Select this check box if you want to display a limited number of rows in the graphical table. Note that the sort order in the graphical table affects which rows are shown.

Additional row spacing (in pixels)

Specifies how much extra space should be added to the cells for each row.

Dynamic items

 

   Sparkline color

Select which color should be used by default when creating a new sparkline. Note that this setting also affects new sparklines created in the text area.

   Bullet graph value color

Select which color should be used by default for the value bar when creating a new bullet graph. Note that this setting also affects new bullet graphs created in the text area.

   Bullet graph comparative value color

Select which color should be used by default for the vertical line representing the comparative value when creating a new bullet graph. Note that this setting also affects new bullet graphs created in the text area.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Bar Chart

Options–BarChart.png

Option

Description

Legend visible by default

 

Specifies whether or not the legend should be open when creating a new bar chart.

Orientation

Specifies whether the bars should be displayed horizontally or vertically by default.

Bar width

Drag the slider to modify the width of the bars.

Label orientation

Specifies whether labels should be displayed horizontally or vertically by default.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Line Chart

Options–LineChart.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new line chart.

Line width

Specifies the width of the lines in the line chart.

Show markers

Determines whether or not markers should be displayed for the axis values.

Marker size

Increases or decreases the overall size of the markers.

Break lines on empty values

Determines whether lines should be broken or remain connected when an empty value is found in the data used to create the line.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Combination Chart

Options–CombinationChart.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new combination chart.

Default series type

Specifies whether the default type of new series should be bars or lines.

Bars

 

   Bar width

Drag the slider to modify the width of the bars.

   Label orientation

Specifies whether labels should be displayed horizontally or vertically by default.

Lines

 

   Line width

Specifies the width of the lines in the combination chart.

   Show line markers

Determines whether or not markers should be displayed on the lines for the axis values.

   Marker size

Drag the slider to modify the overall size of the markers.

   Break lines on empty values

Determines whether lines should be broken or remain connected when an empty value is found in the data that was used to create the line.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Pie Chart

Options–PieChart.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new pie chart.

Sector value

Displays the value of the sector as a label. For example, sum of  sales for apples, if the sector size is defined by sum of sales and the color is defined by fruit or vegetable type.

Sector category

Displays the category defining  the sector as a label. For example, "apples", if the sector color is defined by fruit or vegetable type.

Sector percentage

Displays labels showing the percentage of the total that each sector represents.

Threshold

Excludes labels whose percentage falls below a given threshold.

Decimals

Specifies the number of decimals to display for the percentage value. The number specified here will also affect the number of decimals shown for pie sectors in the tooltip.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Scatter Plot

Options–ScatterPlot.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new scatter plot.

Default fixed shape

Defines which shape to use for all markers as default.

Sector value

Displays the value of the sector as a label. For example, sum of sales for apples, if the sector size is defined by sum of sales and the color is defined by fruit or vegetable type.

Sector category

Displays the category defining the sector as a label. For example, "apples", if the sector color is defined by fruit or vegetable type.

Sector percentage

Displays labels showing the percentage of the total that each sector represents.

Threshold

Excludes labels whose percentage falls below a given threshold.

Decimals

Specifies the number of decimals to display for the percentage value. The number specified here will also affect the number of decimals shown for pie sectors in the tooltip.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – 3D Scatter Plot

Options–3DScatterPlot.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new 3D scatter plot.

Show navigation controls

Specifies whether or not the navigation controls should be visible when a new 3D scatter plot is created.

Default fixed shape

 

Defines which shape to use for all markers as default.

See also:

How to Specify Default Values

Options – Map Chart

Options–MapChart.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new map chart.

Show navigation controls

Specifies whether or not the navigation controls should be visible when creating a new map chart.

Default fixed shape (when markers are used)

Defines which shape to use for all markers as default.

Sector value

Displays the value of the sector as a label. For example, sum of  sales for apples, if the sector size is defined by sum of sales and the color is defined by fruit or vegetable type.

Sector category

Displays the category defining the sector as a label. For example, "apples", if the sector color is defined by fruit or vegetable type.

Sector percentage

Displays labels showing the percentage of the total that each sector represents.

Threshold

Excludes labels whose percentage falls below a given threshold.

Decimals

Specifies the number of decimals to display for the percentage value. The number specified here will also affect the number of decimals shown for pie sectors in the tooltip.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Treemap

Options–Treemap.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new treemap.

Show hierarchy headers

Specifies whether or not the hierarchy headers should be shown when creating a new treemap.

Show labels

Specifies whether or not labels should be displayed when a new treemap is created.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Heat Map

Options–HeatMap.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new heat map.

One color scale per axis value

Specifies whether or not there should be one separate color scale for each axis value, or if one scale should apply to the entire visualization when creating a new heat map.

Dendrogram colors

 

   Pruning line color

Specifies the color to use for the pruning line in the dendrogram.

   First alternating cluster color

Specifies the first color to use for the clusters when pruning in the dendrogram.

   Second alternating cluster color

Specifies the second color to use for the clusters when pruning in the dendrogram.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Parallel Coordinate Plot

Options–ParallelCoordinatePlot.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new parallel coordinate plot.

Line width

Specifies the width of the lines in the parallel coordinate plot.

Break lines on empty values

Determines whether lines should be broken or remain connected when an empty value is found in the data used to create the line.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Summary Table

Options–SummaryTable.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new summary table.

Show cell borders

Specifies whether or not cell borders should be visible in the summary table.

Allow table data export in Web Player

Specifies whether or not a Web Player user is allowed to export the data from the summary table.

Add new columns automatically

Select the check box to change the default setting so that any new columns in a data table are also automatically added to summary table visualizations using that data table.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Box Plot

Options–BoxPlot.png

Option

Description

Legend visible by default

Specifies whether or not the legend should be open when creating a new box plot.

Box width

Specifies the width of all box plots.

Marker size

Specifies the size of all outer values.

Show distribution

Specifies whether or not the distribution of values should be shown as a histogram.

Show 95% confidence interval

Select the check box to display the confidence interval in the box plot as a black line next to the box.

Show comparison circles

Select the check box to display comparison circles in the box plot visualization. See What are Comparison Circles? for more information.

Alpha level

The level at which the difference between groups would be significant.

Show cell borders in statistics table

Specifies whether or not cell borders should be visible in the statistics table of the box plot.

Reference Points...

Opens a dialog where you can specify the shape and color of the reference points to show by default in the box plot.

Statistics Table...

Opens a dialog where you can specify what measures to show in the statistics table (if any), as well as the sorting to apply.

Reset

Resets all properties on this page to the default values.

Note that an administrator can configure which settings should be default for certain user groups on the server. If you are a member of such a group, the options on this page will be set to these defaults when you press the Reset button.

See also:

How to Specify Default Values

Options – Data Functions

Options–DataFunctions.png

Option

Description

TIBCO Spotfire Statistics Services

 

   Default

Use this option to connect to the default Spotfire Statistics Services server set up by the administrator.

   Custom URL

Use this option to run data functions using an alternative instance of Spotfire Statistics Services. For example, while you are developing new data functions you can use Spotfire Statistics Services Local Adapter to test your scripts.

   Use locally installed Enterprise Runtime for R

Select this check box to make sure that the locally installed Enterprise Runtime for R engine is used as the statistics engine whenever this is possible.

Note: Regardless of this setting, running data functions requires an available deployment of TIBCO Spotfire Statistics Services configured with the appropriate engine.

See also:

How to Specify Default Values

What are Data Functions?

How to Use Data Functions

Document Properties - Data Functions

Options – Compatibility

Options–Compatibility.png

Option

Description

Use 3.0 text area

In TIBCO Spotfire 3.1, the text area was changed from its old behavior in order to be able to add property controls and script action controls. However, the function links to tools previously available in the text area could no longer be added to a text area.

Select this option if you want to be able to create text areas which behave as they did in TIBCO Spotfire 3.0 and older. All new text areas within the document will then use the 3.0 style and functionality.

Note that while this check box is selected you cannot add script action controls and property controls in new text areas. Clear the check box to create new text areas that include the 3.1 functionality.

No text areas previously created within the document will be affected by the change, only the newly created ones. This means that you can create documents where some text areas use the old style and some use the new style. See also How to Use the Text Area.

Use 3.2 bookmark panel

In TIBCO Spotfire 3.3, a new version of the bookmarks functionality was created in order to allow the capturing of visualization properties along with the previously available settings for page, filtering, marking, etc. (See What are Bookmarks? for information about the new bookmarks.) However, for compatibility reasons, you can go back to using the 3.2 version of the bookmarks instead.

Select this option if you want to use the bookmarks panel that was available in TIBCO Spotfire 3.2 and older.

See also:

How to Specify Default Values

How to Use the 3.0 Text Area?

What are 3.2 Bookmarks?

Details
Details on Renderer Settings

The Renderer Settings dialog is used to set default values to use when displaying links, images, geometries, etc. in table visualizations or as labels or tooltips.

  • To reach the Renderer Settings dialog:

  1. Click Tools > Options....

  2. Select the Application tab.

  3. Click Renderer Settings....

DetailsonRendererSettings.png

Option

Description

Content Type

Lists the content types with a specified default renderer.

Default Renderer

Lists the default renderers associated with the different content types.

Add...

Opens the Add/Edit Default Renderer dialog, which lets you add a new default renderer for a content type.

Edit...

Opens the Add/Edit Default Renderer dialog, which lets you edit the default renderer for the selected content type.

Remove

Removes the selected default renderer.

See also:

Images in Tables

Virtual Columns

Details on Add/Edit Default Renderer

This dialog allows you to specify a default renderer for a particular content type.

  • To reach the Add/Edit Default Renderer dialog:

  1. Click Tools > Options....

  2. Select the Application tab.

  3. Click Renderer Settings....

  4. Click Add... (or click Edit... if an existing renderer is selected).

DetailsonAdd-EditDefaultRenderer.png

Option

Description

Content type

Enter the content type for which you want to add a default renderer.

Use the form toplevel/subtype, for example, text/html or image/jpg.

For Geometry columns the content type should be set to application/x-wkb if you want to show the geometry information as images.

If you are using TIBCO Spotfire Lead Discovery to display chemical structures from an SDFile then the content type should be set to chemical/x-mdl-molfile for the molfile column.

Note: Do not use a space when specifying the content type.

Default renderer

Select a default renderer from the list.

Settings...

If applicable, opens the Settings dialog for the selected renderer:

Link Renderer Settings

Image from URL Renderer Settings

Geometry Renderer Settings

See also:

Renderer Settings Dialog

Images in Tables

Details on Add/Edit Tooltip

Details on Apply Font Settings to Document

This dialog allows you to update multiple text styles in all visualizations on one or more pages at the same time. Using this dialog to adjust the fonts in the analysis will override any settings you may have made directly in a visualization.

  • To reach the Apply Font Settings to Document dialog:

  1. Select Tools > Options....

  2. Go to the Fonts page.

  3. In the Settings for list, select the items for which you want to change the font settings.

  4. Adjust the Font, Font style and Size settings to your liking.

  5. Click on Apply to Document....

DetailsonApplyFontSettingstoDocument.png

Option

Description

Apply settings for selected items to

 

   All pages

Use this option to apply the new font settings on all the pages in the analysis.

   Current page

Use this option to apply the new font settings to the current page in the analysis only.

   These pages only

Use this option to apply the new font settings to selected pages in the analysis. Press Ctrl and click to select more that one page.

See also:

Options - Fonts

How to Specify Default Values

Details on Edit Symbol Sets

This dialog is used to define a new symbol set to use as a short number format.

  • To reach the Edit Symbol Sets dialog:

  1. Select Tools > Options....

  2. Go to the Axis Formatting page.

  3. Click on Edit Symbol Sets....

DetailsonEditSymbolSets.png

Option

Description

Symbol set

Specifies which symbol set to edit.

   Add...

Opens a dialog where you can enter a name to use for the new symbol set.

   Remove

Removes the selected symbol set.

Note: The symbol set Standard cannot be removed.

Name

Displays the name of the selected symbol set.

   Rename...

Opens a dialog where you can enter a new name to use for the symbol set.

Defined symbols

Lists all the symbols, and their corresponding factors, that are defined for the selected symbol set. The symbols are sorted by factor.

   Add...

Opens a dialog where you can define a new symbol.

   Edit...

Opens a dialog where you can edit a symbol. Click on a symbol to select and edit it.

   Remove

Removes the selected symbol from the list.

See also:

Short Number Format

Options - Axis Formatting

How to Specify Default Values

Details on Add/Edit Symbol

Details on Add/Rename Symbol Set

Details on Add/Rename Symbol Set

This dialog is used when naming a new symbol set or renaming an already existing symbol set.

  • To reach the Add Symbol Set/Rename Symbol Set dialogs:

  1. Select Tools > Options....

  2. Go to the Axis Formatting page.

  3. Click on Edit Symbol Sets....

  4. Click on Add... next to the drop-down list to add a new symbol set. To rename an existing symbol set, select the symbol set you wish to rename from the drop-down list, then click on Rename....

DetailsonAdd-RenameSymbolSet.png

 

Option

Description

Name

Type a name to use for the symbol set.

See also:

Short Number Format

Details on Add/Edit Symbol

Details on Edit Symbol Sets

Options - Axis Formatting

How to Specify Default Values

Details on Add/Edit Symbol

These dialogs are used to define a new symbol or edit an existing symbol, to use as a short number format.

  • To reach the Add/Edit Symbol dialog:

  1. Select Tools > Options....

  2. Go to the Axis Formatting page.

  3. Click on Edit Symbol Sets....

    Response: The Edit Symbol Sets dialog is opened.

  4. In the Symbol set drop-down list, select the symbol set of interest.

    Response: The current symbols in the selected symbol set are displayed in the Defined symbols list.

    Comment: You cannot add symbols to or edit symbols in the Standard symbol set.

  5. To add a new symbol to the selected symbol set, click on Add... to the right of the Defined symbols list. To edit an existing symbol, select the symbol you wish to edit in the Defined symbols list, then click on Edit....

DetailsonAdd-EditSymbol.png

 

Option

Description

Exponent

Defines the power of 10 you want to replace with a symbol when using the short number formats. To replace 10^3 (1,000) with the symbol k, enter 3 in the field. The number 1,000 will then be displayed as 1k, and the number 1,250 will be displayed as 1.25k.

Symbol

Defines which symbol to replace the exponent with.

Note: You cannot use any numerical values as symbols.

See also:

Short Number Format

Details on Add/Rename Symbol Set

Details on Edit Symbol Sets

Options - Axis Formatting

How to Specify Default Values

Details on Reference Points

This dialog is used to specify default settings for the reference points shown in new box plots.

  • To reach the Reference Points dialog:

  1. Select Tools > Options....

  2. Go to the Box Plot page.

  3. Click on Reference Points....

Option

Description

Show real data points in box plot

 

   Color

Specifies the color of the selected reference point (the reference point on which you have clicked in the Show real data points in box plots list).

   Shape

Specifies the shape of the selected reference point (the reference point on which you have clicked in the Show real data points in box plots list).

Show abstraction of data ranges in box plot

 

   Color

Specifies the color of the selected reference point (the reference point on which you have clicked in the Show abstraction of data ranges in box plots list).

   Shape

Specifies the shape of the selected reference point (the reference point on which you have clicked in the Show abstraction of data ranges in box plots list).

See also:

Options - Box Plot

How to Specify Default Values

Details on Statistics Table

This dialog is used to specify default settings for the statistics table shown in new box plots.

  • To reach the Statistics Table dialog:

  1. Select Tools > Options....

  2. Go to the Box Plot page.

  3. Click on Statistics Table....

Option

Description

Available measures

Lists all statistical measures which can be shown in the statistics table.

Selected measures

Lists the statistical measures selected to be displayed in the statistics table.

Add >

Adds the measures selected in the Available measures list to the Selected measures list.

< Remove

Removes the selected statistical measures from the Selected measures list and sends them back to the Available measures  list.

Remove All

Removes all statistical measures from the Selected measures list.

Move Up

Moves the selected measures up in the Selected measures list. The order of the measures in this list determines the order of the measures in the statistics table.

Move Down

Moves the selected measures down in the Selected measures list. The order of the measures in this list determines the order of the measures in the statistics table.

Sort by

Specifies the measure by which you wish to sort the rows.

Ascending

Sorts the measures from the lowest to the highest value.

Descending

Sorts the measures from the highest to the lowest value.

See also:

Options - Box Plot

How to Specify Default Values

Panels and Popovers


In TIBCO Spotfire, some functionality can be reached through panels that can be shown either at all times or on demand only. The state of a panel is remembered per page, so you can use one state on one page and another on the next page.

By default, the Filters panel and Details-on-Demand are shown as docked panels to the right and the Tags panel, the Lists panel and the Collaboration panel will be shown to the left in the main window, if displayed. Bookmarks are shown in a popover by default. However, all panels can be shown in three different states: as docked panels,as popovers or as floating windows. The legend of all visualizations is a special case which can be shown in a docked state or as a popover only; it cannot be unattached to a floating window like the other panels and popovers. See Legend for more information.

No matter what state is used to display the panel, the content will always be remembered.

Docked Panels

Docked panels may be preferred when you interact with the content of the panel often, or, when you need to see the content at all times. For example, if you need to view the current state of the filters in the filters panel. Docked panels can be moved to the left, right or bottom part of the Spotfire window using drag-and-drop.

  • To move docked panels inside the TIBCO Spotfire main window:

  1. Click on the title bar of the panel you want to move.

  2. Drag the panel to its new position.

If no other panels are displayed where you want to place your panel, simply drag it to the edge of the main window and a shaded area will show you where the panel will be displayed. If there is no shaded area you will not be able to drop the panel in that position.

If one or more panels are already displayed where you want to place your panel, the shaded area will help you decide the order of the panels.

Popovers

Popovers are useful when the screen estate is limited and you only need a short interaction with the controls within the panel. For example, if you want to apply a bookmark and then continue with your analysis.

You can never display more than one popover at a time.

  • To undock a panel into a popover:

Click the Undock icon, , in the top right corner of the panel. The panel will change into a popover, located below its corresponding button in the toolbar.

You can click on the title of the popover and drag it to another position, temporarily. The popover will remain open on this position as long as you work within it. However, the next time the popover is opened it will be located below its corresponding toolbar button again.

  • To turn a popover into a docked panel:

Click the Dock icon, , in the top right corner of the popover. You can also double-click on the header of the popover to dock it.

Floating Windows

Floating windows can be used if you want to move that particular panel outside of the main Spotfire window. For example, if you want to keep the Collaboration panel open on a different screen.

  • To undock a panel into a floating window:

Double-click the title bar of the panel you want to undock.

Once undocked you can move the floating window by clicking the title bar and drag it to where you want it displayed.

  • To reposition floating windows:

Double-click on the title bar of the floating window to return it to the same position in the TIBCO Spotfire main window it was previously undocked from.

Note: Clicking the cross in the title bar will close the floating window. To bring back a hidden window, select View > and the name of the panel, or click the corresponding button on the toolbar.

FiltersButton.png

Filters

Details-on-DemandButton.png

Details-on-Demand

TagsButton.png

Tags

BookmarksButton.png

Bookmarks

ListsButton.png

Lists

CollaborationButton.png

Collaboration

Filters

What is a Filter?


Filters are used to narrow down the selection of data shown in the visualizations. For example, a filter could be adjusted so that data is only shown for a certain range of dates or for a certain number of food products. When you manipulate a filter, you can instantly see how the current setting affects the visible data in the visualizations.

When you load data into Spotfire, each column in the data table is automatically represented by a filter. The initial type of filter depends on the type of data in the column, but you can right-click on any filter and change the type if you like.

You can view and manage filters in a popover, in a docked panel, or as a floating window. See Panels and Popovers for more information. Click on the Filters button on the toolbar, FiltersButton.png, or select View > Filters to show or hide Filters. The Filters panel or popover will open in the mode it was opened the last time you had it open. The visibility of Filters is controlled per page, and the Filters visibility of new pages is inherited from the active page. The image below shows Filters as a docked panel with the different filter types.

FiltersBig.png

Number

Filter Type

1

Range Filter

2

Item Filter

3

Radio Button Filter

4

Check Box Filter

5

Text Filter

6

List Box Filter

7

Hierarchy Filter

Note: Binary columns are not represented by filters.

When more than one data table is available in the analysis, data table headers are automatically displayed above the filters. The active data table is indicated by bold typeface and a color stripe. Related data tables are indicated by stripes of the same color to the left of the filters, as seen in the image below.

 

Visualizations also get a color stripe in the title bar, indicating which data table the visualization is based on, when more than one data table is available in the analysis. The image below shows a bar chart title bar with a blue color stripe indicating that the bar chart is based on the same data table as the filters in the image above.

Filters.png

Once a filter has been manipulated, you can right-click on it and select Reset Filter to return the filter to its original state (all values selected). Selecting Reset All Filters, either from the pop-up menu in the filters panel, on the toolbar, or from the Edit menu, returns all filters, visible or hidden, in the active filtering scheme to their original state. Note that resetting filters will only affect modifications related to filtering of the data. For example, if you have cleared any check boxes in a check box filter, or narrowed down the range of values in a range filter. Other changes, such as renaming a filter, changing the filter type or scale, will not be affected.

When Filters are in a popover or a docked panel, you can get a quick overview of which filters have been modified by hovering over the Filters heading:

FiltersMiddle.png

The filters currently modified are shown together with their settings in a tooltip.

See also:

Range Filter

Item Filter

Radio Buttons

Check Boxes

Text Filter

List Box Filter

Hierarchy Filter

Filtering Schemes

Filters Panel Properties

Panels and Popovers

Filter Types

Range Filter


The range filter lets you narrow down the data shown to a range of values.

RangeFilter1.png

Interacting with the range filter

  • Use the left and right handles on the range filter to change the lower and upper limit of the range. Click and drag a handle to set it to the desired upper or lower limit. Only rows with values within the range will remain visible in the visualizations.

  • You can also use the keyboard to adjust the range when the filter is active. The left and right arrow keys will move the lower limit, and up and down arrow keys will move the upper limit.

  • Labels above the slider display the exact current range. Double-click on a label, enter a value in the field, and press Enter, if you want to set the range to a specific value:

RangeFilter2.png

  • Click and drag the middle part of the slider to move the current range sideways.

RangeFilter3.png

This provides a powerful way of sweeping over different "slices" of a data table. Observing the reactions of the other filters to such a sweep can give some interesting clues to correlation between parameters in the data table.

  • If the range filter shows dates, you can click on the calendar icon, CalendarIcon.png, to set a date for the slider.

An important feature of the range filter is that the values are distributed on a linear scale according to the values of the data. Thus, if values are unevenly distributed, this will be reflected in the range filter. Note that this is not the case with item filters, where values are distributed at even intervals along the range of the slider, regardless of the actual numeric values.

  • Changing the scale:

If the values of a column are unevenly distributed, you may want to change the scale used on the range slider to get better granularity when moving the slider handles. A column with many low values but only a few high values can benefit from using a Log10 scale. The scale setting does not alter the data in any way, just how the values are distributed along the slider.

  1. Right-click on the range filter to bring up the pop-up menu.

  2. Select Filtering Scheme Properties.

    Response: The Filtering Scheme Properties dialog is opened.

  3. Under Filter settings, select Scale: Log10.

  4. Click OK.

    Response: See example below.

    Example: In the example below the range filter represents a column with many low values but only a few high values.

    The first image below shows the filter with Original scale – the middle of the slider represents the value 250:

    RangeFilter4.png

  5. The image below shows the filter when the scale has been changed to Log10 Scale – the middle of the slider represents the value 26. It is now easy to set the left handle to specific low values:

    RangeFilter5.png

Note: Resetting a range filter by selecting Reset Filter from the right-click menu only affects the range of values in the filter. This means that if the scale has been set to Log10, it will not be changed back to Original.

  • Narrowing the range filter span to the currently filtered data:

  1. A lighter shade at either end of the slider indicates that currently there is no data visible in that part of the range because other filters in the analysis have filtered out those rows:

RangeFilter6.png

2. Double-click on the center of the range filter.

RangeFilter7.png

Response: The range filter is now adjusted, showing only the effective range:

  • Filtering the data range:

Sometimes you might wish to filter the data in a column using a smaller range than the full range of the column. If so, you can set a range filter to encompass only a smaller range.

  1. The original range filter span is 1 to 500.  

RangeFilter8.png

  1. Move the drag box to narrow down the selection.  

RangeFilter9.png

  1. Right-click on the range filter to bring up the pop-up menu.

  2. Select Filtering Scheme Properties.

    Response: The Filtering Scheme Properties dialog is opened.

  3. Under Filter settings, select Data range: Specific.

  4. Click on the Range from Filtered button.

  5. Click OK.  

    Response: The range filter expands to its full width, but with the range 296 to 500. Three dots are displayed to indicate that the range is not the original full range. 

RangeFilter10.png

  • Setting the data range without filtering:

You can also set the data range in the Filtering Scheme Properties dialog without filtering out any data beforehand.

  1. Right-click on the range filter to bring up the pop-up menu.

  2. Select Filtering Scheme Properties.

    Response: The Filtering Scheme Properties dialog is opened.

  3. Under Filter settings, select Data range: Specific.

  4. Enter Min and Max values in the provided fields.

  5. Click OK.

    Response: The range filter is displayed at its full width, but ranging between the values you provided in the Min and Max fields. Three dots are displayed to indicate that the range is not the original full range.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

Item Filter


The item filter is used to select a single item at a time, and lets you easily step between nearby items.

ItemFilter.png

Drag the slider to a new position, or click on the arrows at the edges of the slider to step through the values. You can also use the keyboard, where the left/right arrow keys move the slider one step in either direction, the Home key sets it to show (All), and the End key sets it to show (None). By double-clicking on the label above the slider you can type in a value to set, and the slider will snap to that value when you press Enter.

AllNone.png

The example above shows the values of an item filter and the special cases at the edges. When the slider is set to (All), it does not filter anything, thus, all items are shown. When the slider is set to (None) everything is filtered out, showing nothing. If the data table contains empty values, the (Empty) position will select these.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

Radio Buttons


In a radio button filter, each value is represented by a radio button.

RadioButtons.png

The radio buttons are mutually exclusive, that is, only one of the alternatives in the filter can be set at a time. However, an (All) option is always present, letting you select all values. A (None) option is also available, letting you filter out all the values, showing nothing. If there are empty values present, a radio button named (Empty) will be available. Selecting this radio button will filter to the empty values.

Values that have been filtered out by other filters are indicated with grey text. If you select a radio button that is grayed out, nothing will be shown in the visualizations since that value has been filtered out already.

When the filter is active, you can use the arrow keys on the keyboard to change the selected radio button.

For columns containing more than 500 values, radio buttons cannot be used as the filter type.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

Check Boxes


In a check box filter, each unique value in the column is represented by a check box. One or several check boxes may be selected or cleared to determine which values are to appear in the visualizations.

CheckBoxes.png

If there are empty values present, a check box called "Empty" will be available, letting you filter to those values.

Values that have been filtered out by other filters are indicated with gray text.

When the filter is active, you can use the arrow buttons and the spacebar on the keyboard to select and clear check boxes.

For quick selecting or clearing of all the values, right-click on the filter, and select Reset Filter to select all the check boxes, or Deselect All Values from the pop-up menu.

For columns containing more than 500 values, check boxes cannot be used as the filter type.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

Text Filter


The text filter lets you type a string of text, and any values that do not match the entered string are filtered out. As you type the string, the visualization is continuously updated with the values that begin with the current substring.

TextFilter.png

For example, consider a column with all the months of the year, January, February, March, ... , December.

Typed in text filter

Filtered rows

j

January, June, July

ju

June, July

jun

June

june

June

  • The text filter is not case-sensitive.

  • A blank space between two search words will result in rows containing both words.

  • Search for june OR may to find rows containing either of those months.

  • Use *son to search for rows ending in "son" (Anderson, Jamesson, etc.), and use *sun* to search for rows containing the letters "sun" somewhere (Sunday, Asunder, etc.).

  • Use quotation marks "sample batch alpha" to search for exact phrases.

  • Searching Date, Time and DateTime: Date and time can be formatted and displayed in a multitude of ways. When searching for date or time, always search using the same syntax as displayed in the document. The separators between year, month, day will be treated as word separators.
    For example, suppose dates are displayed in a table visualization in the YYYY-MM-DD notation.
    Searching for 05 would match dates such as:  2005-05-27 or 1998-12-05.
    Searching for *05 would match dates such as: 2005-12-30 or 1997-05-22 or 1879-10-05.
    Searching for 04-2 would match dates such as: 1998-04-21 or 2005-04-29.
    Time can sometimes be displayed using a notation with colon, for example: 11:45pm or 23:45.
    The colon is a protected keyword, which means that to search for such a time you need to enclose the time within quotation marks:  "23:45".  Just searching for 23:45 without the quotation marks will not provide any matches.

  • Searching Currency: Depending on how a column of currency values is presented, it can have various symbols before or after the digits. When searching, do not enter these symbols, just search for the value. For example, searching for 550 would find $550, £550 or 500kr.

For a listing of more search alternatives, see Searching in TIBCO Spotfire.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

List Box Filter


The list box filter is used to select a few values from a very long list of values present in the column.

ListBoxFilter.png

Select items in the list to filter to those items. Press Ctrl or Shift and click to select multiple values. If you click on the first alternative in the list, (All), no filter is applied, and all values are shown.

You can narrow down the list of values by typing a string of text in the search field above the list. The values that do not match the string are removed from the list. As you type the string, the list is continuously updated with the values that match the current substring. For list box filters in the text area, you need to press enter to search. By narrowing down the list, you can more easily find the values of interest, but this does not affect the applied filtering in any way. To apply filtering you must select values from the list. You can also enter an expression in the field to narrow down the list, using the rules described in Searching in TIBCO Spotfire. Remove the text string from the search field to make all the values reappear in the list.

The grey indicator on the right hand side of the filter shows where your selected values are located in the whole list. On mouseover, a tooltip appears, showing how many values have been selected in the list. If fewer than six values are selected, you also see those values in the tooltip.

See also:

What is a Filter?

Grouping Filters

Filters Panel Properties

Hierarchy Filter

What is a Hierarchy Filter?

A hierarchy filter is a filter type that shows hierarchical data in an expandable tree view. Good examples of data that can be used in a hierarchy filter are date and time information, or geographical data such as continents/countries/cities. The examples below illustrate those two uses of hierarchy filters.

Hierarchy filter from a date column

In this example, a column with various dates is shown as a check box filter. This column is used to create a hierarchy filter, grouping the dates into Year/Quarter/Month, instantly providing a better overview.

WhatisaHierarchyFilter1.png

In this case, you go from a linear series of dates that you can only manipulate on the most granular level, to a view that groups the dates from the column into a hierarchy you decide. You can select to show the dates as Year/Quarter/Month or Year/Month/Day or Year/Month/Week/Day or any other configuration you want.

Hierarchy filter from different but related columns

With date information, you often only need the data from one single column to create the hierarchy filter. However, for other data it might not be so easy for Spotfire to instantly understand they have a hierarchical order. In this case you can set up a new hierarchy filter by combining several related columns into a hierarchy. Such data can be geographical data as mentioned above, or perhaps product information such as Market Category/Product Category/Product.

WhatisaHierarchyFilter2.png

In this example, we see three separate columns (Continent, Country, City) originally displayed as three separate check box filters. These are then combined into one hierarchy filter, creating a structure that is easier to work with. The separate filters for the three columns will not be removed from the filters panel when you create a hierarchy from them, but you can manually hide them if you wish. Just right-click and select Hide filter for each filter you want to hide.

In order to combine many columns into a hierarchy filter, there must be an inherent hierarchy in the data. The data in the example above looks like this:

WhatisaHierarchyFilter3.png

To learn how to create a hierarchy filter, see Creating a Hierarchy Filter.   

See also:

Details on Insert Hierarchy

What is a Filter?

Grouping Filters

Filters Panel Properties

Creating a Hierarchy Filter

Creating a hierarchy filter is done by combining a selection of columns or date categories into a hierarchy. Note that combining columns into a hierarchy filter will not automatically remove all other filters representing the same columns—this must be done manually, if desired.

  • To combine several columns into a hierarchy filter:

  1. Right-click anywhere in the Filters panel.

  2. Select Insert Hierarchy....

    Response: The Insert Hierarchy dialog appears.

  3. If more than one data table is available in the analysis, specify which Data table to work on.

  4. Select the columns you want to include in your hierarchy filter from the Available columns list, and click Add >.

    Response: The columns appear in the Hierarchy list.

  5. Select a column in the Hierarchy list, and use the Move Up and Move Down buttons to position it correctly in the hierarchy.

    Comment: The least granular category should be placed at the top of the list. For example, Continent above Country above City.

  6. Enter a name for the new hierarchy in the Hierarchy name field.

  7. Click OK.

    Response: The new hierarchy filter appears at the bottom of the list of filters (for the specified data table) in the filters panel.

Note: Creating a hierarchy with a very large number of nodes may take a long time. It may also result in a hierarchy filter with too many check boxes to be practically useful. Use the Filtering Scheme Properties or the Column Properties to edit the hierarchy and remove the column with too many unique values if this should happen.

  • To create a hierarchy filter from a date column:

  1. Right-click anywhere in the Filters panel.

  2. Select Insert Hierarchy....

    Response: The Insert Hierarchy dialog appears.

  3. Select the Data table containing the desired date column.

  4. In the Available columns list, the date column has several sub-categories:
    CreatingaHierarchyFilter.png

  5. Select the sub-categories you want to include in your hierarchy filter from the Available columns list, and click Add >.

    Response: The sub-categories appear in the Hierarchy list.

  6. Remove unwanted entries from the Hierarchy list by selecting them and clicking < Remove. Most often you will not want to include the actual Date column in the hierarchy filter, only a selection of its sub-categories.

  7. Select an entry in the Hierarchy list, and use the Move Up and Move Down buttons to position it correctly in the hierarchy.

    Comment: The least granular category should be placed at the top of the list. For example, Year above Quarter above Month.

  8. Enter a name for the new hierarchy in the Hierarchy name field.

  9. Click OK.

    Response: The new hierarchy filter appears at the bottom of the list of filters (for the specified data table) in the filters panel.

See also:

What is a Hierarchy Filter?

Details on Insert Hierarchy

What is a Filter?

Grouping Filters

Filters Panel Properties

Filters Panel

Searching for Filters


When using a data table with many columns, you often have just as many filters. Sometimes it can be hard to find the filter you wish to manipulate by scrolling through the filters panel. A quick way to find a certain filter is to use the search function at the top of the filters panel.

Note: The filter search will not display filters that have been explicitly hidden. To search among all filters, you must first show them all. This can be done by clicking on the Show all link at the bottom of the filters panel.

  • To search for a filter:

  1. Type a search expression in the search field at the top of the filters panel.
    SearchingforFilters.png

  2. Any filters with names that do not match this are hidden from the filters panel. As you enter text, the filters panel is continuously updated with the filters whose names begin with the current substring.

  3. To show all filters again, just clear the search box.

You can use wildcards and boolean operators to search for parts and combinations of words. For a listing of the basic search syntax, see Searching in TIBCO Spotfire.

Filters specific search:

  • Type status:modified to find all filters which have been modified.

  • Type datatable:<datatablename> where <datatablename> for example could be "Sales Data", to find all filters for a specific data table if you have several in your analysis. Type a part of a name or use quotation marks to search for explicit data table names.

See also:

Changing Filter Name

Showing and Hiding Filters

Moving and Sorting Filters

Grouping Filters

Filters Panel Properties

Changing Filter Name


Changing a filter name is the same thing as changing the name of the corresponding column in the data table.

  • To change a column name:

  1. Right-click on a filter.

  2. Select Rename... from the pop-up menu.

  3. Type a new name for the column.

  4. Click OK.

    Response: The filter (and the corresponding column in the data table) now has the new name.

You can also change the name of a column from the Column Properties dialog. In this dialog you can also make other adjustments to the column. For example, change the sort order of the categories in a column, or change the formatting settings.

See also:

Searching for Filters

Showing and Hiding Filters

Moving and Sorting Filters

Grouping Filters

Filters Panel Properties

Showing and Hiding Filters


When using a data table with many columns, you often have just as many filters. If you are only interested in manipulating some of these, you can hide unwanted filers so that they do not appear in the filters panel. The corresponding columns in the data table are of course still present. The showing and hiding of filters is made per page.

  • To hide a filter:

  1. Right-click on a filter in the page of interest.

  2. Select Hide Filter.

    Response: The filter is hidden and is not seen in the filters panel.

  • To show hidden filters:

When one or more filters have been hidden on a page, the following link is displayed at the bottom of the filters panel:
ShowingandHidingFilters.png
Click on the Show all link to display all filters.

To show only a few of many hidden filters, you can do so from the Organize Filters dialog. Follow the steps below to learn how to do this:

  1. Right-click anywhere in the filters panel.

  2. Select Organize Filters....

    Response: The Organize Filters dialog is displayed.

  3. Find the filter you want to show in the Visible data tables, groups and filters list.

  4. Select the check boxes corresponding to the filters you want to make visible.

  5. Click OK.

    Comment: The changes made in the Organize Filters dialog only affect the active page. If you want to show these filters on more pages you need to repeat these steps for all pages where you want to display the filter. A shortcut for showing/hiding filters on multiple pages is to right-click and use the Apply Filter Organization feature. Note that when the active filter organization is applied to other pages, the complete filter organization is copied, including the visibility and sorting of groups and filters.

See also:

Searching for Filters

Changing Filter Name

Moving and Sorting Filters

Grouping Filters

Filters Panel Properties

Moving and Sorting Filters


You can change the order of the filters in the filters panel, either by moving them as you like, or by sorting them in alphabetical order.

  • To move a filter:

  1. Click on a filter and drag it to another position in the filters panel.

    Response: A horizontal black line appears, indicating where the filter will be placed.

  2. Drop the filter where you want to place it.

    Comment: You can only move a filter within the data table group that it belongs to, not to another data table.

  • To sort the filters and groups:

  1. In the filters panel, right-click somewhere inside the data table group that you want to sort. Avoid clicking inside a filter group since that will allow you to sort only the filters in that group.

  2. Select Sort Filters and Groups from the pop-up menu.

  3. Select whether you want to sort the filters and groups in Ascending or Descending alphabetical order.

    Response: The filters and groups within the selected data table group is sorted according to you selection. Note that it is only the actual filter groups that are sorted; filters within a filter group will not be sorted. To filter within a filter group, see below.

  • To sort the filters within filter groups:

  1. In the filters panel, right-click on the filter group that you want to sort.

  2. Select Sort Filters from the pop-up menu. (If you click on the filter group heading, select Sort Filters In Group from the menu).

  3. Select whether you want to sort the filters in Ascending or Descending alphabetical order.

    Response: The filters in the selected filter group are sorted according to you selection.

See also:

Searching for Filters

Changing Filter Name

Showing and Hiding Filters

Grouping Filters

Filters Panel Properties

Grouping Filters


To make it easier to get an overview of the filters, you can create groups in the filters panel, and place certain filters in these. You can only group filters that belong to the same data table. You can then expand or collapse various groups to only work with the filters you want for the moment. Groups can be hidden if you do not want them for a while, and you can also sort the filters in a certain group alphabetically. The groups are specified per page.

  • To create a new group:

  1. Right-click in the filters panel on the page of interest.

    Comment: If multiple data tables are used in the document, the group will be placed within the data table where the filter you right-clicked on belongs.

  2. Select New Group... from the pop-up menu.

    Response: The New Group dialog is opened.

  3. Enter a name for the new group.

  4. Click OK.

    Response: The new filter group is added to the filters panel in the position where you right-clicked.

  • To move filters into a group:

  1. Click and drag a filter, and drop it on the header of a group.
    or

  2. Right-click on a filter, select Move to Group from the pop-up menu and select a group.

    Comment: Select New Group from the menu to create a new group and move the filter to that group. Select (No Group) to move the filter out of the group.

  • To hide a group:

  1. Right-click on the header of the filter group you want to hide.

  2. Select Hide Group from the pop-up menu.

  • To show a hidden group:

  1. Right-click anywhere in the filters panel.

  2. Select Organize Filters... from the pop-up menu.

    Response: The Organize Filters dialog is opened.

  3. Select the check box of the group you want to make visible.

  4. Click OK.

    Response: The selected filter group is now shown in the filters panel.

    Comment: The changes made in the Organize Filters dialog only affect the active page. If you want to show the group on more pages you need to repeat these steps for all pages where you want the group to be displayed. A shortcut for adding a group to multiple pages is to right-click and use the Apply Filter Organization feature. Note that when the active filter organization is applied to other pages, the complete filter organization is copied, including the visibility and sorting of individual filters.

  • To sort the filters in a group:

  1. Right-click on the header of the group you want to sort.

  2. Select Sort Filters In Group from the pop-up menu.

  3. Select whether you want to sort the filters in Ascending or Descending alphabetical order.

    Response: The filters in the selected filter group are sorted according to you selection.

See also:

Searching for Filters

Changing Filter Name

Showing and Hiding Filters

Moving and Sorting Filters

Filters Panel Properties

Filters Panel

Filters Panel Properties

What you see in the filters panel depends on two different collections of settings, controlled via two dialogs:

  • Filtering Scheme Properties - Determines the types and specific settings for the filters in a filtering scheme. Note that the settings for a filtering scheme can affect filters on several different pages (all pages and visualizations that use that filtering scheme).

  • Organize Filters – Controls which filters should be visible on each page, as well as the sorting and grouping of the filters. These settings only affect the page on which you opened the dialog. If you want to reuse the filter organization from a page, you can right-click in the filters panel on that page and select Apply Filter Organization... and the page on which you want to apply the filter organization.

When a new page is created, the filtering scheme and filter organization is inherited from the active page.

  • To reach the Filtering Scheme Properties dialog:

  1. Right-click on the filters panel on a page that is using the filtering scheme whose properties you wish to change.

  2. Select Filtering Scheme Properties from the pop-up menu.

  • To reach the Organize Filters dialog:

  1. Right-click on the filters panel on the page you wish to change the filter organization for.

  2. Select Organize Filters... from the pop-up menu.

See also:

Filtering Schemes

What is a Filter?

Details on Filtering Scheme Properties

In the Filtering Scheme Properties dialog you can view and change the settings for the filters in a filtering scheme. The different filter types have slightly different settings as described below. The properties specified for a filter in this dialog affect all pages and visualizations where the current filtering scheme is used.

Note: The visibility and order of filters within a data table group are instead handled per page, using the Organize Filters dialog.

  • To reach the Filtering Scheme Properties dialog:

  1. Right-click in the Filters panel on a page where the filtering scheme of interest is used.

  2. From the pop-up menu, select Filtering Scheme Properties.

FilteringSchemeProperties.png

Option

Description

Data table

Specifies which data table to work with.

[Type to search filters]

If the list of filters is long, you can enter a search expression here to limit the list to show only filters that match your search.

[Filter list]

Lists all the filters in the selected data table. Click on a column header to sort the list according to the values in that column.

Column name

Displays the name of the currently selected column in the list. This is also the name of the filter.

Rename...

Opens the Rename Column dialog where you can change the name of the selected column.

Note: This will change the name of the filter, as well as all the instances of the column throughout the analysis.

Filter type

Specifies the type of the selected filter.

Filter settings
[Range Filter]

When selecting a range filter, you can modify the Data range and Scale.

Select either Automatic data range (default) or Specific data range.

If you selected Specific, you can either click the Range from Filtered button to set the data range to what the range slider is currently set to, or, you can manually enter a Min and Max value in the fields.

You can also select whether the scale should be Original or Log10 from the drop-down menu.

Filter settings
[Hierarchy Filter]

When selecting a hierarchy filter, you can modify the hierarchy by clicking on the Edit button that appears inside the Filter settings area.

Filter settings
[List Box Filter]

When selecting a list box filter, you can modify the appearance of the filter. The check box "Show search field" allows you to set if the search field is displayed in the filter or not. You can set the number of rows shown in the filter by typing a number or setting the number with the arrows.

Note: Most of the settings in this dialog, such as renaming a filter, changing the filter type or range filter scale, will not be affected when you select Reset Filter or Reset All Filters from the right-click menu in the Filters panel. Resetting a filter only affects modifications related to filtering of the data; for example, clearing any check boxes in a check box filter, or narrowing down the range of values in a range filter.

See also:

Filters Panel Properties

Details on Organize Filters

The Organize Filters dialog handles the visibility, grouping, and sorting of the filters on the active page.

Note: The filter type and settings for a specific filter are instead handled by the Filtering Scheme Properties dialog.

  • To reach the Organize Filters dialog:

  1. Right-click in the Filters panel on the page of interest.

  2. From the pop-up menu, select Organize Filters....

    Comment: You can also select Edit > Organize Filters... from the main menu to display the Organize Filters dialog for the active page.

Page-OrganizeFilters.png

Option

Description

Visible data tables, groups and filters

This list shows all filters, groups and data tables in the document. The check boxes can be selected to show/hide the filters from the filters panel. The order of the filters in this list also represents the order they occur in the filters panel.

Note: When filters are hidden, any filtering done prior to hiding the filter will remain for Web Player users, even if they do a filter Reset. However, Reset All Filters in TIBCO Spotfire Professional will reset all filters, including the hidden ones.

Rename...

Select a filter or group, and click this button to rename it. Note that renaming a filter also renames the column that the filter is based on.

New Group...

Click this button to create a new group.

Delete

Select a group, and click this button to delete it.

Move Up

Select a filter, group, or data table, and click this button to move it up in the list. This list represents the order the filters are displayed in the filters panel. Filters and groups cannot be moved to a different data table.

Move Down

Select a filter, group, or data table, and click this button to move it down in the list. This list represents the order the filters are displayed in the filters panel. Filters and groups cannot be moved to a different data table.

Move First

Select a filter, group, or data table, and click this button to move it to the top of the list.

Move Last

Select a filter, group, or data table, and click this button to move it to the bottom of the list.

Sort

In the drop-down menu, select either Ascending or Descending order to sort all items in the list.

Select All

Makes all filters, groups and data tables visible.

Clear All

Hides all filters, groups and data tables.

See also:

Filters Panel Properties

Details on New Group

  • To reach the New Group dialog:

  1. Right-click in the filters panel on the page of interest. If the analysis contains multiple data tables, make sure to click inside the data table in which you want to place the new group.

  2. Select New Group... from the pop-up menu.

OR

  1. Open the Organize Filters dialog.

  2. Under Visible data tables, groups and filters, select in which data table you want to create a new filter group.

  3. Click on New Group....

Option

Description

Name

Specify the name for the new group as it will be presented in the filters panel.

Tip: If you want a group to be available on more than one page, you can right-click on the page and select Apply Filter Organization... from the pop-up menu. The filter organization, such as which filters are shown or hidden as well as the order of data tables, groups and filters in the filters panel will be copied to all of the selected pages when this function is used. New pages automatically inherit the filter organization from the active page.

See also:

Filters Panel Properties

Details on Rename Column

  • To reach the Rename Column dialog:

  1. Right-click on the filter representing the column you want to rename.

  2. Select Rename... from the pop-up menu.

OR

  1. Open the Filtering Scheme Properties dialog.

  2. In the list of columns, select the column you want to rename.

  3. Click on Rename....

RenameColumn.png

Option

Description

Name

Specify a new name for the column.

Note: The filters use the same name as the columns, so renaming a filter will also change the column name in all other instances as well.

See also:

Filters Panel Properties

Details on Rename Group

RenameGroup.png

Option

Description

Name

Specify a new name for the group, as it should be presented in the filters panel.

Note: The group names are specified per page, so if you want the same name to be used on several different pages, it may be a good idea to first change the group name and then use the Duplicate Page feature to create the other pages. When a page is duplicated, all settings in the filters panel are inherited from the old page.

You can also right-click in the filters panel of the page containing the correct group name and select Apply Filter Organization.... In that case, the complete filter organization, including which filters are shown or hidden as well as the order of data tables, groups and filters in the filters panel will be copied to all of the selected pages.

See also:

Filters Panel Properties

Details on Apply Filter Organization

The Apply Filter Organization functionality allows you to reuse the layout you have created on one page and apply it on one or several other pages.

  • To reach the Apply Filter Organization dialog:

  1. In the Filters panel, right-click to display the pop-up menu.

  2. Select Apply Filter Organization....

    Comment: You can also select Edit > Apply Filter Organization... from the main menu.

ApplyFilterOrganization.png

Click to select all pages to which you wish to apply the filter organization from the active page.

See also:

Filters Panel Properties

Filtering Schemes


One of the main strengths of TIBCO Spotfire is the ability it gives you to filter your data, hence, to control what data shall be visible and used in some calculations. This means that you can show/hide data for specific categories, change the time range to look at, step through a sequence of values one at a time, etc.

You have the possibility to add your own filtering schemes, which can be applied to the analysis per page or per visualization. This gives you the complete freedom to control which pages and visualizations will affect each other. You can set up the filtering schemes to work on any combination of visualizations and/or pages in your analysis. For example, you can keep all the visualizations on all the pages related by using the same filtering scheme for all of them, or, you can choose to specify different filtering schemes for all the visualizations in an analysis, or any combination in between these two extremes. See Limiting What is Shown in Visualizations to learn how to set up a visualization to use a different filtering scheme than the filtering scheme used on the page.

The filter type is a part of the filter settings in a filtering scheme. This and other filter settings are controlled via the Filtering Scheme Properties. It is reached via the right-click menu in the filters panel. The selection of which filters are visible on a page is, in contrast, specified per page, via the Organize Filters option on the right-click menu.

  • To create a new filtering scheme:

  1. Select Edit > Document Properties.

  2. Go to the Filtering Schemes tab.

  3. Click New....

  4. Type a name and click OK.

  • To change the filtering scheme to use on a page:

  1. Make sure that the filtering scheme menu is visible at the top of the filters panel.

    Comment: If the filtering scheme menu has been hidden, it can be shown by selecting Edit > Document Properties > Filtering Schemes tab and the check box Show filtering scheme menu in Filters panel.

  2. Click on the filtering scheme menu.

  3. Select the desired filtering scheme.

See also:

What is a Filter?

Filtering in Related Data Tables


When you have multiple data tables that are related to each other in your analysis, and the data tables do not include exactly the same rows, you may want to handle filtering in the related data tables in different ways, depending on whether you are interested in the filtered rows or the filtered out rows. To help show the difference between the three options available, we use an example with two related data tables, DT1 and DT2. Both DT1 and DT2 contain rows that are not available in the other data table (pink and yellow), but they also contain common rows (blue):

FilteringinRelatedDataTables.png

A = Rows in DT1 that are not available in DT2.

B = Rows in DT1 that are available in DT2, but have been filtered out.

C = Rows in DT1 that are available in DT2 and included in the currently filtered rows of DT2.

F = The filtered rows (rows remaining after filtering) in DT2.

When the filtering management for DT2 is specified (from the DT1 data table header) the different options will give the following results:

Include Filtered Rows Only

The first option will make all row that are only present in DT1 disappear from the visualizations using DT1, since only the rows that are currently filtered in DT2 will be included. Hence, this option keeps only those rows that are present in both data tables (and have not been filtered out).

In the example above, this means that only the rows in C will remain after filtering in DT2.

Exclude Filtered Out Rows

The second option will remove those rows that have been filtered out from DT2 from all visualizations using DT1. Hence, this option keeps those rows that are filtered in DT2 as well as the additional rows from DT1.

In the example above, this means that A and C will remain after filtering in DT2.

Ignore Filtering

The third option is to ignore any filtering done in the related data table completely. This way, all rows that are available in the current data table will remain available.

In the example above, this means that A, B and C will all remain after filtering in DT2.

 

Note that you need to specify how each table should respond to filtering in all other related tables separately, to be certain of what will be shown in the visualizations after filtering.

  • To change the way filtering in a related data table affects a data table:

  1. Go to the Filters panel and locate the data table header for the data table of interest.

  2. Click on the Filtering in related data tables icon, DataTableIcon.png.

    Response: A drop-down menu is shown, where all related data tables are available.
    Note: If a relation has become invalid, the icon will turn red.

  3. Select the data table for which you want to change how filtering should affect the current data table, and select one of the options Include Filtered Rows Only, Exclude Filtered Out Rows or Ignore Filtering.

See also:

Filtering Schemes

Tags

What are Tags?


Tags are annotations that can be attached to marked rows. Each row can only contain a single tag from each tag collection, but the document can contain many tag collections simultaneously. A tag collection is basically a column containing a set of different tags, or annotations. Each tag collection is represented by a new column in the data table and can be used for filtering the data, just like any other column. Tags can only be attached to rows from a single data table, but the same tag collection and tag names can be used for multiple data tables.

Tags are similar to Lists, but Tags are specific to the current analysis, while with Lists you work with the same collection of lists all the time, from one session to the next. Combining the functionality from Tags and Lists can be very useful. You can create lists from tag collections, and you can create tag collections from lists. This means that Lists can be a way to transfer knowledge from one analysis to another, while Tags can be a way to use lists within an analysis. See What are Lists? to learn more.

You can view and manage Tags in a popover, in a docked panel, or as a floating window. See Panels and Popovers.

for more information. Click on the Tags button on the toolbar, TagsButton.png, or select View > Tags to open Tags. The Tags panel or popover will open in the mode it was opened the last time you had it open. The image below shows the docked Tags panel with two tag selections.

Tags.png

When more than one data table is available in the analysis, another level with the name of the data table is added to the tags panel. When attaching tags to marked rows, the active visualization defines which marking to get the marked rows from.

Note: If tags are to be reapplied after reloading linked data, you need to specify key columns that can be used to uniquely identify the rows in each data table. See Details on Select Key Columns for more information.

Note: Tags are not supported when working with in-database data.

See also:

How to Attach Tags to Marked Rows

Details on New Tag Collection

Details on New Tag

How to Work with Tags


Note: If tags are to be reapplied after reloading linked data, you need to specify key columns that can be used to uniquely identify the rows in each data table. See Details on Select Key Columns for more information.

  • To create a new tag collection:

  1. If Tags are not already visible, select View > Tags.

  2. If you have more than one data table in the document, click to select the data table where you want to add the tag collection.

  3. Click on the New Tag Collection button, NewTagCollection.png.

  4. Type a Name for the tag collection.

    Comment: This name will also be used as column name when the tag collection is viewed as a column in visualizations.

  5. Optionally, type a Description with details about the tag collection.

  6. Click New....

  7. Type a Tag name.

  8. Click OK.

    Response: The tag is added to the Tags list in the New Tag Collection dialog.

  9. Repeat steps 6 to 8 until you have added all tags that you want to include in this tag collection.

  10. Click OK.

    Response: The Tags are updated to display the new tag collection and its content.

  • To attach tags to marked rows:

  1. If Tags are not already visible, select View > Tags.

  2. In a visualization, mark the rows that you wish to tag.

    Comment: You can only attach one tag at a time.

  3. Select the tag you want to apply.

  4. Click on the Attach Tag to Marked Rows button, AttachTagtoMarkedRowButton.png.

    Comment: You can also drag the desired tag to the center of the visualization and drop it on the attach tag drop target.

    Response: The marked rows are annotated with the selected tag.

  5. Mark a new set of rows and repeat steps 3 to 4 until you have attached all tags that you want.

  • To mark all rows with a specific tag:

  1. If Tags are not already visible, select View > Tags.

  2. Make sure that a visualization using the desired data table and marking is active.

  3. Right-click on the tag of interest.

  4. Select Mark Tagged Rows in Active Visualization from the pop-up menu.

    Response: The rows with the selected tag are marked.

    Comment: You can also double-click on a tag to mark all rows with that tag immediately.

  • To mark all rows without a tag in a data table:

  1. If Tags are not already visible, select View > Tags.

  2. Make sure that a visualization using the desired data table and marking is active.

  3. Right-click on the Untagged item of the desired data table and tag collection.

  4. Select Mark Rows without Tags from the pop-up menu.

    Response: The untagged rows are marked.

  • To add the rows with a specific tag to the marked set:

  1. If Tags are not already visible, select View > Tags.

  2. Make sure that a visualization using the desired data table and marking is active.

  3. Press Ctrl on the keyboard while double-clicking on a tag.

    Response: The rows attached with that tag are added to the currently marked set.

  • To find rows with a specific tag within a previously marked set:

  1. If Tags are not already visible, select View > Tags.

  2. Make sure that a visualization using the desired data table and marking is active.

  3. Press Alt on the keyboard while double-clicking on a tag.

    Response: Only the rows that were previously marked AND also have the specified tag will remain marked.

  • To delete a tag or a tag collection:

  1. If Tags are not already visible, select View > Tags.

  2. Click on the tag or tag collection you wish to delete.

  3. Click on the Delete button, DeleteButton.png.

    Response: A confirmation message is displayed.

  4. Click OK.

  • To remove all tags for a specific tag collection:

  1. If Tags are not already visible, select View > Tags.

  2. For the desired data table, right-click on the tag collection item.

  3. Select Remove All Tags from the pop-up menu.

    Response: A confirmation message is displayed.

  4. Click OK.

    Response: All tags are removed for that specific tag collection (in the specific data table).

  • To remove all tags from marked rows:

  1. If Tags are not already visible, select View > Tags.

  2. Make sure that a visualization using the desired data table is active and that the rows from which you wish to remove tags are marked.

  3. Right-click on the Untagged item of the desired data table and tag collection.

  4. Select Remove Tags from Marked Rows from the pop-up menu.

    Response: All tags from the specific tag collection are removed from the marked rows.

    Comment: You can also drag the Untagged item and drop it on the drop target in the visualization.

  • To remove a specific tag from all rows:

  1. If Tags are not already visible, select View > Tags.

  2. For the desired data table, right-click on the tag that you want to remove from all rows.

    Comment: If you have more than one data table in your analysis and the same tag is available in more than one data table, you need to make sure that you right-click on the tag in the actual data table of interest. This command works regardless of which data table is active.

  3. Select Remove Tag from All Rows from the pop-up menu.

    Response: The selected tag is removed from all rows in the specific data table.

See also:

What are Tags?

Details on New Tag Collection

Details on New Tag

Tags Pop-up Menus

Details

Details on New Tag Collection


  • To reach the New Tag Collection dialog:

  1. If the tags panel is not already visible, select View > Tags.

  2. Click on the New Tag Collection button, NewTagCollection.png.

NewTagCollectionButton.png

Option

Description

Name

The name of the annotation column that will be added to the data table.

Description

Optional. A description of the tag collection and its contents.

Tags

Lists the tags that belong to the current tag collection. New tags are added to the list using New....

New...

Opens the New Tag dialog, where new tags can be added to the collection.

Edit...

Opens the Edit Tag dialog, where the name of the selected tag can be edited.

Delete

Removes a tag from the tag collection.

Move Up

Moves the tag up in the Tags list.

Move Down

Moves the tag down in the Tags list.

See also:

What are Tags?

How to Attach Tags to Marked Rows

Details on Edit Tag Collection

Details on New Tag


  • To reach the New Tag dialog:

  1. Make sure that a tag collection has been created.

  2. In the New/Edit Tag Collection dialog, click New..., or, in the tags panel, select the tag collection of interest and click on the New Tag button, NewTagButton.png.

NewTag.png

Option

Description

Tag name

Type the text that you want to use as an annotation on a marked set of rows.

See also:

What are Tags?

Details on Create Tag Collection

How to Attach Tags to Marked Rows

Details on Edit Tag Collection


  • To reach the Edit Tag Collection dialog:

  1. If Tags are not already visible, select View > Tags.

  2. Select the tag collection of interest and click on the Edit button, EditButton.png.

EditTagCollection.png

Option

Description

Name

The name of the annotation column that will be added to the data table.

Description

Optional. A description of the tag collection and its contents.

Tags

Lists the tags that belong to the current tag collection. New tags are added to the list using New....

New...

Opens the New Tag dialog, where new tags can be added to the collection.

Edit...

Opens the Edit Tag dialog, where the name of the selected tag can be edited.

Delete

Removes a tag from the tag collection.

Move Up

Moves the tag up in the Tags list.

Move Down

Moves the tag down in the Tags list.

See also:

What are Tags?

Details on New Tag Collection

How to Attach Tags to Marked Rows

Details on Edit Tag


  • To reach the Edit Tag dialog:

  1. Make sure that a tag collection has been created.

  2. In the New/Edit Tag Collection dialog, click Edit..., or, in the tags panel, select the tag of interest and click on the Edit button, EditButton.png.

EditTag.png

Option

Description

Tag name

Type the text that you want to use as an annotation on a marked set of rows.

See also:

What are Tags?

Details on New Tag Collection

How to Attach Tags to Marked Rows

Tags Pop-up Menus


There are different options available depending on which type of object you right-click on in the tags panel.

Data Table:

This pop-up menu is reached by right-clicking on a data table in Tags:

Option

Description

New Tag Collection...

Opens the New Tag Collection dialog where you can define a name and description for a new tag collection. You can also define which tags should be available in the new tag collection.

Tag Collection:

This pop-up menu is reached by right-clicking on a tag collection in the tags panel.

Option

Description

New Tag Collection...

Opens the New Tag Collection dialog where you can define a name and description for a new tag collection. You can also define which tags should be available in the new tag collection.

New Tag...

Opens the New Tag dialog where you can specify a new tag within this tag collection.

Edit Tag Collection...

Opens the Edit Tag Collection dialog where you can change the name and description of the tag collection. You can also define which tags should be available in the tag collection.

Delete Tag Collection

Deletes the tag collection and its corresponding column from the data table.

Remove All Tags

Removes all tags in this tag collection from all rows in the data table.

 

 

Tag:

This pop-up menu is reached by right-clicking on a tag in the tags panel.

Option

Description

Attach Tag to Marked Rows

Attaches the tag to the marked rows in the active visualization (only available when the active visualization is based on the same data table as the tag).

If some the marked rows already have a different tag from this tag collection  attached you will be able choose whether to attach the tag to rows without a tag only, or to remove the old tag and attach the tag to all marked rows.

Remove Tag from Marked Rows

Removes the selected tag from the set of marked rows.

Mark Tagged Rows in Active Visualization

Marks all rows that are tagged with the selected tag in the active visualization (only available when the active visualization is based on the same data table as the tag).

New Tag...

Opens the New Tag dialog where you can specify a new tag within this tag collection.

Edit Tag...

Opens the Edit Tag dialog where you can change the name of the tag.

Edit Tag Collection...

Opens the Edit Tag Collection dialog where you can change the name and description of the tag collection. You can also define which tags should be available in the tag collection.

Delete Tag

Deletes the specified tag from the tag collection. All rows that had the tag attached will be untagged.

Remove Tag from All Rows

Removes this specific tag from all rows (within this tag collection).

Untagged:

This pop-up menu is reached by right-clicking on an Untagged item in the tags panel.

Option

Description

Mark Rows without Tags

Marks all rows which currently has no tag attached for this tag collection.

Remove Tags from Marked Rows

Removes all tags in the current tag collection from the set of marked rows.

See also:

How to Work with Tags

Bookmarks

What are Bookmarks?


Bookmarks are snapshots of the state of an analysis. Add a bookmark to your analysis to be able to return to a state where you found something interesting when you marked or filtered out certain items. A bookmark can be applied at any time, allowing you to quickly return to a previously created view of the data. You can also share your insights with others by making your bookmarks available to other users, or by sending links to the bookmarks.

One of the most important uses of bookmarks is that they can be included as links in a text area. This helps you create guided analyses where the recipient of your analysis can click on action links or buttons to quickly move through several different views of the analysis.

A bookmark can capture one or more of the following: specific rows you have marked, active pages and visualizations, and even specific filtering that you have applied. A bookmark also contains information about visualization properties such as what column was used on an axis, what column was used to color by, etc., as well as any custom property values you have used on the active page. You decide what should be included in a captured state, but a bookmark that is added without making any adjustments will automatically include all those parts in the bookmark. It can be worth noting that a bookmark never recreates any removed visualizations or pages. Neither will any added pages or visualizations be removed when a bookmark is applied.

You can view and manage bookmarks in a popover, in a docked panel, or as a floating window. See Panels and Popovers for more information. Click on the Bookmarks button on the toolbar, BookmarksButton.png, or select View > Bookmarks to open Bookmarks. The Bookmarks panel or popover will open in the mode it was opened the last time you had it open. The image below shows the Bookmarks popover with three added bookmarks.

Bookmarks.png

Note: If bookmarks are to be reapplied after reloading linked data, you need to specify key columns that can be used to uniquely identify the rows in each data table. See Details on Select Key Columns for more information.

Private and Public Bookmarks

Bookmarks can be either private or public. Only you can see your private bookmarks, while public bookmarks are visible to all users of the analysis. An icon showing a single person indicates that a bookmark is private, and an icon with multiple people indicates that a bookmark is public. When adding a new bookmark, it is private by default. If you want to make it available to other users, you can right-click on the bookmark and select Public Bookmark from the menu. As seen in the popover above, private bookmarks are listed before public bookmarks. The bookmarks are also sorted in chronological order with the bookmark that was last updated at the top of the list.

Share Bookmarks

You can copy and share URLs pointing to specific bookmark states of an analysis. If a bookmark is private, it is still possible to send a URL including the private bookmark to a colleague in order to share that bookmark. See To create a URL to an analysis with a bookmark to learn how to do this. There are three different link types you can use, and which one to choose depends on the software available to the receiver of the link. See Bookmarks Pop-up Menu and Links to Analyses in the Library for more information about the link types. As mentioned earlier, you can also include bookmarks (both private and public) in an action control in a text area to make it available to other people. See To add a bookmark or bookmark part to a link, button or image in a text area to learn how to do this. Note that before you can copy and share links to bookmarks, the analysis must be published to the library. Before that, all bookmarks are stored locally, and have no link associated with them.

Indicators

There are a couple of indicators that let you know when you may want to pay attention to the bookmarks.

If bookmarks are added or updated while you do not have the popover or panel open, the bookmarks button in the toolbar will indicate this with a green arrow: BookmarksButtonGreenArrow.png. Click on the button to view the updates. This will make the arrow disappear.

If a bookmark becomes invalid, for example if the active page in the bookmark has been deleted, a red error provider is shown as seen below.

JohnsBookmark.png

Point to the error provider to see a tooltip with information about why the bookmark has become invalid.

Permissions

You can always apply any bookmarks that are visible to you in an analysis, but the ability to add and modify bookmarks can be restricted on two levels:

  • Library folder permissions – The creator of an analysis can specify the folder permissions required to add bookmarks in the Document Properties dialog. See Details on Document Properties – Library for a list of the available alternatives. To learn more about folder permissions in the library, see Permissions.

  • Licenses – Which license you have determines whether or not you will be able to add bookmarks to analyses.

Limitations on Bookmarks

  • It may not be possible to apply all parts of a bookmark if there are significant changes to the underlying data.

  • If data is refreshed, bookmarks can only reapply markings provided that key columns have been configured for that data table.

  • Bookmarks are saved per user, per document. If your Web Player is configured for “impersonation” in order to allow multiple users to log in anonymously, these users all impersonate a single user profile, so any private bookmarks captured by one user will be visible to all the other users under the same user profile.

  • Bookmarks cannot capture filtering which is created using Marked Rows > Filter To or Filter Out.

See also:

How to Use Bookmarks

Bookmarks Example Scenarios

How to Use Bookmarks


Note: If bookmarks are to be reapplied after reloading linked data, you need to specify key columns that can be used to uniquely identify the rows in each data table. See Details on Select Key Columns for more information.

  • To add a new bookmark:

  1. If Bookmarks are not already visible, select View > Bookmarks, or press CTRL+B on the keyboard.

    Comment: Press Ctrl+Shift+B to open the Add Bookmark Special dialog where you can select to add partial bookmarks. To learn more about the different parts, see Details on Add Bookmark Special.

  2. Type a name for the bookmark in the text field.

  3. Click on the Capture Bookmark button, CaptureBookmark.png, next to the name field.

    Response: The bookmark is added to the analysis.

  • To apply a bookmark:

  1. If Bookmarks are not already visible, select View > Bookmarks, or press CTRL+B on the keyboard.

  2. Double-click on the bookmark of interest, or click on the menu arrow for the bookmark of interest and then select Apply from the menu.

    Comment: Bookmarks can also be added to action controls (links, buttons or images) in a text area or as actions on dynamic items in a graphical table. In that case, clicking on the action control will apply the bookmark.

    Comment: You can also choose to apply just a part of the bookmark by selecting Apply Special from the menu. See Bookmarks Pop-up Menu to learn more about the different bookmark parts. For Filter Settings, you can select a few different apply methods from the pop-up menu.

  • To add a bookmark or bookmark part action to a link, button or image in a text area:

  1. Make sure that you have created a bookmark according to the steps above.

  2. Create a text area by clicking on the New Text Area button, NewTextAreButton.png.

    Response: An empty text area is displayed.

  3. Right-click on the text area and select Edit Text Area from the pop-up menu.

  4. Type any explaining text in the text field, and where you want the bookmark-link to be placed, click on the Insert Action Control button, InsertActionControlButton.png.

    Response: The Action Control dialog is displayed.

  5. On the Actions page, type a Display text to be used as the link or button text in the text area.

  6. Select the Control type from the drop-down list: Link, Button, or Image.

  7. In the Available actions list, click on the plus sign next to Bookmarks to expand the list, and then click on the desired bookmark.

    Comment: To add only a part of the bookmark, click on the plus-sign next to the bookmark of interest to expand the list, and then click on the bookmark part you want to add.

  8. Click Add.

    Response: The bookmark is added to the Selected actions list.

    Comment: If desired, you can add more actions to the same link.

  9. Click OK.

    Response: The action control is added to the text area.

  10. Exit the text area edit mode to test the action control.

  11. To create a URL to an analysis with a bookmark:

  1. If Bookmarks are not already visible, select View > Bookmarks, or press CTRL+B on the keyboard.

  2. Click on the menu arrow for the bookmark from which you want to create a URL.

  3. Select Copy Bookmark URL and choose one of the link types from the menu.

    Comment: To learn more about the different link types and when to use each of them, see Links to Analyses in the Library.

    Response: The link to the bookmark is copied to the clipboard and you can now paste it into, for example, an email or a web page.

  • To update a bookmark:

  1. If Bookmarks are not already visible, select View > Bookmarks, or press CTRL+B on the keyboard.

  2. Click on the menu arrow for the bookmark you wish to update and select Update Bookmark from the menu.

    Response: The bookmark parts available in the bookmark are updated with the current analysis settings.

  • To delete a bookmark:

  1. If Bookmarks are not already visible, select View > Bookmarks, or press CTRL+B on the keyboard.

  2. Click on the menu arrow for the bookmark you wish to delete.

  3. Select Delete from the menu.

    Response: The bookmark is removed from the analysis.

  • To use the 3.2 bookmarks panel:

For compatibility reasons, you can go back to use the 3.2 version of the bookmarks, this is possible using the following steps.

  1. Select Tools > Options.

  2. Go to the Compatibility page.

  3. Select the Use 3.2 bookmark panel check box.

  4. Click OK.

    Response: The next time you open the bookmarks panel, it will use the 3.2 style and behavior. (If the new bookmarks panel is open, you need to close it and reopen to see the change.)

    Comment: See How to Use 3.2 Bookmarks and What are 3.2 Bookmarks? to learn more about 3.2 bookmarks.

  • To convert 3.2 bookmarks to new bookmarks:

If an older analysis containing bookmarks is opened in TIBCO Spotfire 3.3 or later, and you are using the new Bookmarks popover or panel, a link will be shown at the bottom of the popover or panel. Click Convert to transform all old-type bookmarks to the new type. If you want to display the old bookmarks without converting them, you can go to Tools > Options, Compatibility page and select the Use 3.2 bookmark panel check box. Clear the check box to see the new type bookmarks.

See also:

What are Bookmarks?

Bookmarks Example Scenarios


The concept of Bookmarks has many potential usages and usage goals. The list below presents some possible scenarios where bookmarks can be useful.

BookmarksExampleScenarios1.png

 

The example flows in this section aim to describe how private and public bookmarks work across clients and between different users.

Private bookmarks – available to a user regardless of client used:

BookmarksExampleScenarios2.png

User A captures a private bookmark (A1) in TIBCO Spotfire and saves the analysis to the library.

User A opens the analysis using the Web Player. The analysis is opened in the saved state and private bookmark A1 is available. User A captures another private bookmark (A2).

User B opens the analysis using the Web Player. The analysis is opened in the saved state. No bookmark is available.

 

Private bookmarks can be used to save settings (an analysis state) from one occasion to another, in order to avoid repetitive work every time you open up an analysis. You can also use private bookmarks to capture an interesting state that later can be revisited, to analyze previously captured insights by sharing states with others or comparing them with other states in order to understand how different parameters (settings) affect the result.

Public bookmarks – available to all users of an analysis regardless of client used:

BookmarksExampleScenarios3.png

User A captures private bookmark A1 and public bookmark A3 in TIBCO Spotfire and saves the analysis to the library.

User A opens the analysis using the Web Player. The analysis is opened in the saved state and both private bookmark A1 and public bookmark A3 are available. User A captures another private bookmark (A2).

User B opens the analysis using the Web Player. The analysis is opened in the saved state. Public bookmark A3 is available.

 

Public bookmarks can be used as starting points for end users of an analysis. The captured states may guide users to interesting aspects in an analysis, or they might be used for navigation as an alternative to pages or links. By sharing captured states with other users you may also induce discussions of the insights made during analysis.

Private and public bookmarks as building blocks in action links:

BookmarksExampleScenarios4.png

User A captures a private bookmark (A1) in TIBCO Spotfire and ties it to an action link, then saves the analysis to the library.

User B opens the analysis using the Web Player. The action link sets bookmark state. No bookmark is available to user B.

 

User A captures a public bookmark (A2) in TIBCO Spotfire and ties it to an action link, then saves the analysis to the library.

User B opens the analysis using the Web Player. The action link sets bookmark state. Bookmark A2 is available.

 

Both private and public bookmarks can be used as building blocks in action links/buttons when setting up a guided analysis for other users. The action links/buttons typically guide users to insights or relevant starting points in the analysis. This also enables a way to include some restricted interaction possibilities in the application and a possibility to hide controls such as the filters panel.

Send private bookmark to colleague:

BookmarksExampleScenarios5.png

User A captures private bookmarks (A1 & A2) in the Web Player and wants to inform a colleague about insights captured in A1.

User B clicks link in email, which opens the analysis in the Web Player. The analysis is opened in A1 state. No bookmark is available.

 

A private bookmark can be used to pass on a captured insight to a specific colleague or group of colleagues only. This can easily be done by sending a URL that points to an analysis in a particular (bookmark) state.

Send public bookmark to colleague:

BookmarksExampleScenarios6.png

User A captures public bookmarks (A3 & A4) in the Web Player and wants to inform a colleague about insights captured in A3.

User B opens the analysis using the Web Player. The analysis is opened in A3 state. Both A3 and A4 are available.

 

Public bookmarks can also be referred to directly using a link.

Offline collaboration:

BookmarksExampleScenarios7.png

User A captures a private bookmark (A1) in TIBCO Spotfire and ties it to an action link, then saves the file and sends it to a colleague.

User B opens the analysis in TIBCO Spotfire. The action link sets the bookmark state. No bookmark is available to user B so A1 cannot be updated by user B.

 

User A captures a public bookmark (A2) in TIBCO Spotfire and ties it to an action link, then saves the file and sends it to a colleague.

User B opens the analysis in TIBCO Spotfire. The action link sets the bookmark state. Bookmark A2 is available.

See also:

What are Bookmarks?

How to Use Bookmarks

Bookmarks Pop-up Menu


Right-click on a bookmark to bring up the pop-up menu. You can always apply any bookmarks that are visible to you in an analysis, but whether or not you can add new bookmarks, or update, delete and otherwise modify existing ones depends on permissions defined by the creator of the analysis as well as your licenses. See Permissions to learn more.

Option

Description

Apply

Sets the analysis to the state defined by the bookmark.

Apply Special

Allows you to apply only a part of a bookmark. Select one or more of the following parts:

Page Layout and Visualizations – Applies the same layout and setup of the visualizations as when the bookmark was captured. This includes all specified visualization properties. For example, selections on the axes of a visualization, coloring, formatting, and which visualization features are shown or hidden.

Active Page – Sets the active page to the page that was active when the bookmark was captured.

Active Visualization – Sets the active visualization to the visualization that was active when the bookmark was captured.

Filter Settings – Sets the filtering and filter types to those used when the bookmark was captured. You need to select Set all filters, Set only adjusted filters, or Mark filtered rows from the submenu. See below for a description of these alternatives.

Filter Organization – Sets the layout of the filters panel (sort order, filter groups, hidden filters) to the same as when the bookmark was captured.

Markings – Marks the items that were marked in the visualizations when the bookmark was captured. Note that you can only apply this part of a bookmark if you use the same marking in the visualizations as when the bookmark was captured.

Properties – Applies any editable document, data table, and column properties used on the active page, as well as any property values referred to in a property control.

Rename

Allows you to change the name of the selected bookmark.

Copy Bookmark URL

Allows you to copy and share URLs pointing to a specific bookmark state for an analysis. Select one of the link types listed below. See Links to Analyses in the Library for more information about the different link types. Note that Copy Bookmark URL is only available when the bookmark has been stored in the library.

   Direct TIBCO Spotfire URL

Copies the URL for the analysis at the state of the selected bookmark, so that a link can be used to open the analysis directly using TIBCO Spotfire Professional. Select this option if you want to send your insights to a fellow analyst working in TIBCO Spotfire.

   Web Player URL

Copies the URL for the analysis at the state of the selected bookmark, so that a link can be used to open the analysis using TIBCO Spotfire Web Player. Select this option if you know that your target audience all use TIBCO Spotfire Web Player.

   Redirect Page for Unknown Clients

Copies a link to a redirect page where the end users of the link can choose whether they want to open the analysis using TIBCO Spotfire Professional or the Web Player. Select this option if you do not know what type of clients are available for the audience of the link or if you do know that some of the people have access to TIBCO Spotfire Professional and some have only the TIBCO Spotfire Web Player. For example, use this option to publish a URL in a blog post which can be read by people from many departments and at different positions in your company.

Share

The Share menu allows you to quickly share your analyses with other people you are collaborating with. By default, you can share bookmarks to tibbr®, if your organization uses the tibbr product, but your company may also have added access to other collaboration tools.

   Bookmark to tibbr®

If you are using tibbr in your organization, you can post the analysis in the selected bookmark state to the tibbr® flow.

Private Bookmark

Makes the selected bookmark private.

Public Bookmark

Makes the selected bookmark public.

Save as Private Bookmark

Creates a private copy of the selected bookmark.

Update Bookmark

Updates the bookmark to the current state in the analysis. Note that if you have captured a partial bookmark, only the parts included in the original bookmark will be updated.

Delete

Deletes the selected bookmark.

Filter Settings Submenu

Option

Description

Set All Filters

Applies the exact filter settings for the active filtering scheme, as stored in the bookmark.

Set Only Adjusted Filters

Keeps everything as it is in the filters panel except for those filters that were changed in the bookmark, which are updated.

Mark Filtered Rows

Uses the filter condition from the bookmark to mark rows in the analysis, but leaves the filtering exactly as it was before applying the bookmark.

See also:

What are Bookmarks?

How to Use Bookmarks

Details on Add Bookmark Special


This dialog allows you to select exactly which bookmark parts to include in your bookmark.

AddBookmarkSpecial.png

Option

Description

Name

The name of the bookmark.

Include

Select the bookmark parts you want to capture in your bookmark.

Page Layout and Visualizations – Captures the layout and the setup of the visualizations on the active page. This includes all specified visualization properties. For example, selections on the axes of a visualization, coloring, formatting, and which visualization features are shown or hidden.

Active Page – Captures which page is active when the bookmark is captured.

Active Visualization – Captures which visualization is active when the bookmark is captured.

Filter Settings – Captures the filtering and filter types used on the active page.

Filter Organization – Captures the layout of the filters panel (sort order, filter groups, hidden filters).

Markings – Captures which items are marked in the visualizations in the bookmark. Note that the active marking for a visualization is included in the Page Layout and Visualizations bookmark part.

Properties – Captures any editable document, data table, and column properties used on the active page, as well as any property values referred to in a property control.

Select All

Click this button to select all check boxes.

Deselect All

Click this button to clear all check boxes.

See also:

What are Bookmarks?

How to Use Bookmarks

3.2 Bookmarks

What are 3.2 Bookmarks?


In TIBCO Spotfire 3.3, a new version of the bookmarks functionality was created in order to allow the capturing of visualization properties along with the previously available settings for page, filtering, marking, etc. See What are Bookmarks? for information about the new bookmarks. However, for compatibility reasons, you can go back to use the 3.2 version of the bookmarks instead.

  • To use the 3.2 bookmarks panel:

  1. Select Tools > Options.

  2. Go to the Compatibility page.

  3. Select the Use 3.2 bookmark panel check box.

    Response: The next time you open the bookmarks panel it will use the 3.2 style and behavior. (If the new bookmarks panel is open you need to close it and reopen to see the change.)

  • To convert 3.2 bookmarks to new bookmarks:

If an older analysis containing bookmarks is opened in TIBCO Spotfire 3.3 or later, and you are using the new Bookmarks popover or panel, a link will be shown at the bottom of the popover or panel. Click Convert to transform all old-type bookmarks to the new type. If you want to display the old bookmarks without converting them, you can go to Tools > Options, Compatibility page and select the Use 3.2 bookmark panel check box. Clear the check box to see the new type bookmarks.

Description of 3.2 Bookmarks

Bookmarks are snapshots of the state of an analysis, which can be applied at any time, allowing you to return to a previously created view of the data.  A bookmark can update one or more of the following: what rows to be marked, the page and visualization to be active and what filtering to be applied. The bookmarks can optionally be sorted into different folders.

One of the most important uses of bookmarks is that they can be included as links in a text area. This helps you to create guided analyses where the recipient of your analysis file can click on action links to quickly move through several different views of the analysis.

Bookmarks are managed in the bookmarks panel, which can be displayed by clicking on the Bookmarks button on the toolbar, BookmarksButton.png, or by selecting View > Bookmarks. The visibility of the bookmarks panel is controlled per page. The panel visibility of new pages is inherited from the active page.

3.2Bookmarks.png

If a bookmark becomes invalid, for example if the active page in the bookmark has been deleted, a red error provider is shown:

 

Tip: The 3.2 bookmarks do not save the state of visualization properties, such as what column to use on an axis, what column to color by, etc. If you want to guide a user through visualization of different states, duplicate the visualization and create one visualization for each state instead. The duplicates can be moved by dragging and dropping on different pages, if desired.

See also:

How to Use 3.2 Bookmarks

Details on Capture Bookmark (3.2 Bookmarks)

How to Use 3.2 Bookmarks


In TIBCO Spotfire 3.3, a new version of the bookmarks functionality was created in order to allow the capturing of visualization properties along with the previously available settings for page, filtering, marking, etc. See What are Bookmarks? for information about the new bookmarks. However, for compatibility reasons, you can go back to use the 3.2 version of the bookmarks instead.

  • To use the 3.2 bookmarks panel:

  1. Select Tools > Options.

  2. Go to the Compatibility page.

  3. Select the Use 3.2 bookmark panel check box.

    Response: The next time you open the bookmarks panel it will use the 3.2 style and behavior. (If the new bookmarks panel is open you need to close it and reopen to see the change.)

  • To convert 3.2 bookmarks to new bookmarks:

If an older analysis containing bookmarks is opened in TIBCO Spotfire 3.3 or later, and you are using the new Bookmarks popover or panel, a link will be shown at the bottom of the popover or panel. Click Convert to transform all old-type bookmarks to the new type. If you want to display the old bookmarks without converting them, you can go to Tools > Options, Compatibility page and select the Use 3.2 bookmark panel check box. Clear the check box to see the new type bookmarks.

  • To add a new 3.2 bookmark:

  1. Click on the Capture Bookmark button, CaptureBookmarksButton.png, on the toolbar or in the bookmarks panel.

  2. Type a Name for the bookmark.

  3. Optionally, type a Description with details about the bookmark.

  4. Click OK.

    Response: The bookmark is added to the bookmarks panel and it can be used when adding links to a text area.

  • To apply a 3.2 bookmark:

  1. If the bookmarks panel is not already visible, select View > Bookmarks.

  2. In the bookmarks panel, double-click on the bookmark of interest or click on the bookmark of interest and then click on the Apply button, ApplyButton.png.

    Comment: Bookmarks can also be added to links or buttons in a text area. In that case, clicking on the link or button in the text area will apply the bookmark.

    Comment: You can also choose to apply just a part of the bookmark by clicking on one of the bookmark components and then click Apply. For the filter settings component, you can select a few different apply methods from the pop-up menu.

  • To add a 3.2 bookmark to a link or button in a text area:

  1. Make sure that you have created a bookmark according to the steps above.

  2. Create a text area by clicking on the New Text Area button, NewTextAreButton.png.

    Response: An empty text area is displayed.

  3. Right-click on the text area and select Edit Text Area from the pop-up menu.

  4. Type any explaining text in the text field, and where you want the bookmark-link to be placed, click on the Insert Action Control button, InsertActionControlButton.png.

    Response: The Action Control dialog is displayed.

  5. On the Actions page, type a Display text to be used as the link or button text in the text area.

  6. Select the Control type from the drop-down list: Link or Button.

  7. In the Available actions list, click on the plus-sign next to Bookmarks to expand the list, and then click on the desired bookmark.

  8. Click Add.

    Response: The bookmark is added to the Selected actions list.

    Comment: If desired, you can add more actions to the same link.

  9. Click OK.

    Response: The link or button is added to the text area.

  10. Exit the text area edit mode to test the link or button.

  • To update a 3.2 bookmark:

  1. If the bookmarks panel is not already visible, select View > Bookmarks.

  2. Right-click on the bookmark you wish to update and select Update... from the pop-up menu.

    Response: A dialog asking you if you are sure you want to update the bookmark is displayed.

  3. Click OK.

    Response: The bookmark components available in the bookmark are updated with the current analysis settings.

    Comment: It is normally recommended to update complete bookmarks instead of separate bookmark components. If you still choose to update a separate part of the bookmark, note that there may be some deviations between what is shown and what is actually applied. For example, the active visualization always takes precedence before the active page, so if the active visualization is on a different page than the one currently specified by the bookmark component, you will not end up on the page currently set as a bookmark component.

  • To delete a 3.2 bookmark:

  1. If the bookmarks panel is not already visible, select View > Bookmarks.

  2. Click on the bookmark you wish to delete.

  3. Click on the Delete button, DeleteButton.png.

  • To organize 3.2 bookmarks into folders:

  1. If the bookmarks panel is not already visible, select View > Bookmarks.

  2. Click on the Create New Folder button, NewFolderButton.png.

    Response: The New Folder dialog is displayed.

  3. Type a Folder name and click OK.

  4. Use drag-and-drop to move bookmarks and folders between folders.

See also:

What are 3.2 Bookmarks?

Details

Details on New Folder (3.2 Bookmarks)

If your analysis contains many 3.2 bookmarks, they can be arranged in separate folders to help locate specific bookmarks in the bookmarks panel.

  • To create a new folder:

  1. In the Bookmarks panel, click on the Create New Folder button, NewFolderButton.png.

    Response: The New Folder dialog is displayed.

  2. Type a name for the new folder.

    Comment: You can rename a previously created folder by right-clicking on it in the bookmark panel and selecting Edit... from the pop-up menu.

NewFolder.png

Option

Description

Folder name

Specifies the name of the new folder.

See also:

How to Use 3.2 Bookmarks

Details on Capture Bookmark (3.2 Bookmarks)

  • To reach the Capture Bookmark dialog:

  1. Click on the Capture Bookmark button, CaptureBookmarksButton.png, on the toolbar or in the Bookmarks panel.

CaptureBookmarkButton.png

Option

Description

Name

The name of the bookmark.

Description

Optional. A description of the bookmark and its contents.

See also:

What are 3.2 Bookmarks?

How to Use 3.2 Bookmarks

Details on Edit Bookmark (3.2 Bookmarks)

  • To reach the Edit Bookmark dialog:

  1. If the Bookmarks panel is not already visible, select View > Bookmarks.

  2. In the Bookmarks panel, click on the Edit button, EditButton.png.

EditBookmark.png

Option

Description

Name

The name of the bookmark.

Description

Optional. A description of the bookmark and its contents.

Created by

Shows the username who created the bookmark in the first place.

Created

Shows the date when the bookmark was created.

Modified

Shows the date when the bookmark was last modified.

Note: To update the settings of a previously added bookmark, right-click on the bookmark in the Bookmark Panel and select Update.... This will update the selected bookmark components with the current settings.

See also:

What are 3.2 Bookmarks?

How to Use 3.2 Bookmarks

Lists

What are Lists?


Lists represent captured knowledge from one or many data sources. For example, you may have identified a number of transactions where the sum of cost was high. You can then create a list containing the rows representing these transactions. This will make it easier to access the interesting items for further analysis based on the findings. See Creating Lists, to learn more about adding new lists.

Lists are available from one session to the next and are automatically saved when you modify them. Lists are similar to Tags, but with Lists you work with the same collection of lists all the time, while Tags are specific to the current analysis. Combining the functionality from Lists and Tags can be very useful. You can create tag collections from lists, and you can create lists from tag collections. This means that Lists can be a way to transfer knowledge from one analysis to another, while Tags can be a way to use lists within an analysis. See What are Tags? and Creating Tag Collections from Lists to learn more.

You can view and manage lists in a popover, in a docked panel, or as a floating window. See Panels and Popovers for more information. Click on the Lists button on the toolbar, ListsButton.png, or select View > Lists to open Lists. The Lists panel or popover will open in the mode it was opened the last time you had it open. The image below shows the docked Lists panel.

The Lists panel user interface

TheListsPanelUserInterface.png

Number

Description

1

Toolbar

2

Identifier Selector

3

Lists

4

List Items

5

Search Field

Toolbar

The toolbar, consisting of buttons and a menu, is located in the upper part of the panel. You can perform most of the actions in the Lists panel from the toolbar.

Identifier selector

The identifier column selector is where you select which column in the data set to use as the identifier. You can choose the identifier from any column that contains any of the following types: string, integer, longinteger, or date. In the example above, the column "Number" was selected. It contains values representing ID numbers of sales transactions. The values in the chosen column are the ones that are displayed as list items when you select one or more lists.

Lists

The collection of lists has a hierarchical structure where the top level, named "Lists", cannot be removed. In the example above, five lists have been added on the level below the top level. Two of them, "High Cost Transactions" and "High Sales Transactions" contain three sublists each. You can expand and collapse lists with sublists by clicking on the +/- sign to the left of the list name. The number of items in a list is displayed to the right of the name. In the example above, the selected list (highlighted in blue) "High Cost Transactions" does not contain any list items itself, but its sublists do, as can be seen in the parentheses beside the sublists' names: Fruit (6), Spices (4), and Vegetables (10). To view the items of a list, click on the list to select it. The items will then be displayed in the lower part of the panel. To learn more about selecting lists, see Selecting Lists and List Items.

List items

In the lower part of the panel, the list items of the selected lists are displayed. In the example above, the items of the "High Cost Transactions" list are displayed. To learn more about how to select lists and items, see Selecting Lists and List Items.

Search field

You can search lists, list items, and annotations by entering a text string in the search field. To learn more about searching in the Lists panel, see Searching the Lists Panel.

Read-only mode

As mentioned, you always work with the same list collection. This means that if more than one instance of Spotfire is open, you can only modify lists and items in one of these instances. The Lists panel will be in read-only mode in the other Spotfire instances. This is indicated by the read-only button, ReadonlyButton.png, on the toolbar. Click on the button to update the Lists panel view in case it was modified in the other instance. When a read-only instance of the Lists panel becomes available for editing again you must click the button, ReadOnlyButtonInstance.png, before you can make any changes.

See also:

Selecting Lists and List Items

Creating Lists

How To Use Lists

Selecting Lists and List Items


To select a list or item of interest, click on it. To select many lists or items, press Ctrl or Shift while clicking. You can also use Ctrl + click to deselect lists or items.

You can choose whether to show or hide all sublist items of a selected list. In the example below, the panel to the left shows the selected list’s items, but not the sublists’ items. The panel to the right displays the selected list’s items as well as the sublists’ items.

Lists.png

  • To show/hide sublist items:

  1. On the Lists toolbar, select Menu > Show All Sublists.

    Response: All the items in the sublists of the selected list or lists are displayed in the lower part of the panel.

See also:

What are Lists?

Marking Items in Visualizations

Marking Items in Visualizations


You can mark items in visualizations by interacting with lists or list items in the panel.

  • To mark items in visualizations:

  1. Make sure you have selected the correct identifier column in the drop-down list.

  2. Select the lists or list items of interest in the Lists panel.

  3. On the Lists toolbar, select Menu > Mark Items.

    Response: The items corresponding to the selected lists or list items are marked in the visualizations.

    Comment: You can also double-click on a list or list item to mark the corresponding items in the visualizations.

  • To mark items automatically:

  1. On the Lists toolbar, select Menu > Mark Automatically.

    Response: When you click on a list or list item, the corresponding rows will now become marked automatically.

See also:

What are Lists?

Selecting Lists and List Items

Creating Lists


You can create new lists in two ways. One way is to mark items in a visualization and make a new list based on these. Another way is to add a list from list logic, which means that you create a new list by comparing existing lists using boolean operators. This lets you determine which list items are present or not in a certain combination of lists. The result of the comparison is then added as a new list in the Lists panel.

  • To add a list from marked items:

  1. If Lists are not already visible, select View > Lists.

  2. Select a list under which you want the new list to be added. To learn more about how to select lists and list items, see Selecting Lists and List Items.

  3. In the visualization, mark the items you want to include in the new list.

  4. Right-click in the visualization to display the pop-up menu.

  5. Select Marked Rows to open the submenu.

  6. Select New List from Marked....

    Response: The New List from Marked dialog is opened.

  7. In the Name field, type a name to use for the list.

  8. Optionally, select a column to group the list by.

    Comment: If you select to group the list by a column, then the new list will have sublists, one sublist for each value in the column.

  9. Click OK.

    Response: The new list is added as a sublist in the selected list. If more than one list is selected, the new list will be added on the hierarchical level below the closest common parent of the two lists.

Example:

CreatingLists.png

In the example above, two lists which are not on the same hierarchical level are selected. If you add a list from these selections, the new list will be added to the level just beneath the closest common parent of the selected lists; in this case, High Cost Transactions. If the two selected lists are on the same hierarchical level, the new list will be added on the same level as the selected lists.

  • To add a list from List Logic:

  1. If Lists are not already visible, select View > Lists.

  2. Optionally, select the lists you want to compare in the Lists panel.

  3. Click on the New List from List Logic button on the Lists panel toolbar, ListLogicButton.png.

    Response: The New List from List Logic dialog is opened. If you selected one or more lists in the panel before opening the dialog, the check boxes corresponding to these lists will be selected in the dialog.

  4. Type a Name to use for the list in the provided text field.

  5. In the Lists to use list, choose which lists to compare by selecting the corresponding check boxes.

    Comment: When you select a list, all its sublists are automatically included in the selection. Clear the check boxes for the sublists you do not want to include.

  6. Under Include items appearing, select one of the three methods of logical operation to use when comparing the previously selected lists.

    Comment: You can select either In all lists (AND), In any list (OR), or ONLY in this list. If you select ONLY in this list, you need to select a list in the drop-down menu.

  7. When done, click OK to close the dialog.

    Response: The new list is added in the Lists panel. Note that lists created from List Logic are always added to the top level in the list hierarchy.

See also:

What are Lists?

Details on New List from Marked

Details on New List from List Logic

Modifying Lists


You can modify existing lists in a number of ways, which are described below. For more information, see separate sections about Importing Lists and Items and Exporting Lists and Items.

Rearranging the lists and items

Use drag and drop to change the order of lists and/or list items in the Lists panel. You can move several lists or items at a time. Just select the ones of interest and drag them to the desired location.

Sorting list items

To sort the items in a list, right-click on that list and select Sort List Items from the pop-up menu. If a list contains sublists, you will need to sort each sublist separately.

  • To add marked items to a list:

You can add items to an existing list by marking rows in a visualization.

  1. If Lists are not already visible, select View > Lists.

  2. Select the list to which you want to add items.

    Comment: You can only add items to one list at a time. To learn more about how to select lists, see Selecting Lists and List Items.

  3. In the visualization, mark the items of interest.

  4. Right-click in the visualization to display the pop-up menu.

  5. Select Marked Rows > Add Marked to List....

    Response: The marked rows are added as items to the selected list. The added items are selected in the lower part of the panel to make it easier to see which ones were added.

  • To remove marked rows from a list:

You can remove items from an existing list by marking rows in a visualization.

  1. If Lists are not already visible, select View > Lists.

  2. Select the list from which you want to remove items.

    Comment: You can only remove items from one list at a time. To learn more about how to select lists, see Selecting Lists and List Items.

  3. In the visualization, mark the rows of interest.

  4. Right-click in the visualization to display the pop-up menu.

  5. Select Marked Rows > Remove Marked from List....

    Response: Items that correspond to the marked rows and are present in the selected list are removed from that list.

    Comment: Items in sublists will not be removed.

  • To delete lists or list items:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or item you want to delete.

  3. Select Delete from the pop-up menu.

  4. Click Yes in the dialog that opens.

    Response: The selected list (including any sublists) or list item is removed.

    Comment: Alternatively, you can select the lists or items you wish to delete and press the Delete key.

  • To cut, copy, and paste in the panel:

  1. If Lists are not already visible, select View > Lists.

  2. Click on the list or item you want to cut or copy.

    Comment: Press Ctrl and click to select multiple objects in the Lists panel.

  3. Right-click to open the pop-up menu.

  4. Select Cut or Copy.

    Response: The selected object is placed on the clipboard. If you selected Cut, the selected object is also removed from the panel.

  5. Right-click on the list to which you want to paste the contents of the clipboard.

  6. Select Paste from the pop-up menu.

    Response: The list or list item is pasted into the selected location in the Lists panel.

    Tip: List items can also be pasted into tools outside of Spotfire, such as a text editor.

See also:

What are Lists?

Importing Lists and Items


You can import lists or list items previously exported from TIBCO Spotfire or TIBCO Spotfire DecisionSite. List files exported from Spotfire have the extension .lists, while list files from DecisionSite have the extension .srp or .xml. List item files always have the extension .lst when exported from either Spotfire or DecisionSite.

  • To import lists:

  1. If Lists are not already visible, select View > Lists.

  2. In the panel, select the list to which you want to add the imported list.

    Comment: You can only import to one list at a time. To learn more about how to select lists and list items, see Selecting Lists and List Items.

  3. Open the Menu, and select Import > Lists....

  4. In the Import Lists dialog, locate the list file of interest.

  5. Click Open.

    Response: The imported lists appear in the specified location in the Lists panel.

  • To import list items:

  1. If Lists are not already visible, select View > Lists.

  2. In the panel, click to select the list to which you want to add the imported list items.

    Comment: You can only import to one list at a time.

  3. Open the Menu, and select Import > List Items....

  4. In the Import List Items dialog, locate the list item file of interest.

  5. Click Open.

    Response: The imported list items appear in the specified location in the Lists panel.

See also:

What are Lists?

Exporting Lists

Exporting Lists and Items


You can export lists or list items to a file. When you export an entire list, the structure is kept exactly as it appears in the Lists panel or popover, including any sublists. You can export many lists to the same file. Exported lists get the file extension .lists.

When you export individual list items, the items will be listed in the exported file with no structure from the original list preserved. This means that if you export all the list items from a list with sublists, you will be unable to see which sublist the individual items belonged to. Exported list item files get the extension .lst.

  • To export lists:

  1. If Lists are not already visible, select View > Lists.

  2. Select the list or lists you want to export. Sublists are automatically included when you click on a list header.

    Comment: To select more than one list, press Ctrl and click on the lists to include. To learn more about how to select in the Lists panel, see Selecting Lists and List Items.

  3. Open the Menu, and select Export > Selected Lists....

  4. Specify a file name and a location where you want to save the list or lists.

  5. Click Save.

    Response: The file is saved to the specified location.

  • To export list items:

  1. If Lists are not already visible, select View > Lists.

  2. Select the list or lists in the upper part of the Lists panel.

  3. In the lower part of the Lists panel, select the list items you want to export.

    Comment: To select more than one list or item, press Ctrl and click on the lists or items to include. See Selecting Lists and List Items to learn more.

  4. Open the Menu, and select Export > Selected List Items....

  5. Specify a file name and a location where you want to save the list items file.

  6. Click Save.

    Response: The items or lists are saved as an LST file at the specified location.

See also:

What are Lists?

Importing Lists

Creating Tag Collections from Lists


You can create tag collections from one or more lists. Tag collections created from Lists work in the same way as those created in the Tags panel. To learn more about tags, see What are Tags?

  • To create a new tag collection:

  1. If Lists are not already visible, select View > Lists.

  2. Select the lists you want to include in the new tag collection.

  3. Click the Create Tag Collection button, CreateTagCollectionButton.png, on the Lists toolbar.

    Response: A new tag collection, named Lists Tag Collection, is added to the tag panel. A corresponding column is also added to the data table.

Note: Tag collections have flat structures. This means that if you create a tag collection from lists containing sublists, their hierarchical structure will not be preserved in the tag collection.

See also:

What are Tags?

What are Lists?

Selecting Lists and List Items

Searching the Lists Panel


You can search for lists, list items, and annotations by entering a search string in the search field located at the bottom of the Lists panel or popover.

Fruit.png

Searching for a simple text string, as in the example above, will by default look for matching text in the names of lists and list items. You can use wildcards and boolean operators to search for parts and combinations of words. For a listing of the basic search syntax, see Searching in TIBCO Spotfire. See below for a listing of search properties specific to Lists.

When you search for a specific word or combination of words, the results will be the list or lists that contain your search terms. The matching lists will be bolded in the upper part of the panel as in the example below.

FruitList.png

If you were searching for individual list items, click on the bolded lists to see those list items that match your search. You can use the arrow buttons on the right-hand side of the search field to step through the search matches.

Lists specific search:

Keyword

Example

Function

<text string>

fruit

Locates lists and list items with the specified word (or word part) in the name.

name:<name of list or list item>

name:apple

 

name::apple

Locates lists and list items with the specified word in the name.

The first example will return all lists and list items containing your search string, such as “Apple”, “apples”, “apples and bananas”, and so on.

The second example will return only lists and list items which match your search string exactly.

list:<name of list>

list:fruit

Locates lists with the specified word (or word part) somewhere in the name.

lists:<number of lists>

lists:2

 

lists:>2

Locates lists that contain the specified number of sublists. Note that a sublist will only count as one list even if that sublist itself contains sublists.

The first example will return lists containing exactly two sublists, while the second example will return lists with two sublists or more.

item:<name of list item>

item:apple

Locates lists that contain list items with the specified word (or word part) somewhere in the name.

items:<number of list items>

items:14

 

items:<14

Locates lists that contain the specified number of list items. Note that the number of items is always calculated on individual lists.

The first example will return lists containing exactly 14 items, while the second example will return lists with 14 items or fewer.

annotation: <content of annotation>

annotation:important

Locates lists or list items with an annotation containing the specified words.

Note: If the annotation has a specified name, you need to use the search property described below instead.

<annotation name>:<content of annotation>

"sum of sales":"below 8,000"

Locates lists or list items with the specified annotation name and where the annotation contains the specified words. Note that you must provide the entire annotation name and enclose it in quotation marks.

type:<type of wanted search matches>

type:list

type:item

The first example will locate all the lists in the panel. The second example will locate all the list items.

This search property is especially useful in combination with other search properties. For example:

type:list AND annotation:important

This will find all the lists where the annotation contains the word "important".

  • To display the search field:

  1. On the Lists toolbar, click on the Toggle Search Field button, ToggleSearchFieldButton.png.
    OR

  2. Select Menu > Search....

    Response: The search field is displayed at the bottom of the Lists panel or popover.

  • To hide the search field:

  1. On the Lists toolbar, click on the Toggle Search Field button, ToggleSearchFieldButton.png.
    OR

  2. To the right of the search field, click on the Hide Search Field button,  HideSearchFieldButton.png.

    Response: The search field is hidden.

You can also perform a search based on marked items in a visualization. This is a way to find if any of the items that you have marked in a visualization are also included in any of the lists in the lists collection.

  • To search for marked items in lists:

  1. Mark the items of interest in a visualization.

  2. Right-click in the visualization to display the pop-up menu.

  3. Select Marked Rows > Search Marked in Lists.

    Response: The matching lists are bolded in the upper part of the panel. In the search field, a search string corresponding to the marked rows will be displayed, as seen below.

See also:

What are Lists?

Searching in TIBCO Spotfire

Working with Annotations


You can add annotations to both lists and list items. To view annotations, hover with the mouse pointer over the list or list item of interest. A tooltip with the annotations will appear, as seen in the example below.

WorkingwithAnnotations.png

The tooltip shows the name of the list, "High Cost Transactions", followed by the annotation text. "Sum of Cost" is the name of the annotation, but specifying a name is optional. If you add many annotations to the same list or list item, the annotations will be listed vertically after each other in the tooltip. It is possible to search for lists and list items with a particular annotation. See Searching the Lists Panel to learn more about how to search for lists with annotations.

  • To add a new annotation:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or list item to which you want to add an annotation.

  3. Select List Properties or List Item Properties from the pop-up menu.

    Response: Depending on whether you clicked on a list or a list item, either the List Properties dialog, or the List Item Properties dialog is opened.

  4. Click on the New... button.

    Response: The New Annotation dialog is opened.

  5. Enter the annotation in the Annotation text field.

    Comment: Press Ctrl + Enter to get a line break in the annotation text.

  6. Optionally, enter a name in the Name field.

  7. When done, click OK.

    Response: The annotation is added to the Annotations list.

  8. To add more annotations to the same list or list item, repeat steps 4 to 7, and click OK when done.

    Response: The annotations are added to the selected list or list item.

  • To edit an annotation:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or list item with the annotation you want to modify.

  3. Select List Properties or List Item Properties from the pop-up menu.

    Response: Depending on whether you clicked on a list or a list item, either the List Properties dialog, or the List Item Properties dialog is opened.

  4. Select the annotation you want to edit in the Annotations list.

  5. Click on the Edit... button.

    Response: The Edit Annotation dialog is opened.

  6. Make the desired changes in the Annotation and Name fields.

  7. When done, click OK.

    Response: The annotation is updated in the Annotations list.

  8. To edit other annotations for the same list or list item, repeat steps 4 to 7, and click OK when done.

    Response: The annotations for the selected list or list item are updated.

  • To remove an annotation:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or list item with the annotation you want to remove.

  3. Select List Properties or List Item Properties from the pop-up menu.

    Response: Depending on whether you clicked on a list or a list item, either the List Properties dialog, or the List Item Properties dialog is opened.

  4. Select the annotation you want to remove in the Annotations list.

  5. Click on the Delete button.

    Response: The annotation is removed from the Annotations list.

  6. To remove more annotations for the same list or list item, repeat steps 4 and 5.

  7. Click OK when done to close the dialog.

See also:

What are Lists?

Details

Details on New List from Marked


  • To reach the New List from Marked dialog:

  1. If Lists are not already visible, select View > Lists.

  2. Make sure the items you want to include in the list are marked in the visualizations, and select a location for the new list.

    Comment: See Selecting Lists and List Items to learn more about how to specify a location for the new list.

  3. Click the New List from Marked button,MarkedButton.png , on the Lists toolbar.

NewListfromMarked.png

Option

Description

Name

The name of the new list.

Group list by

Specifies a column to group the items in the list by. The new list will be divided into a number of sublists; one sublist for each value in the selected column.

See also:

Creating Lists

Details on New List from List Logic


  • To reach the New List from List Logic dialog:

  1. If Lists are not already visible, select View > Lists.

  2. Click the New List from List Logic button, ListLogicButton.png, on the Lists toolbar.

NewListfromListLogic.png

Option

Description

Name

The name of the new list.

Lists to use

Displays the available lists. Select the lists from which you want to create a new list.

Include items appearing

 

   In all lists (AND)

Creates a new list containing only those items present in all of the selected lists.

   In any list (OR)

Creates a new list containing all items present in any of the selected lists. Each item will appear only once in the new list, even if that item is present in several of the selected lists.

   ONLY in this list

Creates a new list containing only those items present in the list that has been selected in the drop-down list, and not any of the other lists.

See also:

Creating Lists

Details on List/List Item Properties


  • To reach the List/List Item Properties dialog:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or list item of interest.

  3. From the pop-up menu, select List Properties or List Item Properties.

ListProperties.png

 

Option

Description

Name

The name of the list or list item as it will be displayed in the Lists panel.

Annotations

Lists the annotations, if any, for the list or list item.

New...

Opens the New Annotation dialog, where you can define new annotations for the list or item.

Edit...

Opens the Edit Annotation dialog where you can edit the selected annotation.

Delete

Removes the selected annotation from the list or item.

See also:

Working with Annotations

Details on New/Edit Annotation


  • To reach the New/Edit Annotation dialog:

  1. If Lists are not already visible, select View > Lists.

  2. Right-click on the list or list item of interest.

  3. From the pop-up menu, select List Properties or List Item Properties.

    Response: Depending on whether you clicked on a list or a list item, either the List Properties dialog, or the List Item Properties dialog is opened.

  4. To create a new annotation, click on the New... button. To edit an existing annotation, select the annotation to edit in the Annotations list, and then click on the Edit... button.

NewAnnotation.png

 

Option

Description

Annotation

The contents of the annotation.

Name

An alias for the annotation can be entered here. This is optional.

See also:

Working with Annotations

Collaboration

Collaboration Panel

What is the Collaboration Panel?


The collaboration panel is a tool that allows you to view web pages in Spotfire. This is useful, for instance, if you use some kind of web based collaboration tool, such as tibbr®, a communication and collaboration tool designed for the workplace, enabling users to collaborate by participating in communication threads about different subjects.

Collaboration.png

You can configure the Collaboration to go to different URLs on different pages in the analysis, thus making it possible to follow several different subjects within a single analysis.

The Collaboration panel can also be viewed in a popover or as a floating window. See Panels and Popovers.

See also:

How to Use the Collaboration Panel

Details on Configure Collaboration Panel

How to Use the Collaboration Panel


  • To show and hide the Collaboration Panel:

  1. Click the Collaboration Panel icon,CollaborationPanelIcon.png , in the status bar or select View > Collaboration.

    Response: The Collaboration Panel will be shown or hidden.

  • To configure the Collaboration Panel:

  1. In the Collaboration Panel, click the configure icon in the bottom left corner.

    Response: The Configure Collaboration Panel dialog will open.

  2. Type or paste the URL of interest in the dialog.

    Comment: The Collaboration Panel is configured per page in the analysis, so you can link the Collaboration Panel on different pages to different URLs.

  3. Click OK.

See also:

What is the Collaboration Panel?

Details on Configure Collaboration Panel

Panels and Popovers

Details on Configure Collaboration Panel


To configure the Collaboration Panel, you can enter a URL to a web page that TIBCO Spotfire will show in the Collaboration Panel.

In TIBCO Spotfire, the Collaboration Panel will run an instance of the Internet Explorer rendering engine installed on the machine to parse content.

In TIBCO Spotfire Web Player, the Collaboration Panel will open in an iframe and use the same rendering function available to the rest of the Web Player. If the Collaboration Panel is used in both TIBCO Spotfire and the Web Player, this could potentially lead to differences in html rendering between different web browser versions.

Note: The Collaboration Panel is configured per page in the analysis, so you can link the Collaboration Panel on different pages to different URLs.

ConfigureCollaborationPanel.png

Option

Description

URL

Type or paste the URL to the web page of interest here.

Integrating with tibbr®

You can use the collaboration panel to integrate with tibbr®. For example, you may want to follow and post to a certain tibbr subject thread and show that thread in the collaboration panel.

To show a tibbr subject thread in the collaboration panel, the URL should be in the following format:
http(s)://<tibbr server>/a/gadgets/subject_messages.html?id=<subject>&name=<subject>
where <tibbr server> and <subject> should be replaced by your tibbr server and subject of choice. Also note that you need to use http or https depending on what the tibbr server configuration requires.

For example, if your tibbr server is called mytibbrserver, and you have a subject called SpotfireTibbrDemo, the URL will appear as below:
https://mytibbrserver.com/a/gadgets/...tfireTibbrDemo

See the tibbr®, tibbr Service, tibbr Community, and tibbr Community Service – Installation and Configuration manual for a list of other tibbr gadgets.

See also:

What is the Collaboration Panel?

Share

What is the Share Menu?


The Share menu allows you to quickly share your analyses with other people you are collaborating with. If you are using tibbr in your organization, you can post messages with images of the analysis you are working with to the tibbr® flow. Your company may also have added other collaboration tools, besides tibbr®, to the Share menu.

Right click on a visualization, on a bookmark, or on a page title to access the Share menu. Depending on what you have clicked upon you will see different options on the menu.

WhatistheShareMenu.png

Option

Description

Share

 

   Page to tibbr®

[When right-clicking on a page title.]

Opens the Share to tibbr® dialog so that the selected page can be shared to tibbr.

   Bookmark to tibbr®

[When right-clicking on a bookmark.]

Opens the Share to tibbr® dialog so that the selected bookmark can be shared to tibbr.

   Visualization to tibbr®

[When right-clicking on a visualization.]

Opens the Share to tibbr® dialog so that the selected visualization can be shared to tibbr.

Tip: To follow tibbr® flows from within TIBCO Spotfire, you can configure the Collaboration Panel to view different tibbr® subjects.

See also:

Details on Log into tibbr

What is the Collaboration Panel?

How to Use the Collaboration Panel

Details on Configure Collaboration Panel

Details on Log into tibbr®


To be able to log into a tibbr® server, the Spotfire tibbr® host preference must be set by a Spotfire Administrator. This preference is found under Application > tibbr® in the Preferences tab in the Spotfire Administration Manager. Enter the hostname without http://, for instance tibbrserver.

LogintoTIBBR.png

Option

Description

Username

Your login name on the tibbr® server.

Password

Your password on the tibbr® server.

tibbr host

The hostname of the tibbr® server.
Note: This cannot be changed. Instead, this is a preference set by the Spotfire Administrator. See above.

See also:

Details on Share to tibbr

Details on Share to tibbr®


tibbr® is a communication and collaboration tool designed for the workplace, enabling users to collaborate by participating in communication threads about different subjects.

If you use tibbr® to collaborate with your colleagues, you may want to share your Spotfire analyses with them. Specifically, you can share pages, visualizations, and bookmarks.

  • To reach the Share to tibbr® dialog:

  1. Right click on a page title, in a visualization, or on a bookmark and select Share > Page/Visualization/Bookmark to tibbr®.

    Response: If this is the first time you share to tibbr® during this Spotfire session, you will be prompted to log into the tibbr® server. See Details on Log into tibbr.
    Otherwise, you will be directly presented with the dialog below:

 

SharetoTIBBR.png

Option

Description

Subjects

Type the tibbr® subject to which to post here. If you start writing something you will be presented with a list of available subjects, starting with that letter,  to choose from.

Note: If you do not enter a subject, you will post to your own wall.

Message

Type a message to post to tibbr here.

Include link to analysis

Select this option to include a link to the Web Player version of the analysis.

Note: This option will only be available if the analysis is stored in the library and the Web Player is installed and configured. Otherwise, only the Preview image will be shown.

Preview

This is a preview of the image that will be posted to tibbr.

See also:

Details on Log into tibbr

What is the Share Menu?

Page statistics
10341 view(s) and 33 edit(s)
Social share
Share this page?

Tags

This page has no custom tags.
This page has no classifications.

Comments

You must to post a comment.

Attachments