Class DieLayerVisualization

Die layer visualization for wafer maps.

Since

2.6

Hierarchy (View Summary)

Spotfire.Dxp.Application.Visuals.WaferMap.WaferMapLayerVisualization
- DieLayerVisualization

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from WaferMapLayerVisualization.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

ColorAxis

get ColorAxis(): Spotfire.Dxp.Application.Visuals.ColorAxis
Gets the color axis.

Returns Spotfire.Dxp.Application.Visuals.ColorAxis
Since
2.6

ConfigurationByAxis

get ConfigurationByAxis(): Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationByAxis
Gets the configuration by axis.

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

ConfigurationId

get ConfigurationId(): string
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.DieLayerVisualization.ConfigurationSourceType property must be set to Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Predefined.

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

ConfigurationSourceType

get ConfigurationSourceType(): Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType
Gets or sets the wafer configuration source type. When set to Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Column, the Spotfire.Dxp.Application.Visuals.WaferMap.DieLayerVisualization.ConfigurationByAxis will be used to look up names of wafer configurations. When set to Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationSourceType.Predefined, the Spotfire.Dxp.Application.Visuals.WaferMap.DieLayerVisualization.ConfigurationId property will be used to look up a single wafer configuration.

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

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 WaferMapLayerVisualization.Context

Data

get Data(): Spotfire.Dxp.Application.Visuals.VisualizationData
Gets the plot data.

Returns Spotfire.Dxp.Application.Visuals.VisualizationData
Since
2.0

Inherited from WaferMapLayerVisualization.Data

DefaultFontMetadata

get DefaultFontMetadata(): Spotfire.Dxp.Framework.Styles.FontMetadata
Gets or sets the default font for the plot.

Returns Spotfire.Dxp.Framework.Styles.FontMetadata
Since
2.0

Inherited from WaferMapLayerVisualization.DefaultFontMetadata
set DefaultFontMetadata(value: Spotfire.Dxp.Framework.Styles.FontMetadata): void
Parameters
- value: Spotfire.Dxp.Framework.Styles.FontMetadata
Returns void
Inherited from WaferMapLayerVisualization.DefaultFontMetadata

Description

get Description(): string
Gets or sets the plot description.

Returns string
Since
2.0

Inherited from WaferMapLayerVisualization.Description
set Description(value: string): void
Parameters
- value: string
Returns void
Inherited from WaferMapLayerVisualization.Description

HorizontalLegend

get HorizontalLegend(): Spotfire.Dxp.Application.Visuals.HorizontalLegend
Gets the horizontal legend object for this plot.

Returns Spotfire.Dxp.Application.Visuals.HorizontalLegend
Since
2.0

Inherited from WaferMapLayerVisualization.HorizontalLegend

IsAttached

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

Returns boolean
Since
2.0

Inherited from WaferMapLayerVisualization.IsAttached

Legend

get Legend(): Spotfire.Dxp.Application.Visuals.Legend
Gets the legend object for this plot.

Returns Spotfire.Dxp.Application.Visuals.Legend
Since
2.0

Inherited from WaferMapLayerVisualization.Legend

LegendItem

get LegendItem(): Spotfire.Dxp.Application.Visuals.WaferMap.LegendLayerTitleItem
Gets the legend item for this layer visualization.

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

Inherited from WaferMapLayerVisualization.LegendItem

ShowDescription

get ShowDescription(): boolean
Gets or sets a flag indicating whether to show the description or not.

Returns boolean
Since
2.0

