Spotfire.Dxp.Application Namespace

TIBCO Spotfire 10.0 API Reference
The Spotfire.Dxp.Application namespace contains classes for basic configuration of an analysis.

The AnalysisApplication holds a reference to the Document.

From the document filters, data and visuals are reached in the related namespaces:

Classes

  ClassDescription
Public classAnalysisApplication
Represents the currently running TIBCO 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 Document.

Public classAnalysisApplicationExitingEventArgs
Used as argument to the Exiting event.
Public classBookmark
Represents a captured bookmark state.
Public classBookmarkPropertyNames
The property names for Bookmark.
Public classBookmarkCollection
A collection container for bookmarks.
Public classBookmarkCollectionPropertyNames
The property names for BookmarkCollection.
Public classCustomNodes
Represents a collection of custom nodes.
Public classDetailsOnDemandPanel
Represents the panel where the details-on-demand table is displayed.
Public classDetailsOnDemandPanelPropertyNames
Contains property name constants for the public properties of DetailsOnDemandPanel.
Public classDocument
A document opened in a running instance of TIBCO Spotfire is referred to as an Analysis Document. The document not only contains a series of metadata information (see DocumentMetadata), but it also contains references to the data itself (see 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 TIBCO Spotfire, an instance of this class can be accessed through the Document property of the 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 TIBCO 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 AutoConfigure method must be made.

Public classDocumentPropertyNames
Contains property name constants for the public properties of Document.
Public classDocumentChangedEventArgs
Used as argument to the DocumentChanged event.
Public classDocumentMetadata
Provides access to metadata for the currently opened Document.
Public classDocumentOpenSettings
Provides settings and information used while a document is opened.
Public classDocumentProperties
Provides access to the document properties in the document.
Public classDocumentPropertiesDefaultProperties
Contains predefined name constants for the default document properties.
Public classDocumentPropertiesPropertyNames
Contains property name constants for the public properties of DocumentProperties.
Public classDocumentSaveSettings
The DocumentSaveSettings class provides settings and information used when a document is saved.
Public classHttpContent
Represents content that can be served by a web server via HTTP.
Public classImageCollection
Represents a collection of images stored in the document.
Public classImageCollectionPropertyNames
Contains property name constants for the public properties of ImageCollection.
Public classMenuCategory
Describes what menu category a Tool belongs to.
Public classPage
A page contains visuals and panels.
Public classPagePropertyNames
Contains property name constants for the public properties of Page.
Public classPageCollection
A collection of visual pages in an analysis document. Note that new instances of this class cannot be created. The one and only instance is accessed through the Pages property of the Document class.

The instance of this class can be used directly either to enumerate or to modify the visual pages in the document, that is, add new pages, remove pages, move pages, etc.

Public classPageCollectionPropertyNames
Contains property name constants for the public properties of PageCollection.
Public classPanel
Base class for panels placed at the sides or at the bottom of the application.
Public classPanelPropertyNames
Contains property name constants for the public properties of Panel.
Public classPanelCollection
A collection of Panels.
Public classPanelCollectionPropertyNames
Contains property name constants for the public properties of PanelCollection.
Public classPanelTypeIdentifiers
Defines the type identifiers for built-in panels.
Public classShareToolTContext
This is the base class for creating share tools. It provides the ability to perform asynchronous prompting.
Public classShareToolExecutionContext
Represents a share tool execution context. This is a marker class for share tools.
Public classStyleElement
Represents a stylable element in the user interface.
Public classTagPanel
The Panel for the Tag Panel.
Public classTool
This is the base class for tools, that is, functionality available through the tools menu and on various context menus. A tool can be launched by calling its Execute(TContext) method. The ContextType property determines the type of context object the tool expects in the Execute(TContext) method call. For example, a tool with a ContextType of Page would expect a page (typically the ActivePageReference) to be passed to it.

Tools can belong to different categories. The category might affect where the tool is rendered in the TIBCO Spotfire user interface. However, the category and the context of a tool are not interconnected. That is, two different tools may share the same context but have different categories.

Tools are accessed via the Toolbox.

Public classToolTContext
Public classToolbox
Contains the tools available to the application.
Public classVisual
This class represents either a visualization or a text area.
Public classVisualPropertyNames
Contains property name constants for the public properties of Visual.
Public classVisualCollection
A collection of Visual objects.
Public classVisualCollectionPropertyNames
Contains property name constants for the public properties of VisualCollection.
Enumerations

  EnumerationDescription
Public enumerationBookmarkComponentFlags
Specifies the components to use when capturing a bookmark.
Public enumerationPageNavigationMode
Used to specify the current navigation mode.
Public enumerationToolCategory Obsolete.
Describes what category a Tool belongs to.