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.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DisplayName Enabled Interactive IsAttached ManualDisplayName Transactions WhereClauseExpression

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

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DisplayName

  • 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

    Since

    2.0

Enabled

  • get Enabled(): boolean

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

    Returns boolean

    Since

    2.0

  • set Enabled(value): void

  • Parameters

    • value: boolean

    Returns void

Interactive

  • 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

    Since

    2.0

  • set Interactive(value): void

  • Parameters

    • value: boolean

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ManualDisplayName

  • 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

    Since

    2.0

  • set ManualDisplayName(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

WhereClauseExpression

  • 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

    Since

    2.0

  • set WhereClauseExpression(value): void

  • Parameters

    • value: string

    Returns void

Settings

Member Visibility

On This Page

Methods
Default capability