Action
    Preparing search index...

    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.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

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

    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.

    • 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 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 IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Value(): unknown

      Gets or sets the filtered value.

      Returns unknown

      Setting this property to Spotfire.Dxp.Application.Filters.ItemFiltering.Empty when the filter column does not have empty values will have no effect.

      2.0

    • set Value(value: unknown): void

      Parameters

      • value: unknown

      Returns void

    • 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

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

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability