KpiCollection Class

Spotfire 14.5 API Reference

Represents a collection of KpiContent in the KpiChart.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.Visuals.KpiCollection

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(25, 0)]
public sealed class KpiCollection : DocumentNode, 
	IEnumerable<KpiContent>, IEnumerable

The KpiCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of items in this collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the item at the specified index.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddDuplicate	Duplicates a KpiContent and adds it to the collection.
	AddNew	Adds a new KpiContent containing an KpiVisualization to the KPI collection.
	Clear	Removes all items from the KPI collection.
	ForEachNodeInSubTree<TNode>	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 collection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of the specific item.
	InsertNew	Inserts a KpiContent containing an auto configured KpiVisualization at the specified index.
	Move	Moves the item at the specified index to a new location in the collection.
	Remove	Removes the first occurrence of the specified item from the KPI collection.
	RemoveAt	Removes the item at the specified index.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection.
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace