How to Uncheck all the Checked values in all the Visible CheckBox Filters in Spotfire® Using IronPython Scripting

Introduction

Below is code snippet in IronPython on how to uncheck the checked values in all the visible checkbox filters

Code Sample

# Copyright © 2017. TIBCO Software Inc. Licensed under TIBCO BSD-style license.
 
from Spotfire.Dxp.Application.Visuals import VisualContent
from Spotfire.Dxp.Application import Filters as filters
from Spotfire.Dxp.Application.Filters import FilterTypeIdentifiers

# Get the filter panel on the current active page
filterPanel = Document.ActivePageReference.FilterPanel
# Perform filtering action
for tableGroup in filterPanel.TableGroups:
	for fh in tableGroup.FilterHandles:
		if fh.Visible:
			if (fh.FilterReference.TypeId == FilterTypeIdentifiers.CheckBoxFilter):
				cbFilter = fh.FilterReference.As[filters.CheckBoxFilter]()
				for checkedValues in cbFilter.Values:
					cbFilter.Uncheck(checkedValues)

References

• API Reference: VisualContent
• API Reference: Filters
• API Reference: FilterTypeIdentifiers

License:  TIBCO BSD-Style License

Back to IronPython Scripting in TIBCO Spotfire Examples:  https://community.spotfire.com/s/article/IronPython-Scripting-in-Spotfire