Class FilteringScheme

A FilteringScheme contains Spotfire.Dxp.Application.Filters separated in Spotfire.Dxp.Application.Filters.FilterCollections for each Spotfire.Dxp.Data.DataTable in the Spotfire.Dxp.Application.Document.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item AutoConfigureFilterCollections Context Count DefaultFilterCollection FilteringSelectionReference IsAttached Transactions Add AddRange AutoConfigure Clear Contains GetEnumerator IndexOf Insert InsertRange Move Remove RemoveAt RemoveRange ReplaceAll 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<DataTable, FilterCollection> & PropertyGet<number | Int32, FilterCollection> & PropertySet<number | Int32, FilterCollection>

Gets or sets 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

AutoConfigureFilterCollections

  • get AutoConfigureFilterCollections(): boolean

  • Gets or sets a value indicating whether to auto configure filter collections.

    Returns boolean

    Since

    2.0

  • set AutoConfigureFilterCollections(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

DefaultFilterCollection

FilteringSelectionReference

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

Add

AddRange

  • AddRange(collection): void

  • Adds the elements of the specified collection to the end of this collection.

    Parameters

    Returns void

    Since

    2.0

AutoConfigure

Clear

  • Clear(): void

  • Removes all items from this collection.

    Returns void

    Since

    2.0

Contains

  • Contains(value): boolean

  • Determines whether the specified value is in this collection.

    Parameters

    • value: FilterCollection

      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

    Returns number

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

    Since

    2.0

Insert

  • Insert(index, item): void

  • Inserts an element into this collection at the specified index.

    Parameters

    • index: number | Int32

      The zero-based index at which item should be inserted.

    • item: FilterCollection

      The object to insert. The value can be null.

    Returns void

    Since

    2.0

InsertRange

  • InsertRange(index, collection): void

  • Inserts the elements of the specified collection at the specified index in this collection.

    Parameters

    • index: number | Int32

      The index where the first element shall be inserted.

    • collection: OrExplicit<System.Collections.Generic.IEnumerable<FilterCollection>>

      The collection whose elements should be inserted in this collection. The collection itself cannot be null, but it can contain elements that are null, if type T is a reference type.

    Returns void

    Since

    2.0

Move

  • Move(fromIndex, toIndex): void

  • Moves the item at the specified index to a new location in the collection.

    Parameters

    • fromIndex: number | Int32

      The zero-based index specifying the location of the item to be moved.

    • toIndex: number | Int32

      The zero-based index specifying the new location of the item.

    Returns void

    Since

    2.0

Remove

  • Remove(item): boolean

  • Removes the first occurrence of a specific object from this collection.

    Parameters

    Returns boolean

    true if item was successfully removed from this collection; otherwise, false. This method also returns false if item is not found.

    Since

    2.0

RemoveAt

  • RemoveAt(index): void

  • Removes the element at the specified index.

    Parameters

    • index: number | Int32

      The zero-based index of the element to remove.

    Returns void

    Since

    2.0

RemoveRange

  • RemoveRange(index, count): void

  • Removes a range of count elements starting at the specified index.

    Parameters

    • index: number | Int32

      The index of the first element to remove.

    • count: number | Int32

      The number of elements to remove.

    Returns void

    Since

    2.0

ReplaceAll

ResetAllFilters

ToArray

Settings

Member Visibility

On This Page

Methods
Default capability