Application Class |
The Application class is used to create a Web Player instance.
It is also used to create document instances and connect to global events.
If an analysis is opened, the Document object is also accessible
from the application.
Inheritance HierarchySystemObject
spotfire.webPlayerApplication
spotfire.webPlayerApplication
Namespace: spotfire.webPlayer
Assembly: ~/GetJavaScriptApi.ashx?Version=10.10
SyntaxJavaScript
spotfire.webPlayer.Application = function(); Type.createClass( 'spotfire.webPlayer.Application');
The Application type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Application | Initializes a new instance of class Application. |
Properties| Name | Description | |
|---|---|---|
 | analysisDocument | Reference to the first Document object loaded. This property will
be null if no document is loaded. |
| analysisDocuments | Array with all opened instances of Document. |
Methods| Name | Description | |
|---|---|---|
| close | Close all open documents opened by the application. The Application.onClosed
event will be raised once per document. |
| logout |
Logout the user.
|
| onClosed | Event raised when the analysis has closed. |
| onError | Event raised when an error occurs in the analysis or API. |
| onLoggedOut | Event raised when the user is logged out. This can be due to an explicit logout request or a session timeout. |
| onOpened | Event raised when a document has finished loading. |
| openDocument | Open an analysis document instance specified by the application.
The Application.onOpened event will fire when the document is loaded.
Multiple documents can be opened for a single application. When several documents are created for an application
these documents will automatically be linked together. |
Version InformationSupported in: 10.10, 10.9, 10.8, 10.7, 10.6, 10.5, 10.4, 10.3, 10.2, 10.1, 10.0, 7.14, 7.13, 7.12, 7.11
See Also