Class FilterCollection

The FilterCollection contains the Spotfire.Dxp.Application.Filters.Filters for a specific Spotfire.Dxp.Data.DataTable in a Spotfire.Dxp.Application.Filters.FilteringScheme.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item AutoCreateFilters Context Count DataTableReference FilteredRows IsAttached Transactions AddNewFilter AutoConfigure Clear Contains GetEnumerator IndexOf Remove ResetAllFilters ToArray

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

[iterator]

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

ReadonlyItem

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

Gets the element at the specified index.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index.

Since

2.0

AutoCreateFilters

  • get AutoCreateFilters(): boolean

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

    Returns boolean

    Since

    2.0

  • set AutoCreateFilters(value): void

  • Parameters

    • value: boolean

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Count

  • get Count(): number

  • Gets the number of elements contained in this instance.

    Returns number

    Since

    2.0

DataTableReference

FilteredRows

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

AddNewFilter

  • AddNewFilter(dataColumn): Filter

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

    Since

    2.0

  • AddNewFilter(filterIdentifier, dataColumn): Filter

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

    Since

    2.0

AutoConfigure

Clear

  • Clear(): void

  • Removes all items from this collection.

    Returns void

    Since

    2.0

Contains

  • Contains(column): boolean

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

    Since

    2.0

  • Contains(name): boolean

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

    Since

    2.0

  • Contains(value): boolean

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

    Since

    2.0

GetEnumerator

IndexOf

  • IndexOf(value): number

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

    Since

    2.0

Remove

  • Remove(item): void

  • Removes the specified item.

    Parameters

    Returns void

    Since

    2.0

ResetAllFilters

  • ResetAllFilters(): void

  • Resets all filters.

    Returns void

    Since

    2.0

ToArray

Settings

Member Visibility

On This Page

Methods
Default capability