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.

Namespace: spotfire.webPlayer
Assembly: ~/GetJavaScriptApi.ashx?Version=5.0

Syntax

JavaScript
function open(analysisPath, divId, parameters);

Parameters

analysisPath
Type: string
The path in the library to the analysis to open.
divId
Type: string
The id of the DIV element in which to display the Web Player. The Web Player will adapt to the size of the surrounding DIV.
parameters
Type: string
Load parameters for the analysis (bookmark names, Information Link parameters, etc.). Example: 'Parameters.Param = {val1, "Val 2"}; SetPage(pageIndex = 1); ApplyBookmark(bookmarkName="All");'. For more information see: Parameter Configuration Block.

Version Information

Supported in: 6.0, 5.5, 5.0, 4.0, 3.2, 1.0

See Also