Action
    Preparing search index...

    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.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

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

    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

    • get InteractiveSearchPattern(): string

      Gets or sets the search pattern.

      Returns string

      2.0

    • set InteractiveSearchPattern(value: string): void

      Parameters

      • value: string

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Title(): string

      Gets the title of the panel.

      Returns string

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visible(): boolean

      Gets or sets whether the panel is visible.

      Returns boolean

      When the panel state is popover, this property is disregarded.

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

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

      Parameters

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability