Class BasemapLayer

Represents a supporting basemap layer in the Spotfire.Dxp.Application.Visuals.WaferMap.WaferMap. Used to show the wafer outline and other visual elements that can be derived from a wafer configuration.

Since

2.6

Hierarchy (View Summary)

Spotfire.Dxp.Application.Visuals.Layers.Layer
- BasemapLayer

Implements

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

ConfigurationId

get ConfigurationId(): string | null
Gets or sets the name of the wafer configuration to use for this layer. In order for this property to be used, the Spotfire.Dxp.Application.Visuals.WaferMap.BasemapLayer.ConfigurationSourceType property must be set to Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Predefined.

Returns string | null
Since
2.6
set ConfigurationId(value: string | null): void
Parameters
- value: string | null
Returns void

ConfigurationSourceType

get ConfigurationSourceType(): Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType
Gets or sets the wafer configuration source type. This can be either Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Predefined or Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Visualization.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType
Since
2.6
set ConfigurationSourceType(
value: Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType,
): void
Parameters
- value: Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType
Returns void

ConfigurationVisualizationReference

get ConfigurationVisualizationReference(): | Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization
| null
Gets or sets a layer to retrieve the configuration from. In order for this property to be used, the Spotfire.Dxp.Application.Visuals.WaferMap.BasemapLayer.ConfigurationSourceType property must be set to Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Visualization.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization | null
Since
2.6
set ConfigurationVisualizationReference(
    value:
        | Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization
        | null,
): void
Parameters
- value: Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization | null
Returns void

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 Layers.Layer.Context

Crosshair

get Crosshair(): Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Gets an object with the visual properties for the crosshair.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Since
2.6

DieGrid

get DieGrid(): Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Gets an object with the visual properties for the die grid.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Since
2.6

DisplayName

get DisplayName(): string
Gets the display name.

Returns string
Since
2.2

Inherited from Layers.Layer.DisplayName

EdgeExclusionPercent

get EdgeExclusionPercent(): number
Gets or sets the percentage of the wafer radius excluded from the die grid. Expressed as a percent (2 means 2%). The default value is 2. The valid range is [-50, 100]; negative values extend the effective radius beyond the wafer outline.

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

Enabled

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

Returns boolean
Since
2.2

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

FieldGrid

get FieldGrid(): Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Gets an object with the visual properties for the exposure field grid.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Since
2.6

IsAttached

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

Returns boolean
Since
2.0

Inherited from Layers.Layer.IsAttached

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 Layers.Layer.Name
set Name(value: string): void
Parameters
- value: string
Returns void
Inherited from Layers.Layer.Name

NotchScaleFactor

get NotchScaleFactor(): number
Gets or sets the notch scale factor which determines how much the notch should be scaled on screen. Typically, the notch is very small compared to the wafer and can be hard to see, so this scale factor can be used to make it more visible. The default value is 2, which exaggerates the size of the notch on screen. The valid range is [0, 10].

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

Outline

get Outline(): Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Gets an object with the visual properties for the wafer outline.

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement
Since
2.6

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 Layers.Layer.Transactions

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

MoveTo

MoveTo(
targetCollection: Spotfire.Dxp.Application.Visuals.Layers.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: Spotfire.Dxp.Application.Visuals.Layers.LayerCollection
  The layer collection to which this layer shall be moved.
Returns void
Since
2.2

Inherited from Layer.MoveTo

Class BasemapLayer

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

ConfigurationId

Returns string | null

Since

Parameters

Returns void

ConfigurationSourceType

Returns Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType

Since

Parameters

Returns void

ConfigurationVisualizationReference

Returns Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization | null

Since

Parameters

Returns void

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Crosshair

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement

Since

DieGrid

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement

Since

DisplayName

Returns string

Since

EdgeExclusionPercent

Returns number

Since

Parameters

Returns void

Enabled

Returns boolean

Since

Parameters

Returns void

FieldGrid

Returns Spotfire.Dxp.Application.Visuals.WaferMap.BasemapElement

Since

IsAttached

Returns boolean

Since

Name

Returns string

Since

Parameters

Returns void

NotchScaleFactor

Returns number

Since

Parameters

Returns void

`Static`Equals