Click or drag to resize

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 Hierarchy
SystemObject
  spotfire.webPlayerApplication

Namespace:  spotfire.webPlayer
Assembly:  ~/GetJavaScriptApi.ashx?Version=10.0
Syntax
JavaScript
spotfire.webPlayer.Application = function();

Type.createClass(
	'spotfire.webPlayer.Application');

The Application type exposes the following members.

Constructors
  NameDescription
Public methodApplication(string, Customization)
Initializes a new instance of class Application.
Public methodApplication(string, Customization, string, string, Boolean)
Initializes a new instance of class Application.
Top
Properties
  NameDescription
Public propertyanalysisDocument
Reference to the first Document object loaded. This property will be null if no document is loaded.
Public propertyanalysisDocuments
Array with all opened instances of Document.
Top
Methods
  NameDescription
Public methodclose
Close all open documents opened by the application. The Application.onClosed event will be raised once per document.
Public methodlogout
Logout the user.
Public methodonClosed
Event raised when the analysis has closed.
Public methodonError
Event raised when an error occurs in the analysis or API.
Public methodonLoggedOut
Event raised when the user is logged out. This can be due to an explicit logout request or a session timeout.
Public methodonOpened
Event raised when a document has finished loading.
Public methodopen
Open a given analysis. The Application.onOpened event will fire when the document is loaded. Note, only one document can be opened at a time by an application.
Public methodopenDocument
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.
Top
Version Information

Supported in: 10.0, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.0
See Also