Class ReferenceLayer

Represents a layer of reference elements.

Since

2.2

Hierarchy (View Summary)

Layer
- ReferenceLayer

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

Band

get Band(): Spotfire.Dxp.Application.Visuals.ReferenceElements.Band
Gets the band reference element settings.

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.Band
Since
2.2

BarSegmentHandling

get BarSegmentHandling(): BarSegmentHandling
Gets or sets a value specifying how reference elements are rendered on a Spotfire.Dxp.Application.Visuals.BarChart or Spotfire.Dxp.Application.Visuals.CombinationChart for different values of Spotfire.Dxp.Application.Visuals.BarChart.StackMode.

Returns BarSegmentHandling
Since
2.2
set BarSegmentHandling(value: BarSegmentHandling): void
Parameters
- value: BarSegmentHandling
Returns void

Box

get Box(): Spotfire.Dxp.Application.Visuals.ReferenceElements.Box
Gets the box reference element settings.

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.Box
Since
2.2

ColorAxis

get ColorAxis(): ReferenceLayerColorAxis
Gets the color axis of this Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer. This axis can be used to define a color assignments for reference elements that differs from that of the parent visualization.

Returns ReferenceLayerColorAxis
Since
2.5

ColumnNameMatchTarget

get ColumnNameMatchTarget(): ColumnNameMatch
Gets or sets a value that override the standard column name matching behavior to instead match on columns from this target axis.

Returns ColumnNameMatch
Since
2.2
set ColumnNameMatchTarget(value: ColumnNameMatch): void
Parameters
- value: ColumnNameMatch
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from Layers.Layer.Context

Data

get Data(): ReferenceLayerData
Gets the reference layer data.

Returns ReferenceLayerData
Since
2.5

Details

get Details(): ReferenceLayerDetails
Gets the details object for this layer, containing items that control tooltip settings.

Returns ReferenceLayerDetails
Since
2.3

DisplayName

get DisplayName(): string
Gets the display name.

Returns string
Since
2.2

Inherited from Layers.Layer.DisplayName

ElementByAxis

get ElementByAxis(): ReferenceLayerElementByAxis
Gets the element-by axis of this Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer. This axis is used to perform additional grouping of reference elements. The expression set on this axis must be categorical.

Returns ReferenceLayerElementByAxis
Since
2.5

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

EvaluationModes

get EvaluationModes(): ReferenceValueEvaluationModes
Gets or sets the evaluation modes, describing which axes to group by. The grouping expressions used on the X, Color and Trellis axes are defined by the corresponding axis in the parent visualization. However, the X and Color expressions can be overridden by the Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.XAxis and Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.ColorAxis owned by a Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer instance. Additional grouping can be achieved by using the Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.ElementByAxis which is unrelated to the evaluation modes.

Returns ReferenceValueEvaluationModes
Since
2.2
set EvaluationModes(value: ReferenceValueEvaluationModes): void
Parameters
- value: ReferenceValueEvaluationModes
Returns void

Expression

get Expression(): string
Gets or sets the expression. This is a shorthand to access the Spotfire.Dxp.Application.Visuals.ExpressionColumn.Expression of Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.ValueColumn.

Returns string
Since
2.2
set Expression(value: string): void
Parameters
- value: string
Returns void

IsAttached

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

Returns boolean
Since
2.0

Inherited from Layers.Layer.IsAttached

IsBackground

get IsBackground(): boolean
Gets or sets a value indicating whether to render this element in the background. That is, behind the data layer.

Returns boolean
Since
2.2
set IsBackground(value: boolean): void
Parameters
- value: boolean
Returns void

Label

get Label(): Label
Gets the label reference element settings.

Returns Label
Since
2.2

Legend

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

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

LegendItem

get LegendItem(): LegendReferenceLayerItem
Gets the legend item object for this layer.

Returns LegendReferenceLayerItem
Since
2.3

LegendTitleItem

get LegendTitleItem(): LegendReferenceLayerTitleItem
Gets the legend item object for the title of this layer.

Returns LegendReferenceLayerTitleItem
Since
2.5

LimitByMarking

get LimitByMarking(): boolean
Gets or sets a value indicating whether to limit the reference layer to the marked data.

Returns boolean
Since
2.2
set LimitByMarking(value: boolean): void
Parameters
- value: boolean
Returns void

Line

get Line(): Line
Gets the line reference element settings.

Returns Line
Since
2.2

LineConnection

get LineConnection(): Spotfire.Dxp.Application.Visuals.ReferenceElements.LineConnection
Gets the line connection reference element settings.

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.LineConnection
Since
2.2

Marker

get Marker(): Marker
Gets the marker reference element settings.

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

Relations

get Relations(): VisualizationRelations
Gets the visualizationRelations.

Returns VisualizationRelations
Since
2.2

SecondaryExpression

get SecondaryExpression(): string
Gets or sets the secondary expression. This is a shorthand to access the Spotfire.Dxp.Application.Visuals.ExpressionColumn.Expression of Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.SecondaryValueColumn.

Returns string
Since
2.2
set SecondaryExpression(value: string): void
Parameters
- value: string
Returns void

SecondaryValueColumn

get SecondaryValueColumn(): ReferenceValueColumn
Gets the secondary value column.

Returns ReferenceValueColumn
Since
2.5

Transactions

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

Returns ITransactions
Since
2.0

Inherited from Layers.Layer.Transactions

Transparency

get Transparency(): number
Gets or sets a value for the relative transparency. This value is always in the range [0, 1], where 0 is fully opaque and 1 is fully transparent.

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

ValueAxis

get ValueAxis(): ValueAxis
Gets or sets a value indicating which axis in the parent visualization that is the value axis.

Returns ValueAxis
Since
2.2
set ValueAxis(value: ValueAxis): void
Parameters
- value: ValueAxis
Returns void

ValueColumn

get ValueColumn(): ReferenceValueColumn
Gets the value column.

Returns ReferenceValueColumn
Since
2.5

Width

get Width(): number
Gets or sets a value for the relative width. This value is always in the range [0, 100], where 100 is the full width of the categorical element and 0 means that the element is not visible.

Returns number
Since
2.2
set Width(value: number): void
Parameters
- value: number
Returns void

XAxis

get XAxis(): ReferenceLayerXAxis
Gets the "X axis" of this Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer. This axis can be used to override the expression of the parent category axis, when it is continuous. The expression set on this overriding axis must be continuous and have a type that matches that of the parent category axis.

Returns ReferenceLayerXAxis
Since
2.5

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 ReferenceLayer

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

Band

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.Band

Since

BarSegmentHandling

Returns BarSegmentHandling

Since

Parameters

Returns void

Box

Returns Spotfire.Dxp.Application.Visuals.ReferenceElements.Box

Since

ColorAxis

Returns ReferenceLayerColorAxis

Since

ColumnNameMatchTarget

Returns ColumnNameMatch

Since

Parameters

Returns void

Context

Returns INodeContext

Since

Data

Returns ReferenceLayerData

Since

Details

Returns ReferenceLayerDetails

Since

DisplayName

Returns string

Since

ElementByAxis

Returns ReferenceLayerElementByAxis

Since

Enabled

Returns boolean

Since

Parameters

Returns void

EvaluationModes

Returns ReferenceValueEvaluationModes

Since

Parameters

Returns void

Expression

Returns string

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

IsBackground

`Static`Equals