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

Class FilterGroup

A container for one or more Spotfire.Dxp.Application.Filters.FilterHandles which can be placed into a Spotfire.Dxp.Application.Filters.FilterPanel to group filters. A FilterGroup is uniquely identified by its name within any given panel.

Since

2.0

Hierarchy (view full)

FilterGroupItem
- FilterGroup
  - FilterSubGroup
  - TableGroup

Implements

Index

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from FilterGroupItem.Cast

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.

Inherited from FilterGroupItem.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from FilterGroupItem.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from FilterGroupItem.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from FilterGroupItem.TryCast

`Static`Equals

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.

Inherited from FilterGroupItem.Equals

Default capability

Context

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

Returns INodeContext
Since
2.0

Inherited from FilterGroupItem.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
set Expanded(value): void
Parameters
- value: boolean
Returns void

FilterHandles

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

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

IsAttached

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

Returns boolean
Since
2.0

Inherited from FilterGroupItem.IsAttached

IsEmpty

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

Returns boolean
Since
2.0

Items

get Items(): FilterGroupItemCollection
Gets the items.

Returns FilterGroupItemCollection
Since
2.0

Name

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

Returns string
Since
2.0

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

ParentGroup

get ParentGroup(): FilterGroup
Gets the parent group.

Returns FilterGroup
Since
2.0

Inherited from FilterGroupItem.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 FilterGroupItem.Selected
set Selected(value): void
Parameters
- value: boolean
Returns void
Inherited from FilterGroupItem.Selected

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from FilterGroupItem.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
Since
2.0

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

Add

Add(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

ClearFilters

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

Returns void
Since
2.0

GetFilter

GetFilter(name): 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

Remove

Remove(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

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