Class TableGroup

A specialization of the Spotfire.Dxp.Application.Filters.FilterGroup, representing one root group that exists within a Spotfire.Dxp.Application.Filters.FilterPanel and that can be accessed through the Spotfire.Dxp.Application.Filters.FilterPanel.TableGroups property. In addition to the functionality of standard groups, the root group can contain one or more subgroups. Subgroups are added using the AddNewSubGroup(name) method. Additionally, the root filter group is special in the sense that is cannot be renamed.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AutoSynchronizeFilters Context Expanded FilterCollectionReference FilterHandles IsAttached IsEmpty Items Name Panel ParentGroup Selected SubGroups Transactions Visible Add AddNewSubGroup ClearFilters ClearSubGroups GetFilter GetSubGroup InsertNewSubGroup Remove SortMembersAscending SortMembersDescending

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

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

AutoSynchronizeFilters

  • get AutoSynchronizeFilters(): boolean

  • Gets or sets a value indicating whether to auto synchronize filters handles when the Spotfire.Dxp.Application.Filters.FilterCollection changes.

    Returns boolean

    Since

    2.0

  • set AutoSynchronizeFilters(value): void

  • Parameters

    • value: boolean

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Expanded

  • get Expanded(): boolean

  • Gets a value indicating whether this group is expanded or collapsed. This property defaults to true.

    Returns boolean

    Since

    2.0

  • set Expanded(value): void

  • Parameters

    • value: boolean

    Returns void

FilterCollectionReference

FilterHandles

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsEmpty

  • get IsEmpty(): boolean

  • Gets a value indicating whether or not this group is empty.

    Returns boolean

    Since

    2.0

Items

Name

  • get Name(): string

  • Gets the group display name, that is, its caption.

    Returns string

    Since

    2.0

Panel

ParentGroup

  • get ParentGroup(): FilterGroup

  • Gets the parent group.

    Returns FilterGroup

    Since

    2.0

Selected

  • get Selected(): boolean

  • Gets a value indicating whether this Spotfire.Dxp.Application.Filters.FilterGroupItem is selected.

    Returns boolean

    Since

    2.0

  • set Selected(value): void

  • Parameters

    • value: boolean

    Returns void

SubGroups

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Visible

Add

AddNewSubGroup

  • AddNewSubGroup(name): FilterSubGroup

  • Adds a new filter group with the given name as a subgroup of this group. The new group is added to the end of the list of members of this group.

    Parameters

    Returns FilterSubGroup

    The newly created group.

    Since

    2.0

ClearFilters

ClearSubGroups

  • ClearSubGroups(): void

  • Removes all subgroups from this group.

    Returns void

    Since

    2.0

GetFilter

GetSubGroup

InsertNewSubGroup

  • InsertNewSubGroup(name, index): FilterSubGroup

  • Creates a new filter group with the given name and inserts it as a subgroup of this group at the given position.

    Parameters

    • name: string | String

      The name of the new group to create. Note that this name must be unique within the Spotfire.Dxp.Application.Filters.TableGroup.

    • index: number | Int32

      The index at which the new group is inserted after being created. The valid range for this parameter is [0, number of existing members].

    Returns FilterSubGroup

    The newly created group.

    Since

    2.0

Remove

SortMembersAscending

  • SortMembersAscending(): void

  • Sorts the members of this group alphabetically ascending, based on the names of the members.

    Returns void

    Since

    2.0

SortMembersDescending

  • SortMembersDescending(): void

  • Sorts the members of this group alphabetically descending, based on the names of the members.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability