Class ReferenceLayerData

Represents the data for a layer of reference elements.

Since

2.5

Hierarchy (View Summary)

DocumentNode
- ReferenceLayerData

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

ApplyParentDataLimiting

get ApplyParentDataLimiting(): boolean
Gets or sets a value indicating whether the layer shall use the data limitation of the parent visualization. If true, all limiting markings and filterings of the parent are applied as limiting for the layer, in addition to any other limiting specified by the layers itself. The limiting where clause of the parent, if any, is applied if the layer uses the same data table as the parent.

Returns boolean
Since
2.5
set ApplyParentDataLimiting(value: boolean): void
Parameters
- value: boolean
Returns void

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.5
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 Framework.DocumentModel.DocumentNode.Context

DataTableReference

get DataTableReference(): DataTable | null
Gets or sets the Spotfire.Dxp.Data.DataTable that this reference layer uses, or null if it inherits the data table from the parent visualization.

Returns DataTable | null
Since
2.5
set DataTableReference(value: DataTable | null): void
Parameters
- value: DataTable | null
Returns void

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, in a Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer the X and Color expressions can be overridden and additional grouping can be performed. See Spotfire.Dxp.Application.Visuals.ReferenceElements.ReferenceLayer.EvaluationModes.

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

Filterings

get Filterings(): VisualizationFilteringCollection
Gets the collection of auxiliary selections to filter the reference layer data by.

Returns VisualizationFilteringCollection
Since
2.5

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

LimitByMarking

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

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

LimitingMarkingsEmptyBehavior

get LimitingMarkingsEmptyBehavior(): LimitingMarkingsEmptyBehavior
Gets or sets the behavior for when the limiting markings are empty.

Returns LimitingMarkingsEmptyBehavior
Since
2.5
set LimitingMarkingsEmptyBehavior(value: LimitingMarkingsEmptyBehavior): void
Parameters
- value: LimitingMarkingsEmptyBehavior
Returns void

MarkingCombinationMethod

get MarkingCombinationMethod(): DataSelectionCombinationMethod
Gets or sets a value indicating how the data marking selections shall be combined to limit the data shown by the reference layer.

Returns DataSelectionCombinationMethod
Since
2.5
set MarkingCombinationMethod(value: DataSelectionCombinationMethod): void
Parameters
- value: DataSelectionCombinationMethod
Returns void

Relations

get Relations(): VisualizationRelations
Gets the visualizationRelations.

Returns VisualizationRelations
Since
2.5

ShowMultipleTablesMismatchWarnings

get ShowMultipleTablesMismatchWarnings(): boolean
Gets or sets a value indicating whether to show mismatch warnings

Returns boolean
Since
2.5
set ShowMultipleTablesMismatchWarnings(value: boolean): void
Parameters
- value: boolean
Returns void

Transactions

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

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

UseActiveFiltering

get UseActiveFiltering(): boolean
Gets or sets a value indicating whether to use the filtering from the page's filter panel or not.

Returns boolean
Since
2.5
set UseActiveFiltering(value: boolean): void
Parameters
- value: boolean
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.5
set ValueAxis(value: ValueAxis): void
Parameters
- value: ValueAxis
Returns void

WhereClauseExpression

get WhereClauseExpression(): string
Gets or sets the where clause expression that limits the data shown by the reference layer.

Returns string
Since
2.5
set WhereClauseExpression(value: string): void
Parameters
- value: string
Returns void

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

Class ReferenceLayerData

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

ApplyParentDataLimiting

Returns boolean

Since

Parameters

Returns void

ColumnNameMatchTarget

Returns ColumnNameMatch

Since

Parameters

Returns void

Context

Returns INodeContext

Since

DataTableReference

Returns DataTable | null

Since

Parameters

Returns void

EvaluationModes

Returns ReferenceValueEvaluationModes

Since

Parameters

Returns void

Filterings

Returns VisualizationFilteringCollection

Since

IsAttached

Returns boolean

Since

LimitByMarking

Returns boolean

Since

Parameters

Returns void

LimitingMarkingsEmptyBehavior

Returns LimitingMarkingsEmptyBehavior

Since

Parameters

Returns void

MarkingCombinationMethod

Returns DataSelectionCombinationMethod

Since

Parameters

Returns void

Relations

Returns VisualizationRelations

Since

ShowMultipleTablesMismatchWarnings

Returns boolean

Since

Parameters

Returns void

Transactions

`Static`Equals