Inherited from WaferMapLayerVisualization.ShowDescription
set ShowDescription(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from WaferMapLayerVisualization.ShowDescription

SupportsTransparency

get SupportsTransparency(): boolean
Gets a value indicating whether transparency is supported.

Returns boolean
Since
2.0

Inherited from WaferMapLayerVisualization.SupportsTransparency

Title

get Title(): string
Gets or sets the Visual's title.

Returns string
Remark
Note that for Spotfire.Dxp.Application.Visuals.Maps.LayerVisualization instances, you should use the Title property of the owning Spotfire.Dxp.Application.Visuals.Maps.MapChartLayer instead.

Since
2.0

Inherited from WaferMapLayerVisualization.Title
set Title(value: string): void
Parameters
- value: string
Returns void
Inherited from WaferMapLayerVisualization.Title

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 WaferMapLayerVisualization.Transactions

Transparency

get Transparency(): number
Gets or sets the transparency for the plot.

Returns number
Since
2.0

Inherited from WaferMapLayerVisualization.Transparency
set Transparency(value: number): void
Parameters
- value: number
Returns void
Inherited from WaferMapLayerVisualization.Transparency

Trellis

get Trellis(): Spotfire.Dxp.Application.Visuals.Trellis
Gets the trellis.

Returns Spotfire.Dxp.Application.Visuals.Trellis
Since
2.0

Inherited from WaferMapLayerVisualization.Trellis

TrellisingFollowsMainLayer

get TrellisingFollowsMainLayer(): boolean
Gets or sets a value indicating whether this visualization should be trellised the same way as the main trellis layer in the wafer map, see Spotfire.Dxp.Application.Visuals.WaferMap.WaferMap.TrellisLayerReference. The default value is true.

Returns boolean
Since
2.6

Inherited from WaferMapLayerVisualization.TrellisingFollowsMainLayer
set TrellisingFollowsMainLayer(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from WaferMapLayerVisualization.TrellisingFollowsMainLayer

TypeId

get TypeId(): Spotfire.Dxp.Framework.DocumentModel.TypeIdentifier
Gets the type identifier for the visual.

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

Inherited from WaferMapLayerVisualization.TypeId

UseSeparateColorForMarkedItems

get UseSeparateColorForMarkedItems(): boolean
Gets or sets a value indicating whether to use a separate color for marked items.

Returns boolean
Since
2.0

Inherited from WaferMapLayerVisualization.UseSeparateColorForMarkedItems
set UseSeparateColorForMarkedItems(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from WaferMapLayerVisualization.UseSeparateColorForMarkedItems

Visual

get Visual(): Spotfire.Dxp.Application.Visual | null
Gets the visual instance, or null if this instance is not owned by a visual.

Returns Spotfire.Dxp.Application.Visual | null
Since
2.0

Inherited from WaferMapLayerVisualization.Visual

XDieAxis

get XDieAxis(): Spotfire.Dxp.Application.Visuals.WaferMap.DieXyAxis
Gets the die x-axis.

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

YDieAxis

get YDieAxis(): Spotfire.Dxp.Application.Visuals.WaferMap.DieXyAxis
Gets the die y-axis.

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

ApplyUserPreferences

ApplyUserPreferences(): void
Applies user preferences to a newly created visual.

Returns void
Since
2.0

Inherited from WaferMapLayerVisualization.ApplyUserPreferences

AutoConfigure

AutoConfigure(): void
Configures a newly created visual with reasonable default values given the current data set.

Returns void
Remark
This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

Since
2.0

Inherited from WaferMapLayerVisualization.AutoConfigure

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

IsConfigurationValid

IsConfigurationValid(): boolean
Determines whether the current plot configuration is valid.

Returns boolean
true if the current plot configuration is valid; otherwise, false.

Since
2.0

Inherited from WaferMapLayerVisualization.IsConfigurationValid

RefreshOnDemandData

RefreshOnDemandData(): void
Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included.

Returns void
Remark
This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

Since
2.0

Inherited from WaferMapLayerVisualization.RefreshOnDemandData

TryGetFilterRules

TryGetFilterRules(
    filterRules: OutParam<
        Spotfire.Dxp.Application.Visuals.FilterRuleCollection,
    >,
): boolean
Try to get the filter rules for the plot.
Parameters
- filterRules: OutParam<Spotfire.Dxp.Application.Visuals.FilterRuleCollection>
  The FilterRuleCollection or null if filter rules are not supported
Returns boolean
false if this visualization does not support filter, rules, otherwise true.

Since
2.0

Inherited from WaferMapLayerVisualization.TryGetFilterRules

Class DieLayerVisualization

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

ColorAxis

Returns Spotfire.Dxp.Application.Visuals.ColorAxis

Since

ConfigurationByAxis

Returns Spotfire.Dxp.Application.Visuals.WaferMap.ConfigurationByAxis

Since

ConfigurationId

Returns string

Since

Parameters

Returns void

ConfigurationSourceType

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

Since

Parameters

Returns void

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Data

Returns Spotfire.Dxp.Application.Visuals.VisualizationData

Since

DefaultFontMetadata

Returns Spotfire.Dxp.Framework.Styles.FontMetadata

Since

Parameters

Returns void

Description

Returns string

Since

Parameters

Returns void

HorizontalLegend

Returns Spotfire.Dxp.Application.Visuals.HorizontalLegend

Since

IsAttached

Returns boolean

Since

Legend

Returns Spotfire.Dxp.Application.Visuals.Legend

Since

LegendItem

Returns Spotfire.Dxp.Application.Visuals.WaferMap.LegendLayerTitleItem

Since

ShowDescription

Returns boolean

Since

Parameters

Returns void

SupportsTransparency

Returns boolean

Since

Title

`Static`Equals