Class FilterPanel

A Filter Panel represents the contents of the Spotfire control panel that can contain the data filters.

Each Filter Panel contains one or more filter in which the filters are placed. These groups and the filters in them are accessible through the Spotfire.Dxp.Application.Filters.FilterPanel.TableGroups property.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DockingPlacement FilteringSchemeReference FiltersMatchingSearchPattern InteractiveSearchPattern IsAttached PanelState TableGroups Title Transactions TypeId Visible ApplyOrganizationFrom AutoConfigure

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

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

Context

DockingPlacement

  • get DockingPlacement(): DockingPlacement

  • Gets or sets the docking placement of the panel.

    Returns DockingPlacement

    Since

    2.0

  • set DockingPlacement(value): void

  • Parameters

    Returns void

FilteringSchemeReference

  • get FilteringSchemeReference(): null | FilteringScheme

  • Gets or sets the FilteringScheme to use.

    Returns null | FilteringScheme

    Since

    2.0

  • set FilteringSchemeReference(value): void

  • Parameters

    Returns void

FiltersMatchingSearchPattern

InteractiveSearchPattern

  • get InteractiveSearchPattern(): string

  • Gets or sets the search pattern.

    Returns string

    Since

    2.0

  • set InteractiveSearchPattern(value): void

  • Parameters

    • value: string

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

PanelState

TableGroups

Title

  • get Title(): string

  • Gets the title of the panel.

    Returns string

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TypeId

Visible

  • get Visible(): boolean

  • Gets or sets whether the panel is visible.

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

ApplyOrganizationFrom

  • ApplyOrganizationFrom(sourcePanel): void

  • Applies the filter organization, that is, visibility, selected state, groups and sort order from another filter panel to this instance.

    Parameters

    Returns void

    Since

    2.0

AutoConfigure

  • AutoConfigure(): void

  • Configures this filter panel with a default Spotfire.Dxp.Application.Filters.FilteringScheme.

    Returns void

    Since

    2.0

  • AutoConfigure(sourcePanel): void

  • Configures this filter panel from the specified source filter panel.

    Parameters

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability