TIBCO Spotfire Web Player JavaScript API.

Classes

	Class	Description
	Application	The Application class is used to create a Web Player instance. It is also used to create the document and connect to global events. If an analysis is opened, the Document object is also accessible from the application.
	Customization	Customize the appearance of the Web Player. All have default value true, except panels that have null.
	Data	Contains data related functionality. This object is created when the document is loaded. The object can be accessed in Document.data.
	DataColumn	Holds information about a data column in the document. To get the information use the column functions in DataTable object.
	DataTable	Holds information about a data table in the document. To get the information use the data object.
	Document	Contains document related functionality. Created by the application when the analysis is loaded. The document object can only be used after the Application.onOpenedCallback event has fired.
	DocumentMetadata	Contains the metadata of a document.
	Filter	Contains filtering related functionality. This object is created when the document is loaded.
	FilterColumn	Holds information about a filter column. To get an instance of this object use the get filter column function in FilteringScheme or Filtering.
	Filtering	Contains filtering related functionality. This object is created when the document is loaded. To get an instance of this object use the Document.filtering property.
	FilteringScheme	Contains filtering scheme related funtionallity and data. To get an instance of this object use the get filtering scheme function in Filtering.
	Marking	Contains marking related functionality. This object is created when the analysis document is loaded. To get an instance of this object use the Document.marking property.
	Property	The class holds information about a property. This can be document properties, table properties or column properties.

Structures

	Structure	Description
	DataColumnRangeState	The state of a data data column, after a filtering has occurred.
	FilterSettings	Used to get and set values and settings on filter columns.
	PageState	Information about a page in the analysis.

Functions

	Function	Description
	Application.onClosedCallback	Callback which is called when an analysis document has closed.
	Application.onErrorCallback	Callback called when an error occurs using the JavaScript API.
	Application.onOpenedCallback	Callback which is called when the opening of an analysis is complete.
	Data.onGetDataTableCallback	Callback called when a data table object is retrieved.
	Data.onGetDataTablesCallback	Callback called when a list of data tables is retrieved.
	Data.onRangeChangedCallback	Callback called when the filtered range of a data data column changes.
	DataTable.onGetDataColumnCallback	Callback called when a data column object is retrieved.
	DataTable.onGetDataColumnsCallback	Callback called when the list of data columns in a data table is retrieved.
	Document.onDocumentReadyCallback	Callback called when the opened analysis goes into "Ready" state. This is when the green circle in the status bar turns green.
	Document.onGetBookmarkNamesCallback	Callback called names of the bookmarks in the document are retrieved.
	Document.onGetBookmarksCallback	Callback called ids of the bookmarks in the document are retrieved.
	Document.onGetDocumentMetadataCallback	Callback to get the metadata of the document.
	Document.onGetPageCallback	Callback called when the active page changes in an opened analysis or when information about a page is retrieved.
	Document.onGetPagesCallback	Callback called when the list of pages in the document is retrieved.
	Filtering.onGetFilteringSchemeCallback	Callback called when a single filtering scheme is retrieved.
	Filtering.onGetFilteringSchemesCallback	Callback called when list of filtering schemes is retrieved.
	Marking.onGetMarkingNames	Callback called when the list of marking names is retrieved.
	Marking.onMarkingCallback	Callback called when a marking table is retrieved.
	onActivePageChangedCallback	Callback called when the active page in an opened analysis changes.
	onClosedCallback	Callback which is called when an analysis document has closed.
	onDocumentReadyCallback	Callback called when the opened analysis goes into "Ready" state. This is when the green circle in the statusbar turns green.
	onErrorCallback	Callback called when an error occurs using the JavaScript API.
	onGetFilterColumnCallback	Callback called when a filter columns is retrieved.
	onGetFilterColumnsCallback	Callback called when a list of filter columns is retrieved.
	onGetPropertiesCallback	Callback called when the a list of properties is retrieved.
	onGetPropertyCallback	Callback called when the property is retrieved.
	onMarkingChangedCallback	Callback called when a marking change occurs.
	onOpenedCallback	Callback which is called when the opening of an analysis is complete.
	onRangeChangedCallback	Callback called when the filtered range of a data column changes.

Enumerations

	Enumeration	Description
	columnDataType	The different data column types.
	errorCodes	Error code definitions. Used as argument to the Application.onError event.
	filteringOperation	Filtering operation definitions. Used as argument to define how a set filter operation should be applied.
	filterType	The filter types of a filter column.
	includedFilterSettings	This enumerator is used to specify how filter values should be retrieved if the get filter column functions of Filtering and FilteringScheme objects. Remarks For filter types other than the check box hierarchy filter, any of the last two values can be used to get the value(s) of the filter. Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data.
	markingOperation	Marking operation definitions. Used as argument to the Marking.setMarking function.

Classes

Structures

Functions

Enumerations

Remarks