Class AnalysisApplication

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.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

DocumentMetadata ImportContext CreateDataWriter GetService Save

Extended capability 'LibraryRead'

Open

Extended capability 'LibraryWrite'

SaveAs SaveCopy

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

DocumentMetadata

ImportContext

CreateDataWriter

  • CreateDataWriter(typeId): DataWriter

  • Creates the data writer given the typeId.

    Parameters

    • typeId: TypeIdentifier

      The type identifier for the registered data writer.

    Returns DataWriter

    A data writer; returns null if no data writer was found.

    Since

    2.0

GetService

  • GetService<T>(typeT): null | JsType<T>

  • Gets an instance of the requested service type.

    Type Parameters

    • T

    Parameters

    Returns null | JsType<T>

    Since

    2.0

Save

  • Save(): void

  • 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

    Remark

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

    Since

    2.0

Extended capability 'LibraryRead'

Open

  • Open(libraryItem, settings): void

  • Open the specified analysis or information link from the library.

    Parameters

    Returns void

    Since

    2.0

Extended capability 'LibraryWrite'

SaveAs

  • SaveAs(folder, title, metadataSettings, settings): LibraryItem

  • Saves the currently loaded document to the library with the specified title in the specified folder.

    Parameters

    • folder: LibraryItem

      The library folder in which to save the document.

    • title: string | String

      The title of the library item that the document will be saved to.

    • metadataSettings: LibraryItemMetadataSettings

      The metadata to associate with the library item.

    • settings: DocumentSaveSettings

      Controls some aspects of how the document is saved. For instance whether a configuration block is embedded.

    Returns LibraryItem

    Remark

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

    Since

    2.0

SaveCopy

  • SaveCopy(folder, title, metadataSpecification, settings): LibraryItem

  • Saves a copy of the currently loaded document to the library with the specified title in the specified folder.

    Parameters

    • folder: LibraryItem

      The library folder in which to save the document.

    • title: string | String

      The title of the library item that the document will be saved to.

    • metadataSpecification: LibraryItemMetadataSettings

      The metadata to associate with the library item.

    • settings: DocumentSaveSettings

      Controls some aspects of how the document is saved. For instance whether a configuration block is embedded.

    Returns LibraryItem

    Remark

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

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryRead'
Extended capability 'LibraryWrite'