Class VisualizationData

Visualization data.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- VisualizationData

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>): null | T1
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 null | T1
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(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

DataTableLegendItem

get DataTableLegendItem(): LegendDataTableItem
Gets the legend item for the data table.

Returns LegendDataTableItem
Since
2.0

DataTableReference

get DataTableReference(): null | DataTable
Gets or sets the data table reference.

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

Filterings

get Filterings(): VisualizationFilteringCollection
A collection of auxilliary selections to filter the visualization data by.

Returns VisualizationFilteringCollection
Remark
This collection can be used to create detail visualizations. To do that, simply add one or more marking selections to the collection.

Since
2.0

FilteringsLegendItem

get FilteringsLegendItem(): LegendFilteringsItem
Gets the legend item for the filterings.

Returns LegendFilteringsItem
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

LimitingMarkingsEmptyBehavior

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

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

LimitingMarkingsEmptyMessage

get LimitingMarkingsEmptyMessage(): string
Gets or sets the message to show when the limiting markings are empty. This message is used when Spotfire.Dxp.Application.Visuals.VisualizationData.LimitingMarkingsEmptyBehavior is set to ShowMessage.

Returns string
Since
2.0
set LimitingMarkingsEmptyMessage(value: string): void
Parameters
- value: string
Returns void

LimitingMarkingsEmptyMessageFontMetadata

get LimitingMarkingsEmptyMessageFontMetadata(): FontMetadata
Gets or sets the font to use when the limiting markings are empty. This font is used when Spotfire.Dxp.Application.Visuals.VisualizationData.LimitingMarkingsEmptyBehavior is set to ShowMessage.

Returns FontMetadata
Since
2.0
set LimitingMarkingsEmptyMessageFontMetadata(value: FontMetadata): void
Parameters
- value: FontMetadata
Returns void

MarkingCombinationMethod

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

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

MarkingLegendItem

get MarkingLegendItem(): LegendMarkingItem
Gets the legend item for the marking.

Returns LegendMarkingItem
Since
2.0

MarkingReference

get MarkingReference(): null | DataMarkingSelection
Gets or sets the marking selection used to mark markers in the visualization.

Returns null | DataMarkingSelection
Remark
If the marking reference is set to null (the default), no marking will be displayed in the visualization, and the user cannot mark anything.

Note that if the marking reference is also present in Spotfire.Dxp.Application.Visuals.VisualizationData.Filterings, the user will not be able to mark anything either.

Since
2.0
set MarkingReference(value: null | DataMarkingSelection): void
Parameters
- value: null | DataMarkingSelection
Returns void

Relations

get Relations(): VisualizationRelations
Gets the preferred Spotfire.Dxp.Data.ColumnRelations for the visualization.

Returns VisualizationRelations
Since
2.0

Subsets

get Subsets(): VisualizationSubsetCollection
Gets the collection of subsets displayed in the visualization.

Returns VisualizationSubsetCollection
Since
2.0

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
Remark
This is true by default. By setting it to false, the visualization data is no longer filtered by the filter panel, only explicitly by the selections defined by Spotfire.Dxp.Application.Visuals.VisualizationData.Filterings.

Since
2.0
set UseActiveFiltering(value: boolean): void
Parameters
- value: boolean
Returns void

WhereClauseExpression

get WhereClauseExpression(): string
Gets or sets the where clause (a boolean expression) that limits the data shown by the visualization, or null. Setting the expression to the empty string will set it to null.

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

AutoConfigure

AutoConfigure(): void
Configures with reasonable default values given the current data.

Returns void
Since
2.0

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 VisualizationData

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

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

DataTableLegendItem

Returns LegendDataTableItem

Since

DataTableReference

Returns null | DataTable

Since

Parameters

Returns void

Filterings

Returns VisualizationFilteringCollection

Remark

Since

FilteringsLegendItem

Returns LegendFilteringsItem

Since

IsAttached

Returns boolean

Since

LimitingMarkingsEmptyBehavior

Returns LimitingMarkingsEmptyBehavior

Since

Parameters

Returns void

LimitingMarkingsEmptyMessage

Returns string

Since

Parameters

Returns void

LimitingMarkingsEmptyMessageFontMetadata

Returns FontMetadata

Since

Parameters

Returns void

MarkingCombinationMethod

Returns DataSelectionCombinationMethod

Since

Parameters

Returns void

MarkingLegendItem

Returns LegendMarkingItem

Since

MarkingReference

Returns null | DataMarkingSelection

Remark

Since

Parameters

Returns void

Relations

Returns VisualizationRelations

Since

`Static`Equals