Class VisualCollection

A collection of Spotfire.Dxp.Application.Visual objects.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Context Count IsAttached Transactions AddDuplicate AddNew Contains Remove TryGetVisual

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]

  • [iterator](): Iterator<Visual, any, undefined>

  • Returns Iterator<Visual, any, undefined>

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

Count

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

AddDuplicate

AddNew

  • AddNew<T>(typeT): JsType<T>

  • Adds a new visual of the specified type.

    Type Parameters

    Parameters

    Returns JsType<T>

    The newly created content.

    Since

    2.0

  • AddNew(visualTypeId): Visual

  • Creates a new Spotfire.Dxp.Application.Visual with a visual of the type identified by visualTypeId and adds it to the collection.

    Parameters

    Returns Visual

    The newly created Spotfire.Dxp.Application.Visual.

    Example

    The following example snippet shows how to add a bar chart to a visual collection.

    let visual = page.Visuals.AddNew(Spotfire.Dxp.Application.Visuals.VisualTypeIdentifiers.BarChart);
    let barchart = visual.As<Spotfire.Dxp.Application.Visuals.BarChart>();

    Since

    2.0

Contains

  • Contains(visual): boolean

  • Determines whether the visual is in the collection.

    Parameters

    Returns boolean

    true if the visual is in the collection; otherwise, false.

    Since

    2.0

Remove

TryGetVisual

  • TryGetVisual(id, visual): boolean

  • Tries to get a visual specified by its id.

    Parameters

    Returns boolean

    true if the visual was found, otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability