Click or drag to resize

Document Class

Contains document related functionality. Created by calling openDocument(string, Object, Customization).
The document object can only be used after the Application.onOpenedCallback event has fired.
Inheritance Hierarchy
SystemObject
  spotfire.webPlayerDocument

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

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

The Document type exposes the following members.

Constructors
  NameDescription
Public methodDocument
Top
Properties
  NameDescription
Public propertydata
Reference to the Data object.
Public propertyelementId
The id of the DOM element where this document is shown.
Public propertyfiltering
Reference to the Filtering object.
Public propertyisLoaded
Returns a value indicating whether the document is loaded. When this value is false it is not possible to use any API methods on the document instance.
Public propertyisOpened
Returns a value indicating whether the document is loaded. When this value is false it is not possible to use any API methods on the document instance.
Public propertymarking
Reference to the Marking object.
Top
Methods
  NameDescription
Public methodapplyBookmark
Applies a bookmark by its name. The Application.onError event will be fired if the bookmark does not exist.
Public methodapplyBookmarkById
Applies a bookmark by its id. The Application.onError event will be fired if the bookmark does not exist.
Public methodclose
Close the document. The Application.onClosed event will be raised for the document. Note that there may be other open document instances for the application.
Public methoddownloadAsDxp
Download the analysis as a dxp file.
Public methodexecuteCustomExportTool
Execute a custom export tool.
Public methodexecuteCustomTool
Execute a custom tool.
Public methodexportActiveVisualAsImage
Export the active visual as image. The image will be opened in a new browser tab or window.
Public methodexportReport
Exports the report, specified by name, to PDF.
Public methodexportToPdf
Launch the export to Pdf wizard.
Public methodexportToPowerPoint
Launch the export to PowerPoint wizard.
Public methodgetActivePage
Get the information about the active page.
Public methodgetBookmarkNames
Get the names of the bookmarks in the document.
Public methodgetBookmarks
Get the ids of the bookmarks in the document.
Public methodgetDocumentMetadata
Get the metadata for the document.
Public methodgetDocumentProperties
Get a list of all the properties in the document.
Public methodgetDocumentProperty
Get the information about the property with given name.
Public methodgetPages
Get a list of the pages in the current document.
Public methodgetReports
Get the names of the reports in the analysis.
Public methodlogout
Logout the user.
Public methodonActivePageChanged
Event raised when the active page changes in the analysis.
Public methodonDocumentPropertyChanged
Event raised when the given property has changed value.
Public methodonDocumentReady
Event raised, when the document switches to the ready state (the round icon in the status bar becomes green).
Public methodprint
Launch the print wizard.
Public methodsetActivePage(int)
Change the active page. The Application.onError event will be fired if index does not exist.
Public methodsetActivePage(string)
Change the active page. The Application.onError event will be fired if page title does not exist.
Public methodsetDocumentProperty
Set the value of an existing property.
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