Class CheckBoxHierarchyFilter

Representation of the Check Box Hierarchy Filter.

Since

2.0

Hierarchy (View Summary)

HierarchyFilter
- CheckBoxHierarchyFilter

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from HierarchyFilter.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

Context

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

Returns INodeContext
Since
2.0

Inherited from HierarchyFilter.Context

DataColumnReference

get DataColumnReference(): DataColumn
Gets the Spotfire.Dxp.Data.DataColumn instance associated with this filter.

Returns DataColumn
Since
2.0

Inherited from HierarchyFilter.DataColumnReference

FilteredRows

get FilteredRows(): IndexSet
Gets the filtered rows.

Returns IndexSet
Since
2.0

Inherited from HierarchyFilter.FilteredRows

HasFixedHeight

get HasFixedHeight(): boolean
Gets or sets a value indicating whether the height of the filter is fixed. If the number of items does not fit within the specified height then a scrollbar is added.

Returns boolean
Since
2.0
set HasFixedHeight(value: boolean): void
Parameters
- value: boolean
Returns void

Height

get Height(): number
Gets or sets the number of lines to show in the UI list box. This setting only has an effect if Spotfire.Dxp.Application.Filters.CheckBoxHierarchyFilter.HasFixedHeight is true.

Returns number
Since
2.0
set Height(value: number): void
Parameters
- value: number
Returns void

Hierarchy

get Hierarchy(): DataHierarchy
Gets the Spotfire.Dxp.Data.DataHierarchy instance associated with this filter.

Returns DataHierarchy
Since
2.0

Inherited from HierarchyFilter.Hierarchy

IsAttached

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

Returns boolean
Since
2.0

Inherited from HierarchyFilter.IsAttached

SearchAllLevels

get SearchAllLevels(): boolean
Gets or sets a value indicating whether the search should be performed in all levels in the hierarchy.

Returns boolean
Since
2.0
set SearchAllLevels(value: boolean): void
Parameters
- value: boolean
Returns void

SearchExpression

get SearchExpression(): string
Gets or sets the search expression that determines which values are to be shown in the user interface. This property does not affect which rows are filtered out.

Returns string
Since
2.0
set SearchExpression(value: string): void
Parameters
- value: string
Returns void

SearchFieldVisible

get SearchFieldVisible(): boolean
Gets or sets a value indicating whether the search field should be visible in the UI or not.

Returns boolean
Since
2.0
set SearchFieldVisible(value: boolean): void
Parameters
- value: boolean
Returns void

SearchLevel

get SearchLevel(): number
Gets or sets the level in the hierarhcy where the search is performed. This value has an affect only if Spotfire.Dxp.Application.Filters.CheckBoxHierarchyFilter.SearchAllLevels is false.

Returns number
Since
2.0
set SearchLevel(value: number): void
Parameters
- value: number
Returns void

Transactions

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

Returns ITransactions
Since
2.0

Inherited from HierarchyFilter.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets the type id.

Returns TypeIdentifier
Since
2.0

Inherited from HierarchyFilter.TypeId

Check

Check(nodePath: List<DistinctDataValue>): void
Checks the node with path nodePath.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns void
Since
2.0
Check(...nodePath: DistinctDataValue[]): void
Checks the node with path nodePath.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns void
Since
2.0

CheckAllNodes

CheckAllNodes(): void
Checks all nodes in this filter.

Returns void
Since
2.0

Collapse

Collapse(nodePath: List<DistinctDataValue>): void
Collapses the specified node path.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns void
Since
2.0
Collapse(...nodePath: DistinctDataValue[]): void
Collapses the specified node path.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns void
Since
2.0

Expand

Expand(nodePath: List<DistinctDataValue>): void
Expands the specified node path.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns void
Since
2.0
Expand(...nodePath: DistinctDataValue[]): void
Expands the specified node path.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns void
Since
2.0

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

GetPropertyValue

GetPropertyValue(propertyName: string | String): unknown
Gets the value of a specified property.
Parameters
- propertyName: string | String
  The property name, case insensitive.
Returns unknown
The property value.

Since
2.0

Inherited from HierarchyFilter.GetPropertyValue

HasPropertyValue

HasPropertyValue(propertyName: string | String): boolean
Checks if there is a valid value for a specified property.
Parameters
- propertyName: string | String
  The property name, case insensitive.
Returns boolean
true if the property has a valid value, otherwise false.

Since
2.0

Inherited from HierarchyFilter.HasPropertyValue

IsChecked

IsChecked(nodePath: List<DistinctDataValue>): boolean
Determines whether the node at nodePath is checked or unchecked.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns boolean
true if the node is checked; otherwise false.

Since
2.0
IsChecked(...nodePath: DistinctDataValue[]): boolean
Determines whether the node at nodePath is checked or unchecked.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns boolean
true if the node is checked; otherwise false.

Since
2.0

IsExpanded

IsExpanded(nodePath: List<DistinctDataValue>): boolean
Determines whether the specified node path is expanded.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns boolean
true if the specified node path is expanded; otherwise, false.

Since
2.0
IsExpanded(...nodePath: DistinctDataValue[]): boolean
Determines whether the specified node path is expanded.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns boolean
true if the specified node path is expanded; otherwise, false.

Since
2.0

Reset

Reset(): void
Resets the filter. After calling this method, the filter does not filter out any rows.

Returns void
Since
2.0

Inherited from HierarchyFilter.Reset

UnCheck

UnCheck(nodePath: List<DistinctDataValue>): void
Unchecks the node with path nodePath.
Parameters
- nodePath: List<DistinctDataValue>
  The node path.
Returns void
Since
2.0
UnCheck(...nodePath: DistinctDataValue[]): void
Unchecks the node with path nodePath.
Parameters
- ...nodePath: DistinctDataValue[]
  The node path.
Returns void
Since
2.0

UncheckAllNodes

UncheckAllNodes(): void
Unchecks all nodes in this filter. Doing so causes all data values to be filtered out.

Returns void
Since
2.0

Class CheckBoxHierarchyFilter

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

DataColumnReference

Returns DataColumn

Since

FilteredRows

Returns IndexSet

Since

HasFixedHeight

Returns boolean

Since

Parameters

Returns void

Height

Returns number

Since

Parameters

Returns void

Hierarchy

Returns DataHierarchy

Since

IsAttached

Returns boolean

Since

SearchAllLevels

Returns boolean

Since

Parameters

Returns void

SearchExpression

Returns string

Since

Parameters

Returns void

SearchFieldVisible

Returns boolean

Since

Parameters

Returns void

SearchLevel

Returns number

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

TypeId

Returns TypeIdentifier

Since

Check

Parameters

`Static`Equals