Class FilterHandle

A FilterHandle represents a Spotfire.Dxp.Application.Filters.Filter when it is placed inside a Spotfire.Dxp.Application.Filters.FilterGroup.

Since

2.0

Hierarchy (View Summary)

FilterGroupItem
- FilterHandle

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context FilterReference IsAttached ParentGroup Selected Transactions Visible ForEachNodeInSubTree

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 FilterGroupItem.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 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: 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 FilterGroupItem.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 FilterGroupItem.Equals

Default capability

Context

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

Returns INodeContext
Since
2.0

Inherited from FilterGroupItem.Context

FilterReference

get FilterReference(): Filter
Gets the Spotfire.Dxp.Application.Filters.Filter that this FilterHandle references.

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

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

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 FilterGroupItem.ForEachNodeInSubTree

Class FilterHandle

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

Context

Returns INodeContext

Since

FilterReference

Returns Filter

Since

IsAttached

Returns boolean

Since

ParentGroup

Returns FilterGroup

Since

Selected

Returns boolean

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

Visible

Returns boolean

Remark

Since

Parameters

Returns void

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals