How to Edit Document Properties

The dialog found under File > Document properties on the menu bar contains different settings that apply to the entire document. Custom document property values can be created, inspected and updated under View > Document properties., markings can be added and edited under View > Markings, and filtering schemes can be added and edited under View > Filtering schemes.

Settings that affect the visualizations are found in the Properties dialog for each specific visualization. These dialogs are reached by clicking the visualization of interest to make it active, and then selecting Visualizations > Visualization properties.

Properties that affect the document can also be found in the Data Table Properties, Data Connection Properties or Data Function Properties dialogs, or the data canvas.

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

General

To update the description or keywords for an analysis:

Select File > Document properties on the menu bar.
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.
Click OK.

To change the page navigation:

Select File > Document properties on the menu bar.
On the General tab, select whether to use Titled tabs, Step-by-step, or History arrows to navigate between pages, or to remove the page navigation controls by selecting Off.

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. History arrows will hide the page navigation, except for the page history arrows. This can be useful if you want to create your own flow throughout the analysis by adding actions directly on the pages, but still want to allow the user to go back to previously visited pages. Use Off if you want complete control over the navigation between pages through actions on the pages, and no possibility to move back and forth between previously visited pages. See also Pages and Guided Analyses.
Click OK.

To specify placement of page navigation and status bar:

You can select whether the page navigation and status bar should appear above or below the visualizations in the analysis. See also Pages.

Select File > Document properties on the menu bar.
On the General tab, select your preferred placement using the check boxes Show page navigation at the top and Show status bar at the top respectively.
Click OK.

To specify a particular canvas size:

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

Select File > Document properties on the menu bar.
On the General tab, select the desired size under Canvas 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 canvas 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 Canvas size drop-down list, see below.
Click OK.

To find out the currently available canvas size in 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 canvas size on that device and then design your analysis so that it is optimized for that particular screen size.

On the device to use, open the analysis in Spotfire.
On the menu bar, select Help > Support diagnostics and logging.
Go to the Preferences tab.
Look at the Fixed Visualization Area Sizes.

To find out the currently available canvas size in the web client:

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

On the device to use, open the analysis in the Spotfire web client.
Click the menu button at the top right corner of the application.

Response: The web client menu is displayed.
On the menu bar, select Tools > Canvas size.

Comment: Note that the current canvas size is dependent 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.
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 Canvas size drop-down list of the Document Properties dialog.

On the menu bar, select Tools > Administration manager.
Go to the Preferences tab.
In the Selected group list, click the group for which to set the preferences.
In the Preferences list to the right, click the plus sign next to Application to expand the group.
Click ApplicationPreferences.
Click Edit.
Click Fixed Visualization Area Sizes.

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

Response: The String Collector Editor is displayed.
Enter the desired fixed size configurations and click OK.

Library

To view the URL for an analysis in the library:

On the menu bar, select File > Document properties.
Go to the Library tab.
Look at the Library URL – Installed client or Library URL – Web client field.
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.

On the menu bar, select File > Document properties.
Go to the Library tab.
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.
Click OK.

To manually specify a preview image for an analysis:

On the menu bar, select File > Document properties.
Go to the Library tab.
Under Select preview image, select Manually.
Click Browse.
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.
Click OK.

Markings

To change the color of marked items:

On the menu bar, select File > Document properties.
Go to the Markings tab.
Click to select the marking color you wish to change under Available markings.
Click Edit.
Change color using the drop-down list.
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.

On the menu bar, select File > Document properties.

Comment: You can also define new markings from the Data page of any Visualization Properties dialog.
Go to the Markings tab.
Click the New button next to the Available markings list.
Specify a Color for the new marking.
Specify a Name.
Click OK twice.

To change the default marking:

On the menu bar, select File > Document properties.
Go to the Markings tab.
Click the marking that you want to use as default.
Click the Set as Default button below the Available markings list.
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.

On the menu bar, select File > Document properties.
Go to the Filtering Schemes tab.
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.

On the menu bar, select File > Document properties.
Go to the Filtering Schemes tab.
Click New.
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.

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 File > Document properties > Filtering Schemes tab and the check box Show filtering scheme menu in Filters panel.
Click the filtering scheme menu.
Select the desired filtering scheme.

To rename a filtering scheme:

On the menu bar, select File > Document properties.
Go to the Filtering Schemes tab.
Click to select the filtering scheme to rename in the list.
Click Rename.
Type a name and 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.

On the menu bar, select File > Document properties.
Go to the Data Function tab.
Click the data function of interest.
Click Refresh.
Click OK.

Scripts

Security reviews and trust management for scripts and data functions in an analysis are all handled in one place; in the Manage trust dialog found under File > Manage trust. You can sometimes also reach the dialog from direct links in notifications regarding trust issues. From this dialog, you can review scripts created by someone else, to determine whether they should be trusted, or easily Trust all scripts in the analysis, if you are certain they come from a reliable source. See also Manage Trust. You can also reach this dialog from the Document properties – Scripts tab. An administrator also has further options to control trust. See the Spotfire Server and Environment Installation and Administration guide for more information.

To add a new script to an analysis:

The following steps are used to create a new JavaScript or IronPython script, without necessarily tying it to a text area or an action in a graphical table or KPI chart..

On the menu bar, select File > Document properties.
Go to the Scripts tab.
Decide whether to add a JavaScript or IronPython script by clicking on the appropriate tab.
Click Add > New script.

Response: The New Script dialog is displayed.

Enter a script, add any parameters and click OK when done.
Click OK.

To import scripts from another analysis file:

On the menu bar, select File > Document properties.
Go to the Scripts tab.
Click Add and select an analysis, either a local file or an analysis from the library, to import scripts from.

Response: All available scripts from the selected analysis are imported.

Review, edit or run the imported scripts, as desired.

To delete a script from the analysis:

On the menu bar, select File > Document properties.
Go to the Scripts tab.
Click on the script to delete in the JavaScript or IronPython tab.
Click Delete.
Click OK.