Click or drag to resize

ApplicationopenDocument Method

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.

Namespace:  spotfire.webPlayer
Assembly:  ~/GetJavaScriptApi.ashx?Version=10.0
Syntax
JavaScript
function openDocument(elementId, initialPage, customizationInfo);

Parameters

elementId
Type: Systemstring
The id of the DOM element in which to display the Web Player. The Web Player will adapt to the size of this element.
initialPage
Type: SystemObject
Optional. Specifies the initial page when opening the analysis. Either page index (integer, zero based) or page title (string) can be used. If not set, the active page of the saved analysis will be used. This value will override the parameters used when creating the application.
customizationInfo
Type: spotfire.webPlayerCustomization
Optional. Instance of the spotfire.webPlayer.Customization class. When set it will override customization set on the application.

Return Value

Type: Document
An instance of the Document. The API methods on the document can not be used until the onOpened event is fired for this instance.
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
See Also