IronPython Scripting in TIBCO Spotfire®

Last updated:
5:52am Apr 20, 2020

Back to Extending Spotfire page


With IronPython scripts it is possible to configure and automate a lot of different aspects of a TIBCO Spotfire® analysis and add behaviors to it without creating and deploying extensions. IronPython scripts can access the capabilities available in the Spotfire Analyst API.  

IronPython scripts can be added to several places in a Spotfire analysis. Scripts can be exctuted from action controls in the Text Area, from the Graphical Table or the KPI Chart or be triggered by Document Property changes.

To create an analyses containing IronPython scripts, the analyst needs the Author Scripts license function. Scripts in analysis files that are shared via the library by licensed script authors are considered as trusted. For security reasons you should always examine and approve a script that is not listed as trusted before executing it.

The Spotfire add-in mechanism for C# extensions, which enables developers to extend the Spotfire feature set, is designed for the developers with access to a full-fledged development environment. Scripting does not replace this framework. It rather supplements the heavy-lifting programming with a light-weight option to configure Spotfire and extend its behaviors, a convenient and powerful means to solve simple as well as complex tasks. Many of the script examples below are applicable also when creating custom tools and other extensions as embedded IronPython scripts or converted to C#.


See Also




Filtering and Marking

User Interface & Layout







The script code in these articles is only a sample to be used as a reference. It is not intended to be used "As Is" in a Production environment. Always test in a Development environment. Make modifications to the script per your implementation specifications that suit best your business requirements. Refer to the API reference for usage of the classes and methods used in the scripts.  All scripts on this page are covered by this license


PDF icon tibco_community_script_license_2017.pdf124.62 KB

Feedback (4)

Hi Magnus, any chance you can add a link to an example I wrote? I created this one to help one of our users who is building a form for editing database records in Spotfire (who knows why!):

Feel free to modify my page at will :)

pete.thompson 7:59am Apr. 24, 2020

Is there any functionality or existing IronPython-Script for the export of all changes being made to a specific data table in the data canvas? 

felix.lindau 2:45am Dec. 10, 2019


Is this what you are looking for "Importing Python libraries from local directory" ?

Shandilya Peddi 8:15am Apr. 24, 2019

I've been searching all over for an example on how we import additional packages (e.g. after installing them with pip) and can't find anything. Any ideas?

janine.rawnsley 1:20am Apr. 24, 2019