About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class Dendrogram

Represents the dendrogram and hierarchical clustering settings used in the Spotfire.Dxp.Application.Visuals.HeatMap.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- Dendrogram

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

ClusteringSettings

get ClusteringSettings(): HierarchicalClusteringSettings
Gets or sets the clustering settings.

Returns HierarchicalClusteringSettings
Since
2.0
set ClusteringSettings(value: HierarchicalClusteringSettings): void
Parameters
- value: HierarchicalClusteringSettings
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
Gets or sets the data table reference.

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

Dock

get Dock(): ScaleDock
Gets or sets the docking of the dendrogram area.

Returns ScaleDock
Since
2.0
set Dock(value: ScaleDock): void
Parameters
- value: ScaleDock
Returns void

EmptyValueReplacement

get EmptyValueReplacement(): HeatMapEmptyValueReplacement
Gets or sets the empty value replacement.

Returns HeatMapEmptyValueReplacement
Since
2.0
set EmptyValueReplacement(value: HeatMapEmptyValueReplacement): void
Parameters
- value: HeatMapEmptyValueReplacement
Returns void

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

LegendItem

get LegendItem(): DendrogramLegendItem
Gets the dendrogram legend item.

Returns DendrogramLegendItem
Since
2.0

ManualUpdate

get ManualUpdate(): boolean
Gets or sets a value indicating whether clustering needs to be manually updated.

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

Normalization

get Normalization(): HeatMapNormalization
Gets or sets the normalization. The normalization may be set to null.

Returns HeatMapNormalization
Since
2.0
set Normalization(value: HeatMapNormalization): void
Parameters
- value: HeatMapNormalization
Returns void

PruningColorA

get PruningColorA(): Color
Gets or sets the first of two alternating colors used to indicate clusters in the dendrogram.

Returns Color
Since
2.0
set PruningColorA(value: Color): void
Parameters
- value: Color
Returns void

PruningColorB

get PruningColorB(): Color
Gets or sets the second of two alternating colors used to indicate clusters in the dendrogram.

Returns Color
Since
2.0
set PruningColorB(value: Color): void
Parameters
- value: Color
Returns void

PruningLevel

get PruningLevel(): number
Gets or sets the pruning level for the dendrogram. This is the minimum number of values in the prune column.

Returns number
Since
2.0
set PruningLevel(value: number): void
Parameters
- value: number
Returns void

PruningLineColor

get PruningLineColor(): Color
Gets or sets the color used for drawing the pruning line in the dendrogram.

Returns Color
Since
2.0
set PruningLineColor(value: Color): void
Parameters
- value: Color
Returns void

ShowPruningLine

get ShowPruningLine(): boolean
Gets or sets a value indicating whether the pruning line is visible in the dendrogram.

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

Span

get Span(): number
Gets or sets the span of the dendrogram area.

Returns number
Since
2.0
set Span(value: number): void
Parameters
- value: number
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

UseDataTable

get UseDataTable(): boolean
Gets or sets a value indicating whether or not to use the Spotfire.Dxp.Data.DataTable in Spotfire.Dxp.Application.Visuals.Dendrogram.DataTableReference as dendrogram.

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

Visible

get Visible(): boolean
Gets or sets a value indicating whether to show dendrogram.

Returns boolean
Since
2.0
set Visible(value: boolean): void
Parameters
- value: boolean
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

GetData

GetData(): DataRowReader
Return the dendrogram data as a Spotfire.Dxp.Data.DataRowReader.

Returns DataRowReader
A Spotfire.Dxp.Data.DataRowReader containing the dendrogram data.

Since
2.0

Update

Update(): void
Updates the row clustering.

Returns void
Since
2.0