ModLayerCollection Class

Spotfire 15.0 API Reference

A collection of ModLayers in a ModVisualization.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.ModsModLayerCollection

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(70, 0)]
public sealed class ModLayerCollection : DocumentNode, 
	IEnumerable<ModLayer>, IEnumerable

The ModLayerCollection type exposes the following members.

Properties

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

Top

Methods

	Name	Description
	AddLayer	Adds a layer of the specified type layerType to the visualization.
	Clear	Removes all layers.
	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.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Move(Int32, Int32)	Move the layer from index fromIndex to index toIndex.
	Move(ModLayer, Int32)	Move the specified layer to index toIndex.
	Remove	Removes the specified layer.
	RemoveAll	Removes all the layers that match the specified predicate.
	RemoveAt	Removes the layer at the specified index.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetLayer	Tries to get the layer with the specified id.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableModLayerGetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a 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

Supported in: 15.0, 14.8

Reference

Spotfire.Dxp.Application.Mods Namespace