IconRuleCollection Class

Spotfire 15.0 API Reference

Represents the set of rules in a IconMiniatureVisualization that are used to determine the icon that is rendered.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.MiniaturesIconRuleCollection

Namespace: Spotfire.Dxp.Application.Visuals.Miniatures
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(9, 0)]
public sealed class IconRuleCollection : DocumentNode, 
	IEnumerable<IconRule>, IEnumerable

The IconRuleCollection 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 IconRule at the specified index.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddBottomNRule(Int32, Color, MarkerShape)	Adds a bottom N rule to the end of the collection.
	AddBottomNRule(ConditionValue, Color, MarkerShape)	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 color rule to the end of the collection.
	AddThresholdRule	Adds a threshold color rule to the end of the collection.
	AddTopNRule(Int32, Color, MarkerShape)	Adds a top N rule to the end of the collection.
	AddTopNRule(ConditionValue, Color, MarkerShape)	Adds a top N rule to the end of the collection.
	Clear	Clears this collection, removing all rules.
	Contains	Determines whether the collection contains a specified rule.
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetEnumerator	Returns an enumerator that iterates through the IconRules in this Coloring.
	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.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through this collection.
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Reference

Spotfire.Dxp.Application.Visuals.Miniatures Namespace