Action
    Preparing search index...

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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

    Item: PropertyGet<DataColumn, Filter> & PropertyGet<string | String, Filter> & PropertyGet<
        number
        | Int32,
        Filter,
    >

    Gets the element at the specified index.

    The zero-based index of the element to get.

    The element at the specified index.

    2.0

    • get AutoCreateFilters(): boolean

      Gets or sets a value indicating whether to automatically create filters for new columns.

      Returns boolean

      2.0

    • set AutoCreateFilters(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of elements contained in this instance.

      Returns number

      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

    • Creates a filter and adds it to this FilterCollection. This method will make an effort to create a suitable filter for the column based on number of unique values and the column data type.

      Parameters

      Returns Filter

      The Filter that was created and added to this FilterCollection.

      2.0

    • Creates a filter and adds it to this FilterCollection. The filter type corresponds to the supplied filter identifier.

      Parameters

      Returns Filter

      The Filter that was created and added to this FilterCollection.

      2.0

    • Removes all items from this collection.

      Returns void

      2.0

    • Determines whether a Spotfire.Dxp.Data.DataColumn has a filter representation in this collection.

      Parameters

      • column: DataColumn

        The column to locate in this collection.

      Returns boolean

      true if value is found in this collection; otherwise, false.

      2.0

    • Determines whether a named element is in this collection.

      Parameters

      • name: string | String

        The name to locate in this collection.

      Returns boolean

      true if value is found in this collection; otherwise, false.

      2.0

    • Determines whether the specified value is in this collection.

      Parameters

      • value: Filter

        The object to locate in this collection. The value can be null.

      Returns boolean

      true if value is found in this collection; otherwise, false.

      2.0

    • Searches for the specified value and returns the zero-based index of the first occurrence within this collection.

      Parameters

      • value: Filter

        The object to locate. The value can be null.

      Returns number

      The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

      2.0

    • Removes the specified item.

      Parameters

      Returns void

      2.0

    • Resets all filters.

      Returns void

      2.0