A document opened in a running instance of Spotfire is referred to as an Analysis Document. The document not only contains a series of metadata information (see Spotfire.Dxp.Application.DocumentMetadata), but it also contains references to the data itself (see Spotfire.Dxp.Data.DataManager), and to various other components being part of the document, such as pages, filterings, bookmarks, etc.

As soon as data has been opened in Spotfire, an instance of this class can be accessed through the Spotfire.Dxp.Application.AnalysisApplication.Document property of the Spotfire.Dxp.Application.AnalysisApplication. This is regardless of whether the data was opened through the user interface or programmatically. Hence, new instances of this class cannot be created through calls to the constructor.

When a document is opened in Spotfire using the user interface, the document will be automatically configured to be ready for use. This includes creation of a new page and adding a default visualization to that page. When opening a document through the API, however, it is empty. To achieve the same result as opening the document through the user interface, a call to the Spotfire.Dxp.Application.Document.AutoConfigure method must be made.

2.0

Hierarchy (view full)

Implements

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 ActiveFilteringSelectionReference(): null | DataFilteringSelection
  • Gets the active filter. That is, the active filtering of the active page if there is any. May return null.

    Returns null | DataFilteringSelection

    2.0

  • get ActivePageReference(): null | Page
  • Gets or sets the currently active Spotfire.Dxp.Application.Page.

    Note: This property can return null, but cannot be set to null.

    Returns null | Page

    2.0

  • set ActivePageReference(value): void
  • Parameters

    Returns void

  • get Context(): INodeContext
  • Gets the context of this node.

    Returns INodeContext

    2.0

  • get CustomNodes(): CustomNodes
  • Gets the collection of custom nodes associated with this document.

    Returns CustomNodes

    2.0

  • get Data(): DataManager
  • Gets the Data Manager, which can be used to access the data contained in this document.

    Returns DataManager

    2.0

  • get IsAttached(): boolean
  • Gets a value indicating whether this node is attached.

    Returns boolean

    2.0

  • get Transactions(): ITransactions
  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    2.0

  • get UseLightTooltips(): boolean
  • Gets or sets a value controlling if tooltips are rendered using dark text on a light background (as in pre 4.0 versions), or light text on dark background.

    Returns boolean

    2.0

  • set UseLightTooltips(value): void
  • Parameters

    • value: boolean

    Returns void

  • Applies the current user's preferences to a newly created document.

    Returns void

    2.0

  • Configures a newly created document with reasonable default values such as an initial page with a visualization on it and a filter panel containing default filters for all columns and hierarchies.

    Returns void

    2.0

  • Gets the style properties for an element in the user interface.

    Parameters

    Returns StyleProperties

    An object with properties describing the style of the element.

    2.0

  • Tries to get the Spotfire.Dxp.Application.Export.Report specified by name.

    Parameters

    • reportName: string | String

      The name of the report.

    • report: OutParam<Report>

      The report, or null if not found.

    Returns boolean

    True if the report specified by name was found; otherwise False.

    2.0