Class BasemapElement

Represents a single element of a Spotfire.Dxp.Application.Visuals.WaferMap.BasemapLayer (for example the wafer outline, die grid, exposure field grid or crosshair).

Since

2.6

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- BasemapElement

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Enabled IsAttached Stroke Transactions Transparency ForEachNodeInSubTree

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 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

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

Enabled

get Enabled(): boolean
Gets or sets a value indicating whether this basemap element is visible.

Returns boolean
Since
2.6
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Stroke

get Stroke(): Spotfire.Dxp.Application.Visuals.Styles.Stroke
Gets or sets the stroke used to draw this basemap element. A stroke whose Spotfire.Dxp.Application.Visuals.Styles.Stroke.ColorType is Spotfire.Dxp.Application.Visuals.Styles.ColorType.Default inherits the panel color, and its width is the maximum width in pixels.

Returns Spotfire.Dxp.Application.Visuals.Styles.Stroke
Since
2.6
set Stroke(value: Spotfire.Dxp.Application.Visuals.Styles.Stroke): void
Parameters
- value: Spotfire.Dxp.Application.Visuals.Styles.Stroke
Returns void

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

Transparency

get Transparency(): number
Gets or sets the transparency of this basemap element, in the range [0, 1] where 0 is fully opaque.

Returns number
Since
2.6
set Transparency(value: number): void
Parameters
- value: number
Returns void

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

Class BasemapElement

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 T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Enabled

Returns boolean

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

Stroke

Returns Spotfire.Dxp.Application.Visuals.Styles.Stroke

Since

Parameters

Returns void

Transactions

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions

Since

Transparency

Returns number

Since

Parameters

Returns void

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals