Namespace:
spotfire.webPlayer
Assembly:
~/GetJavaScriptApi.ashx?Version=14.4
Syntaxspotfire.webPlayer.Application = function(webPlayerServerRootUrl, customizationInfo, analysisPath, parameters, reloadInstances);
Parameters
- webPlayerServerRootUrl
- Type: Systemstring
The URL to the Web Player server (e.g.
'http://myserver.spotfire.com/spotfire/wp/' or '../spotfire/wp/').
- customizationInfo
- Type: spotfire.webPlayerCustomization
Instance of the Customization class.
- analysisPath
- Type: Systemstring
The path in the library to the analysis to open. - parameters
- Type: Systemstring
Optional. Load parameters for the analysis (bookmark names, Information Link parameters, etc.). Example: 'Parameters.Param = {val1, "Val 2"}; SetPage(pageIndex = 1); ApplyBookmark(bookmarkName="All");'. - reloadInstances
- Type: SystemBoolean
Optional. If true, the javascript API will try to reuse server side instances of loaded documents.
RemarksThe JavaScript API can only be used with single-sign-on authentications;
like Anonymous, NTLM and Kerberos. It can also be used for publicly shared analysis files
in Spotfire Cloud.
Version Information
Supported in: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also