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 Summary)

FilterGroup
- TableGroup

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 FilterGroup.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 FilterGroup.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from FilterGroup.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from FilterGroup.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 FilterGroup.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 FilterGroup.Equals

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: boolean): void
Parameters
- value: boolean
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from FilterGroup.Context

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

Inherited from FilterGroup.Expanded
set Expanded(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FilterGroup.Expanded

FilterCollectionReference

get FilterCollectionReference(): FilterCollection
Gets the Spotfire.Dxp.Application.Filters.FilterCollection for this TableGroup.

Returns FilterCollection
Since
2.0

FilterHandles

get FilterHandles(): System.Collections.Generic.IEnumerable<FilterHandle>
Gets the filter handles in this group.

Returns System.Collections.Generic.IEnumerable<FilterHandle>
Since
2.0

Inherited from FilterGroup.FilterHandles

IsAttached

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

Returns boolean
Since
2.0

Inherited from FilterGroup.IsAttached

IsEmpty

get IsEmpty(): boolean
Gets a value indicating whether or not this group is empty.

Returns boolean
Since
2.0

Inherited from FilterGroup.IsEmpty

Items

get Items(): FilterGroupItemCollection
Gets the items.

Returns FilterGroupItemCollection
Since
2.0

Inherited from FilterGroup.Items

Name

get Name(): string
Gets the group display name, that is, its caption.

Returns string
Since
2.0

Inherited from FilterGroup.Name

Panel

get Panel(): FilterPanel
Gets the Spotfire.Dxp.Application.Filters.FilterPanel to which this Spotfire.Dxp.Application.Filters.FilterGroup belongs.

Returns FilterPanel
Since
2.0

Inherited from FilterGroup.Panel

ParentGroup

get ParentGroup(): FilterGroup
Gets the parent group.

Returns FilterGroup
Since
2.0

Inherited from FilterGroup.ParentGroup

Selected

get Selected(): boolean
Gets a value indicating whether this Spotfire.Dxp.Application.Filters.FilterGroupItem is selected.

Returns boolean
Since
2.0

Inherited from FilterGroup.Selected
set Selected(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FilterGroup.Selected

SubGroups

get SubGroups(): System.Collections.Generic.IEnumerable<FilterSubGroup>
Gets the subgroups of this root group.

Returns System.Collections.Generic.IEnumerable<FilterSubGroup>
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 FilterGroup.Transactions

Visible

get Visible(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Filters.FilterGroupItem is visible in its Spotfire.Dxp.Application.Filters.FilterGroup.

Returns boolean
Remark
Hiding a Spotfire.Dxp.Application.Filters.FilterHandle by setting this property to false will not remove the Spotfire.Dxp.Application.Filters.FilterHandle from its group. Note that filters that are hidden as a cause of them not matching the Spotfire.Dxp.Application.Filters.FilterPanel.InteractiveSearchPattern of the Spotfire.Dxp.Application.Filters.FilterPanel can still return true for queries to this property.

Since
2.0

Inherited from FilterGroup.Visible
set Visible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FilterGroup.Visible

Add

Add(filter: Filter): FilterHandle
Adds the specified Spotfire.Dxp.Application.Filters.Filter to this group, a Spotfire.Dxp.Application.Filters.FilterHandle is created and returned.
Parameters
- filter: Filter
  The filter to add.
Returns FilterHandle
The FilterHandle that represent the added filter

Since
2.0

Inherited from FilterGroup.Add

AddNewSubGroup

AddNewSubGroup(name: string | String): 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
- name: string | String
  The name of the new group to create. Note that this name must be unique within this Spotfire.Dxp.Application.Filters.TableGroup.
Returns FilterSubGroup
The newly created group.

Since
2.0

ClearFilters

ClearFilters(): void
Removes all existing Spotfire.Dxp.Application.Filters.FilterHandle from this group.

Returns void
Since
2.0

Inherited from FilterGroup.ClearFilters

ClearSubGroups

ClearSubGroups(): void
Removes all subgroups from this group.

Returns void
Since
2.0

GetFilter

GetFilter(name: string | String): FilterHandle
Finds a filter in this group, given its Spotfire.Dxp.Application.Filters.Filter.Name.
Parameters
- name: string | String
  The name of the filter to get.
Returns FilterHandle
The filter with specified name, or null if no such filter exists.

Since
2.0

Inherited from FilterGroup.GetFilter

GetSubGroup

GetSubGroup(name: string | String): FilterSubGroup
Finds a subgroup in this group, given its Spotfire.Dxp.Application.Filters.FilterGroup.Name.
Parameters
- name: string | String
  The name of the group to get.
Returns FilterSubGroup
The group with specified name, or null if no such subgroup exists.

Since
2.0

InsertNewSubGroup

InsertNewSubGroup(name: string | String, index: number | Int32): 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

Remove(filter: Filter): void
Removes the Spotfire.Dxp.Application.Filters.FilterHandle for the specified Spotfire.Dxp.Application.Filters.Filter from this group. If the filter is not a member of this group, calling this method will not have any effect.
Parameters
- filter: Filter
  The filter to remove.
Returns void
Since
2.0

Overrides FilterGroup.Remove
Remove(subGroup: FilterSubGroup): void
Removes the specified subgroup from this group. If the filter is not a member of this group, it will not be removed.
Parameters
- subGroup: FilterSubGroup
  The sub group to remove.
Returns void
Since
2.0

Overrides FilterGroup.Remove

SortMembersAscending

SortMembersAscending(): void
Sorts the members of this group alphabetically ascending, based on the names of the members.

Returns void
Since
2.0

Inherited from FilterGroup.SortMembersAscending

SortMembersDescending

SortMembersDescending(): void
Sorts the members of this group alphabetically descending, based on the names of the members.

Returns void
Since
2.0

Inherited from FilterGroup.SortMembersDescending

Class TableGroup

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

AutoSynchronizeFilters

Returns boolean

Since

Parameters

Returns void

Context

Returns INodeContext

Since

Expanded

Returns boolean

Since

Parameters

Returns void

FilterCollectionReference

Returns FilterCollection

Since

FilterHandles

Returns System.Collections.Generic.IEnumerable<FilterHandle>

Since

IsAttached

Returns boolean

Since

IsEmpty

Returns boolean

Since

Items

Returns FilterGroupItemCollection

Since

Name

Returns string

Since

Panel

Returns FilterPanel

Since

ParentGroup

Returns FilterGroup

Since

Selected

Returns boolean

Since

Parameters

Returns void

SubGroups

Returns System.Collections.Generic.IEnumerable<FilterSubGroup>

Since

Transactions

Returns ITransactions

Since

Visible

Returns boolean

Remark

Since

Parameters

`Static`Equals