About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class LayerCollection

Represents a collection of layers.

Remark

This class provides functionality to manage a collection of Spotfire.Dxp.Application.Visuals.Layers.Layer objects.

Since

2.2

Hierarchy (View Summary)

DocumentNode
- LayerCollection

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached Transactions AddDuplicate AddNewGroup AddNewReferenceLayer ForEachNodeInSubTree GetEnumerator Move Remove RemoveAt

Methods

[iterator]

"[iterator]"(): Iterator<Layer>
Returns Iterator<Layer>

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): null | T1
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, Layer>

Gets the Spotfire.Dxp.Application.Visuals.Layers.Layer at the specified index.

Param: index

The index of the element to get.

Returns

The Spotfire.Dxp.Application.Visuals.Layers.Layer at the specified index.

Since

2.2

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of elements in the collection.

Returns number
Since
2.2

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddDuplicate

AddDuplicate(layer: Layer): Layer
Adds a new Spotfire.Dxp.Application.Visuals.Layers.Layer to the collection that is a duplicate of the specified layer.
Parameters
- layer: Layer
  The layer to duplicate.
Returns Layer
A new Spotfire.Dxp.Application.Visuals.Layers.Layer instance.

Since
2.2

AddNewGroup

AddNewGroup(): LayerGroup
Adds a new Spotfire.Dxp.Application.Visuals.Layers.LayerGroup to the collection.

Returns LayerGroup
A new Spotfire.Dxp.Application.Visuals.Layers.LayerGroup instance.

Since
2.2

AddNewReferenceLayer

AddNewReferenceLayer(): ReferenceLayer
Adds a new Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer to the collection.

Returns ReferenceLayer
A new Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer instance.

Since
2.2

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<Layer>
Gets the enumerator for the collection.

Returns System.Collections.Generic.IEnumerator<Layer>
An enumerator for the collection.

Since
2.2

Move

Move(layer: Layer, toIndex: number | Int32): void
Moves the specified layer within this collection.
Parameters
- layer: Layer
  The layer to move.
- toIndex: number | Int32
  The index to move the layer to.
Returns void
Since
2.2

Remove

Remove(layer: Layer): boolean
Removes the specified layer from this collection.
Parameters
- layer: Layer
  The layer to remove.
Returns boolean
true if the layer was successfully removed from this collection; otherwise false.

Since
2.2

RemoveAt

RemoveAt(index: number | Int32): void
Removes the layer at the specified index.
Parameters
- index: number | Int32
  The zero-based index of the layer to remove.
Returns void
Since
2.2