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.

Since

2.0

Hierarchy (view full)

Implements

Accessors

FilteredRows TypeId

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

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

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

CheckBoxModeEnabled

  • get CheckBoxModeEnabled(): boolean

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

    Returns boolean

    Since

    2.0

  • set CheckBoxModeEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataColumnReference

  • get DataColumnReference(): null | DataColumn

  • Gets the column instance associated with this filter.

    Returns null | DataColumn

    Since

    2.0

HasEmptyValues

  • get HasEmptyValues(): boolean

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

    Returns boolean

    Since

    2.0

Height

  • get Height(): number

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

    Returns number

    Since

    2.0

  • set Height(value): void

  • Parameters

    • value: number

    Returns void

IncludeAllValues

  • 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

    Since

    2.0

  • set IncludeAllValues(value): void

  • Parameters

    • value: boolean

    Returns void

IncludeEmpty

  • 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

    Since

    2.0

  • set IncludeEmpty(value): void

  • Parameters

    • value: boolean

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

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

SelectedValues

ShowAll

  • get ShowAll(): boolean

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

    Returns boolean

    Since

    2.0

  • set ShowAll(value): void

  • Parameters

    • value: boolean

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    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

IsSelected

  • IsSelected(value): boolean

  • Check if a value is selected or not.

    Parameters

    • value: any

      The value.

    Returns boolean

    True if the value is selected, false otherwise.

    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

SetSelection

  • SetSelection(values): void

  • 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

    Since

    2.0

  • SetSelection(...values): void

  • 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

    • Rest...values: any[]

      The values to add.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability