Represents a list of rules in a Visualization that are used to filter visualization items.
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.VisualsFilterRuleCollection
Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(12, 0)] public sealed class FilterRuleCollection : DocumentNode, IEnumerable, IEnumerable<FilterRule>
The FilterRuleCollection type exposes the following members.
Properties
Name | Description | |
---|---|---|
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
Count |
Gets the count.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
Item |
Gets the FilterRule at the specified index. Includes all filter rules even disabled filter rules.
| |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
Methods
Name | Description | |
---|---|---|
AddBottomNRule(String, ConditionValue, Boolean) |
Adds a bottom N rule to the end of the collection.
| |
AddBottomNRule(String, Int32, Boolean) |
Adds a bottom N rule to the end of the collection.
| |
AddExpressionRule |
Adds a new expression rule to the end of the collection.
| |
AddRangeRule |
Adds a range rule to the end of the collection.
| |
AddStringRule |
Adds a string rule to the end of the collection.
| |
AddThresholdRule |
Adds a threshold rule to the end of the collection.
| |
AddTopNRule(String, ConditionValue, Boolean) |
Adds a top N rule to the end of the collection.
| |
AddTopNRule(String, Int32, Boolean) |
Adds a top N rule to the end of the collection.
| |
Clear |
Clears this collection, removing all filter rules.
| |
Contains |
Determines whether the collection contains a specified rule.
| |
GetEnumerator |
Returns an enumerator that iterates through a collection.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IndexOf |
Determines the index of a specific rule in the collection.
| |
Move |
Moves a rule at the specified index to another location in the collection.
| |
Remove |
Removes the specified rule from the collection.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
Version Information
Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also