How to Toggle the Bookmarks Panel in Spotfire® Using IronPython Scripting

Introduction

It is possible to toggle the visibility of the Bookmarks panel via an IronPython script. This requires the Bookpanel to be docked which this script will set.

Code Sample

# Copyright © 2017. TIBCO Software Inc. Licensed under TIBCO BSD-style license.

import Spotfire.Dxp.Application.PanelCollection
import Spotfire.Dxp.Application.PanelTypeIdentifiers
from Spotfire.Dxp.Application import Panel
from Spotfire.Dxp.Application.Layout import PanelState as ps

for panel in Document.ActivePageReference.Panels:
	if (panel.TypeId.DisplayName == "Bookmarks"):
		panel.PanelState = ps.Docked
		if (panel.Visible == True):
			panel.Visible=False
		elif (panel.Visible == False):
			panel.Visible= True

References

• API Reference: Page.Panels Property
• API Reference: Panel Properties

License:  TIBCO BSD-Style License