Class WaferMapLayerCollection

Represents a collection of layers.

Remark

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

Since

2.6

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- WaferMapLayerCollection

Implements

Explicit<System.IServiceProvider>
Explicit<Spotfire.Dxp.Framework.DocumentModel.ITransactions>
Explicit<Spotfire.Dxp.Framework.DocumentModel.INodeContext>
Explicit<
    System.Collections.Generic.IReadOnlyList<
        Spotfire.Dxp.Application.Visuals.Layers.Layer,
    >,
>
Explicit<
    System.Collections.Generic.IReadOnlyCollection<
        Spotfire.Dxp.Application.Visuals.Layers.Layer,
    >,
>
Explicit<
    System.Collections.Generic.IEnumerable<
        Spotfire.Dxp.Application.Visuals.Layers.Layer,
    >,
>
Explicit<System.Collections.IEnumerable>

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Application.Visuals.Layers.Layer>
Returns Iterator<Spotfire.Dxp.Application.Visuals.Layers.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>): T1 | null
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 T1 | null
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
    | System.Int32,
    Spotfire.Dxp.Application.Visuals.Layers.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.6

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.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.6

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(): Spotfire.Dxp.Framework.DocumentModel.ITransactions
Gets a collection of methods for executing transactions on the document.

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddDuplicate

AddDuplicate(
layer: Spotfire.Dxp.Application.Visuals.Layers.Layer,
): Spotfire.Dxp.Application.Visuals.Layers.Layer
Adds a new Spotfire.Dxp.Application.Visuals.Layers.Layer to the collection that is a duplicate of the specified layer. Only layers that are part of this collection can be duplicated.
Parameters
- layer: Spotfire.Dxp.Application.Visuals.Layers.Layer
  The layer to duplicate.
Returns Spotfire.Dxp.Application.Visuals.Layers.Layer
A new Spotfire.Dxp.Application.Visuals.Layers.Layer instance.

Since
2.6

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.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: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Layers.Layer,
>
Gets the enumerator for the collection.

Returns System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Layers.Layer,
>
An enumerator for the collection.

Since
2.6

Move

Move(
layer: Spotfire.Dxp.Application.Visuals.Layers.Layer,
toIndex: number | System.Int32,
): void
Moves the specified layer within this collection.
Parameters
- layer: Spotfire.Dxp.Application.Visuals.Layers.Layer
  The layer to move.
- toIndex: number | System.Int32
  The index to move the layer to.
Returns void
Since
2.6

Remove

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

Since
2.6

RemoveAt

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

Class WaferMapLayerCollection

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Application.Visuals.Layers.Layer>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions

Since

AddDuplicate

Parameters

Returns Spotfire.Dxp.Application.Visuals.Layers.Layer

Since

AddNewBasemapLayer

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapLayer

Since

AddNewDieLayer

Parameters

Returns Spotfire.Dxp.Application.Visuals.Layers.VisualizationLayer

Since

AddNewMarkerLayer

Parameters

Returns Spotfire.Dxp.Application.Visuals.Layers.VisualizationLayer

Since

AddNewReferenceStatisticLayer

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceStatisticLayer

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator< Spotfire.Dxp.Application.Visuals.Layers.Layer,>

Since

Move

Parameters

Returns void

Since

Remove

Parameters

Returns boolean

Since

`Static`Equals

`Readonly`Item

Returns System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Visuals.Layers.Layer,
>