Action
    Preparing search index...

    Class WhereClauseVisualizationSubset

    Represents a subset defined by a where clause (a boolean expression). This class is instantiated by the AddWhereClauseExpression method on Spotfire.Dxp.Application.Visuals.VisualizationSubsetCollection.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context DisplayName Enabled Interactive IsAttached ManualDisplayName Transactions WhereClauseExpression ForEachNodeInSubTree

    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 Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DisplayName(): string

      Gets the display name. If ManualDisplayName is not null or empty, it is returned. Otherwise an automatically generated name is returned.

      Returns string

      2.0

    • get Enabled(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.VisualizationSubset is enabled.

      Returns boolean

      2.0

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Interactive(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.VisualizationSubset is interactive. That is, if is should participate in marking and highlighting operations.

      Returns boolean

      2.0

    • set Interactive(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get ManualDisplayName(): string

      Gets or sets the manual display name. If this property is not null or an empty string, it will be used as the value for the DisplayName property.

      Returns string

      2.0

    • set ManualDisplayName(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get WhereClauseExpression(): string

      Gets or sets the where clause (a boolean expression) that limits the data shown by the visualization, or null. Setting the expression to the empty string will set it to null.

      Returns string

      2.0

    • set WhereClauseExpression(value: string): void

      Parameters

      • value: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability