API Changes Between TIBCO Spotfire® 10.3 LTS and TIBCO Spotfire® 10.10 LTS

Last updated:
7:55am Nov 18, 2020

Introduction

This article summarizes all new, changed, deprecated or removed APIs and related features in all versions between TIBCO Spotfire® 10.3 LTS and TIBCO Spotfire® 10.10 LTS. For changes in earlier version, see API Changes Between TIBCO Spotfire® 7.11 LTS and TIBCO Spotfire® 10.3 LTS.

Read more about all the Spotfire APIs and customization options in Extending TIBCO Spotfire®.

Note that this article only covers changes made to the public APIs and SDK. Your use of any internal APIs or other internal implementation details is entirely at your own discretion and is not supported or warranted by TIBCO. For text area customizations, see Best Practices for Writing Custom JavaScript Code in Text Areas.

New Features

C# API to access user information (10.4)

This addition to the C# API allows IronPython scripts or C# extensions to access user name, domain, group/role membership and other relevant information about the current user.

API to show or hide pages for consumer users (10.7)

The Spotfire C# API now allows you to programmatically, from a custom extension or script, inspect and change the visibility of a page in Viewing mode. This means that pages can be shown or hidden from consumer users dependent on the context in which the analysis is opened, for example, who the logged in user is, or what the screen resolution of the client device is.

Uniquely identify visualizations in integration tests (10.7)

It is now possible to identify Spotfire visualizations in the HTML DOM in a unique and persistent way. This is useful when creating integration tests in Selenium (or similar testing frameworks) and have them run in a predictable fashion. Read more here.

C# API for creating data functions without approval stamp

The default behaviour when creating a data function with the Spotęre C# API is to have an approval (trust) stamp set for the current user. The API now allows for inspecting the approval stamp of a data function, and for creating a copy (of ataunctioneęnitonǼ that is not automatically approved by the current user.

Custom map chart projection (10.8)

The C# API now allows for defining a custom projection to use with the map chart. This type of projection can be generated from imported GeoTIFF image files, from imported Shape files, or, they can be added by users. See example.

Data transformations on data sources (10.8)

The C# API now allows for getting and setting data transformations performed on the result of an imported data connection data source. Read more here.

Set legacy limit by marking behavior (10.8)

To allow for compatibility for applications that require the legacy limit by marking behaviour there is now a C# API that allows for configuring whether visualizations should use the behavior of versions 10.7 and prior,  or the new behaviour introduced in this release, when limited by their own marking.

Identifier for custom tools (10.8)

You can now specify an identifier to your custom tool to be used in the  ToolbarShortcuts preference when adding the tool to the toolbar.

API to configure dual shared scales (10.9)

The C# API now allows configuring a visualization with dual scales. 

  • API reference: Scale.class (IndexedScaleLabelLayout, IndexedLabelOrientation, IndexedShowLabel, IndexedMaximunNumberOfTicks, IndexedShowGridLines)

API to add Python data function (10.9)

The C# API now allows for creating a data function based on a Python script.

Digital signing using local certificate stores (10.9)

The Spotfire Package Builder console app now supports digital signing of cab files using a certificate in a local certificate store. This comes with the benefit of not having to provide a password on the command line. See Developer Documentation.

Visualize labels from columns in the secondary table

It is now possible to show labels in a plot from columns in secondary data tables. This means for example that its possible to visualize data grouped by an id column, but instead of technical id:s, show the labels in the visualization as a more human-friendly name (which is only present in a secondary table).

Custom top level menus (10.10 LTS)

You can now use the C# API to add new top level menus for your custom application and document tools. A custom top level menu can also contain sub menus for more fine-grained arrangement.

This is especially useful when using Spotfire as a platform to build analytic applications. Since custom tools are often the most used tools for users of an analytic application, having direct access to them in a top level menu makes the analytic application easier to use. In addition to the existing custom toolbar, co-branding and white-labeling capabilities, the top level menus feature provides an extra option for customizing Spotfire.

Custom Export Tool with current theme (10.10 LTS)

With this release it is possible to have a Custom Export Tool to follow the current theme that is used in the analysis, in addition to using the Spotfire light theme (default). This affects not only colors, but also layout, such as font sizes, etc.

Custom Data Source on application thread (10.10 LTS)

Spotfire now performs data loading in background processes that runs in parallel. This may sometime cause problems with custom data sources. To avoid those problems, a new property, AlwaysLoadOnApplicationThread, has been introduced to the CustomDataSource class. This can be overriden to signal that the data source should always be loaded on the application thread.

Changes in Functionality

There are no changes in API related functionality between version 10.3 and version 10.10 of TIBCO Spotfire®. 

Deprecated and Removed Features

There are no deprecated or removed API features between version 10.3 and version 10.10 of TIBCO Spotfire®.

Closed Issues

There are no important closed issues to report between version 10.3 and version 10.10 of TIBCO Spotfire®.