Class SummaryTableVisibleColumnCollection

Collection of columns used in the plot. This collection contains the columns visible in a Spotfire.Dxp.Application.Visuals.SummaryTable. The collection is synchronized with changes in the underlying data, such as remove, add and rename of columns.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions AddNew Clear Contains GetEnumerator IndexOf Move Remove RemoveAt

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): 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

    Returns null | T1

[iterator]

StaticEquals

  • Equals(objA, objB): 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.

Default capability

ReadonlyItem

Item: PropertyGet<number | Int32, SummaryTableVisibleColumn> & PropertyGet<string | String, SummaryTableVisibleColumn>

Returns the Spotfire.Dxp.Application.Visuals.SummaryTableVisibleColumn for the data column named columnName.

Param: columnName

The name of the column to find.

Returns

The Spotfire.Dxp.Application.Visuals.SummaryTableVisibleColumn.

Since

2.0

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Count

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

AddNew

Clear

  • Clear(): void

  • Clears the collection.

    Returns void

    Since

    2.0

Contains

  • Contains(column): boolean

  • Determines whether this Spotfire.Dxp.Application.Visuals.SummaryTableVisibleColumnCollection contains the specified column.

    Parameters

    Returns boolean

    true if this instance contains the specified column; otherwise, false.

    Since

    2.0

  • Contains(columnName): boolean

  • Checks if columnName is contained in this collection.

    Parameters

    • columnName: string | String

      The name of the column to look for.

    Returns boolean

    true if the column is part of the collection; otherwise false.

    Since

    2.0

GetEnumerator

IndexOf

  • IndexOf(column): number

  • Returns the index in the collection that the column has.

    Parameters

    Returns number

    The index of the column if it exists, otherwise -1.

    Since

    2.0

Move

  • Move(fromIndex, toIndex): void

  • Move the item at fromIndex to toIndex where both indexes are prior to any insertion and removal operations.

    Parameters

    • fromIndex: number | Int32

      From index.

    • toIndex: number | Int32

      To index.

    Returns void

    Since

    2.0

Remove

  • Remove(columnName): boolean

  • Removes the column named columnName from the collection if it exists.

    Parameters

    • columnName: string | String

      The name of the column to be removed.

    Returns boolean

    true if the column was found and removed; otherwise false.

    Since

    2.0

  • Remove(item): boolean

  • Removes a column from the collection.

    Parameters

    Returns boolean

    true if the column was found and removed; otherwise, false.

    Since

    2.0

RemoveAt

Settings

Member Visibility

On This Page

Methods
Default capability