Action
    Preparing search index...

    Represents the currently running Spotfire instance. This object can therefore be used to control the running instance, for example open files or replace data.

    If an analysis file (DXP file) has been opened in the application, an object representing that document is available through Spotfire.Dxp.Application.AnalysisApplication.Document.

    New objects of this type cannot be created. Also, the one and only instance of this class is available throughout the entire lifetime of the running instance of the application as a service.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Default capability

    Extended capability 'LibraryRead'

    Extended capability 'LibraryWrite'

    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 T1 | null

    • 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

    • Gets an instance of the requested service type.

      Type Parameters

      • T

      Parameters

      Returns JsType<T> | null

      2.0

    • Saves the current loaded document to its last save location. This is not possible if the loaded document was not an analysis file loaded from a file path or from the library.

      Returns void

      This API expects that the script is declared with 'wrapInTransaction' set to 'false' to work as documented.

      2.0

    Extended capability 'LibraryRead'

    Extended capability 'LibraryWrite'