The AnalysisApplication holds a reference to the Document.
From the document filters, data and visuals are reached in the related namespaces:
Class | Description | |
---|---|---|
AnalysisApplication |
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. |
|
AnalysisApplicationExitingEventArgs |
Used as argument to the Exiting event.
|
|
Bookmark |
Represents a captured bookmark state.
|
|
Bookmark PropertyNames |
The property names for Bookmark.
|
|
BookmarkCollection |
A collection container for bookmarks.
|
|
BookmarkCollection PropertyNames |
The property names for BookmarkCollection.
|
|
BookmarkPanel |
The Panel for the Bookmark Panel.
|
|
CustomNodes |
Represents a collection of custom nodes.
|
|
DetailsOnDemandPanel |
Represents the panel where the details-on-demand table is displayed.
|
|
DetailsOnDemandPanel PropertyNames |
Contains property name constants for the public properties of DetailsOnDemandPanel.
|
|
Document |
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. |
|
Document PropertyNames |
Contains property name constants for the public properties of Document.
|
|
DocumentChangedEventArgs |
Used as argument to the DocumentChanged event.
|
|
DocumentMetadata |
Provides access to metadata for the currently opened Document.
|
|
DocumentOpenSettings |
Provides settings and information used while a
document is opened.
|
|
DocumentProperties |
Provides access to the document properties in the document.
|
|
DocumentProperties DefaultProperties |
Contains predefined name constants for the default document properties.
|
|
DocumentProperties PropertyNames |
Contains property name constants for the public properties of DocumentProperties.
|
|
DocumentSaveSettings |
The DocumentSaveSettings class provides settings and information used when a
document is saved.
|
|
ImageCollection |
Represents a collection of images stored in the document.
|
|
ImageCollection PropertyNames |
Contains property name constants for the public properties of ImageCollection.
|
|
MenuCategory |
Describes what menu category a Tool belongs to.
|
|
Page | ||
Page PropertyNames |
Contains property name constants for the public properties of Page.
|
|
PageCollection |
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. |
|
PageCollection PropertyNames |
Contains property name constants for the public properties of PageCollection.
|
|
Panel |
Base class for panels placed at the sides or at the bottom of the application.
|
|
Panel PropertyNames |
Contains property name constants for the public properties of Panel.
|
|
PanelCollection |
A collection of Panels.
|
|
PanelCollection PropertyNames |
Contains property name constants for the public properties of PanelCollection.
|
|
PanelTypeIdentifiers |
Defines the type identifiers for
built-in panels.
|
|
ShareTool TContext |
This is the base class for creating share tools. It provides the ability
to perform asynchronous prompting.
|
|
ShareToolExecutionContext |
Represents a share tool execution context. This is a marker class for share tools.
|
|
TagPanel |
The Panel for the Tag Panel.
|
|
Tool |
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. |
|
Tool TContext |
This is a generic base class for tools.
This class cannot be extended directly, instead refer to CustomTool TContext ,
|
|
Toolbox |
Contains the tools available to the application.
|
|
Visual |
This class represents either a visualization or a text area.
|
|
Visual PropertyNames |
Contains property name constants for the public properties of Visual.
|
|
VisualCollection |
A collection of Visual objects.
|
|
VisualCollection PropertyNames |
Contains property name constants for the public properties of VisualCollection.
|
Enumeration | Description | |
---|---|---|
BookmarkComponentFlags |
Specifies the components to use when capturing
a bookmark.
|
|
PageNavigationMode |
Used to specify the current navigation mode.
|
|
ToolCategory |
Obsolete.
Describes what category a Tool belongs to.
|