Class ItemFilter

Representation of an ItemFilter. The item filter has the ability to filter on a single value in the column that is applies on. The value that is being filtered on is given by Spotfire.Dxp.Application.Filters.SingleValueColumnFilter.Value.

In addition to the distinct values in the Spotfire.Dxp.Application.Filters.ColumnFilter.DataColumnReference, the Item Filter can filter on the special values given by the Spotfire.Dxp.Application.Filters.ItemFiltering enumeration. The Spotfire.Dxp.Application.Filters.ItemFiltering.All value is the default value of an Item Filter. The Spotfire.Dxp.Application.Filters.ItemFiltering.None value is the last value in an Item Filter. The Spotfire.Dxp.Application.Filters.ItemFiltering.Empty value is only used when the filter column contains empty values.

Since

2.0

Hierarchy (view full)

Implements

Accessors

FilteredRows TypeId

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AllowAll Context DataColumnReference HasEmptyValues IsAttached ShowNone Transactions Value Values GetPropertyValue HasPropertyValue Reset

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

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

AllowAll

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

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ShowNone

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Value

  • get Value(): unknown

  • Gets or sets the filtered value.

    Returns unknown

    Since

    2.0

  • set Value(value): void

  • Parameters

    • value: unknown

    Returns void

Values

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

Reset

  • Reset(): void

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

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability