Action
    Preparing search index...

    Class ListBoxFilter

    Represents a list box filter. A list box filter allows multiple selection and searching while preserving space. This filter can handle a large amount of categorical values.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    CheckBoxModeEnabled Context DataColumnReference FilteredRows HasEmptyValues Height IncludeAllValues IncludeEmpty IsAttached SearchExpression SearchFieldVisible SelectedValues ShowAll Transactions TypeId ForEachNodeInSubTree GetPropertyValue HasPropertyValue IsSelected Reset SetSelection

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get CheckBoxModeEnabled(): boolean

      Gets or sets a value indicating whether this instance should use check boxes to indicate filtered items.

      Returns boolean

      2.0

    • set CheckBoxModeEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DataColumnReference(): null | DataColumn

      Gets the column instance associated with this filter.

      Returns null | DataColumn

      2.0

    • get FilteredRows(): IndexSet

      Gets the filtered rows.

      Returns IndexSet

      2.0

    • get HasEmptyValues(): boolean

      Gets a value indicating whether the referenced column has any invalid rows.

      Returns boolean

      2.0

    • get Height(): number

      Gets or sets the number of lines to show in the UI list box.

      Returns number

      2.0

    • set Height(value: number): void

      Parameters

      • value: number

      Returns void

    • get IncludeAllValues(): boolean

      Gets or sets a value indicating whether all values should be included or not. True if filtering should include all values, if this property is set to to true then this overrides the SelectedValues list. If this property is set then empty values are included regardless of the Spotfire.Dxp.Application.Filters.ListBoxFilter.IncludeEmpty setting.

      Returns boolean

      2.0

    • set IncludeAllValues(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IncludeEmpty(): boolean

      Gets or sets a value indicating whether we should include empty values or not. If this is true then the empty values in this column will not be filtered out by this filter, otherwise the empty values will be filtered out by this filter.

      Returns boolean

      2.0

    • set IncludeEmpty(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • 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

      2.0

    • set SearchExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get SearchFieldVisible(): boolean

      Gets or sets a value indicating whether the search field should be visible in the UI or not.

      Returns boolean

      2.0

    • set SearchFieldVisible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowAll(): boolean

      Gets or sets a value indicating whether (All) is shown in the filter or not.

      Returns boolean

      2.0

    • set ShowAll(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • Gets the value of a specified property.

      Parameters

      • propertyName: string | String

        The property name, case insensitive.

      Returns unknown

      The property value.

      2.0

    • 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.

      2.0

    • Check if a value is selected or not.

      Parameters

      • value: any

        The value.

      Returns boolean

      True if the value is selected, false otherwise.

      2.0

    • Resets the filter. After calling this method, the filter does not filter out any rows.

      Returns void

      2.0

    • Select the given values, this will remove all previously selected values. Note that the IncludeAllValues property needs to be set to false in order for this selection to affect the filtering.

      Parameters

      • ...values: any[]

        The values to add.

      Returns void

      2.0

    • Select the given values, this will remove all previously selected values. Note that the IncludeAllValues property needs to be set to false in order for this selection to affect the filtering.

      Parameters

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability