Class LayerGroup

Represents a layer group. That is, a layer that contains a collection of other layers.

Since

2.2

Hierarchy (View Summary)

Layer
- LayerGroup

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DisplayName Enabled IsAttached Layers Name Transactions ForEachNodeInSubTree MoveTo

Methods

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 Layer.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 Layer.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Layer.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Layer.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 Layer.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 Layer.Equals

Default capability

Context

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

Returns INodeContext
Since
2.0

Inherited from Layer.Context

DisplayName

get DisplayName(): string
Gets the display name.

Returns string
Since
2.2

Inherited from Layer.DisplayName

Enabled

get Enabled(): boolean
Gets or sets a value indicating whether this layer is enabled.

Returns boolean
Since
2.2

Inherited from Layer.Enabled
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Layer.Enabled

IsAttached

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

Returns boolean
Since
2.0

Inherited from Layer.IsAttached

Layers

get Layers(): LayerCollection
Gets the collection of layers in this group.

Returns LayerCollection
Since
2.2

Name

get Name(): string
Gets or sets the name of this Spotfire.Dxp.Application.Visuals.Layers.Layer instance. If set to a non-empty string, this name is used as the Spotfire.Dxp.Application.Visuals.Layers.Layer.DisplayName of this instance.

Returns string
Since
2.2

Inherited from Layer.Name
set Name(value: string): void
Parameters
- value: string
Returns void
Inherited from Layer.Name

Transactions

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

Returns ITransactions
Since
2.0

Inherited from Layer.Transactions

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 Layer.ForEachNodeInSubTree

MoveTo

MoveTo(targetCollection: LayerCollection): void
Moves this instance to the specified targetCollection. This Spotfire.Dxp.Application.Visuals.Layers.Layer is removed from the Spotfire.Dxp.Application.Visuals.Layers.LayerCollection where is currently resides and placed last in the targetCollection.
Parameters
- targetCollection: LayerCollection
  The layer collection to which this layer shall be moved.
Returns void
Since
2.2

Inherited from Layer.MoveTo

Class LayerGroup

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

DisplayName

Returns string

Since

Enabled

Returns boolean

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

Layers

Returns LayerCollection

Since

Name

Returns string

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

MoveTo

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals