Class CheckBoxHierarchyFilter

Representation of the Check Box Hierarchy Filter.

Since

2.0

Hierarchy (view full)

Implements

Accessors

FilteredRows TypeId

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DataColumnReference HasFixedHeight Height Hierarchy IsAttached SearchAllLevels SearchExpression SearchFieldVisible SearchLevel Transactions Check CheckAllNodes Collapse Expand GetPropertyValue HasPropertyValue IsChecked IsExpanded Reset UnCheck UncheckAllNodes

Accessors

FilteredRows

  • get FilteredRows(): IndexSet

  • Gets the filtered rows.

    Returns IndexSet

TypeId

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataColumnReference

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): void

  • Parameters

    • value: boolean

    Returns void

Height

Hierarchy

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

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): 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): 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): void

  • Parameters

    • value: boolean

    Returns void

SearchLevel

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Check

  • Check(nodePath): void

  • Checks the node with path nodePath.

    Parameters

    Returns void

    Since

    2.0

  • Check(...nodePath): void

  • Checks the node with path nodePath.

    Parameters

    Returns void

    Since

    2.0

CheckAllNodes

  • CheckAllNodes(): void

  • Checks all nodes in this filter.

    Returns void

    Since

    2.0

Collapse

  • Collapse(...nodePath): void

  • Collapses the specified node path.

    Parameters

    Returns void

    Since

    2.0

  • Collapse(nodePath): void

  • Collapses the specified node path.

    Parameters

    Returns void

    Since

    2.0

Expand

  • Expand(...nodePath): void

  • Expands the specified node path.

    Parameters

    Returns void

    Since

    2.0

  • Expand(nodePath): void

  • Expands the specified node path.

    Parameters

    Returns void

    Since

    2.0

GetPropertyValue

  • GetPropertyValue(propertyName): 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

HasPropertyValue

  • HasPropertyValue(propertyName): 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

IsChecked

  • IsChecked(...nodePath): boolean

  • Determines whether the node at nodePath is checked or unchecked.

    Parameters

    Returns boolean

    true if the node is checked; otherwise false.

    Since

    2.0

  • IsChecked(nodePath): boolean

  • Determines whether the node at nodePath is checked or unchecked.

    Parameters

    Returns boolean

    true if the node is checked; otherwise false.

    Since

    2.0

IsExpanded

  • IsExpanded(...nodePath): boolean

  • Determines whether the specified node path is expanded.

    Parameters

    Returns boolean

    true if the specified node path is expanded; otherwise, false.

    Since

    2.0

  • IsExpanded(nodePath): boolean

  • Determines whether the specified node path is expanded.

    Parameters

    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

UnCheck

  • UnCheck(nodePath): void

  • Unchecks the node with path nodePath.

    Parameters

    Returns void

    Since

    2.0

  • UnCheck(...nodePath): void

  • Unchecks the node with path nodePath.

    Parameters

    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

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability