Class DetailItemCollection

A collection of parts that build up detail (tooltip) information.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DetailItemCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached Transactions AddExpression ForEachNodeInSubTree IndexOf InsertExpression Move Remove

Methods

[iterator]

"[iterator]"(): Iterator<DetailItem>
Returns Iterator<DetailItem>

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

`Readonly`Item

Item: PropertyGet<number | Int32, DetailItem>

Gets the Spotfire.Dxp.Application.Visuals.DetailItem at the specified index.

Since

2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of items in the collection.

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

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

AddExpression

AddExpression(expression: string | String): ExpressionDetailItem
Adds a detail item based on an expression.
Parameters
- expression: string | String
  The expression.
Returns ExpressionDetailItem
An Spotfire.Dxp.Application.Visuals.ExpressionDetailItem

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

IndexOf

IndexOf(item: DetailItem): number
Determines the index of a specific item.
Parameters
- item: DetailItem
  The object to locate.
Returns number
The index of item if found in the collection; otherwise, -1.

Since
2.0

InsertExpression

InsertExpression(
index: number | Int32,
expression: string | String,
): ExpressionDetailItem
Inserts a detail item based on an expression.
Parameters
- index: number | Int32
  Index to insert at.
- expression: string | String
  The expression.
Returns ExpressionDetailItem
An Spotfire.Dxp.Application.Visuals.ExpressionDetailItem

Since
2.0

Move

Move(oldIndex: number | Int32, newIndex: number | Int32): void
Moves the item at the specified index to a new location in the collection
Parameters
- oldIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- newIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(item: DetailItem): boolean
Removes the specified item from the collection.
Parameters
- item: DetailItem
  The item.
Returns boolean
True if the item was succesfully removed. False if the item could not be removed or if it could not be found in the collection

Remark
Only user defined items (Spotfire.Dxp.Application.Visuals.ExpressionDetailItem) can bed added and removed. The default items supplied by the owning plot cannot be removed, and hence return false.

Since
2.0

Class DetailItemCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<DetailItem>

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

ReadonlyItem

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddExpression

Parameters

Returns ExpressionDetailItem

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

IndexOf

Parameters

Returns number

Since

InsertExpression

Parameters

Returns ExpressionDetailItem

Since

Move

Parameters

Returns void

Since

Remove

Parameters

Returns boolean

Remark

Since

Settings

On This Page

`Static`Equals

`Readonly`Item