Click or drag to resize

spotfire.webPlayer Namespace

TIBCO Spotfire Web Player JavaScript API.
Classes
  ClassDescription
Public classApplication
The Application class is used to create a Web Player instance. It is also used to create document instances and connect to global events. If an analysis is opened, the Document object is also accessible from the application.
Public classCustomization
Customize the appearance of the Web Player.
All have default value true, except panels that have null.
Public classData
Contains data related functionality. This object is created when the document is loaded.
The object can be accessed in Document.data.
Public classDataColumn
Holds information about a data column in the document. To get the information use the column functions in DataTable object.
Public classDataTable
Holds information about a data table in the document. To get the information use the data object.
Public classDistinctValues
The distinct values.
Public classDocument
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.
Public classDocumentMetadata
Contains the metadata of a document.
Public classFilterColumn
Holds information about a filter column. To get an instance of this object use the get filter column function in FilteringScheme or Filtering.
Public classFiltering
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.
Public classFilteringScheme
Contains filtering scheme related funtionallity and data.
To get an instance of this object use the get filtering scheme function in Filtering.
Public classMarking
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.
Public classProperty
The class holds information about a property. This can be document properties, table properties or column properties.
Structures
  StructureDescription
Public structureDataColumnRangeState
The state of a data data column, after a filtering has occurred.
Public structureFilterSettings
Used to get and set values and settings on filter columns.
Public structurePageState
Information about a page in the analysis.
Functions
  FunctionDescription
Public functionApplicationonClosedCallback
Callback which is called when an analysis document has closed.
Public functionApplicationonErrorCallback
Callback called when an error occurs using the JavaScript API.
Public functionApplicationonLoggedOutCallback
Callback called when the user is logged out.
Public functionApplicationonOpenedCallback
Callback which is called when the opening of an analysis is complete.
Public functioncreateApplication
Initializes a new instance of class Application. This method will prompt the user with a login dialog if needed.
Public functionDataonGetDataTableCallback
Callback called when a data table object is retrieved.
Public functionDataonGetDataTablesCallback
Callback called when a list of data tables is retrieved.
Public functionDataonRangeChangedCallback
Callback called when the filtered range of a data data column changes.
Public functionDataTableonGetDataColumnCallback
Callback called when a data column object is retrieved.
Public functionDataTableonGetDataColumnsCallback
Callback called when the list of data columns in a data table is retrieved.
Public functionDocumentonDocumentReadyCallback
Callback called when the opened analysis goes into "Ready" state. This is when the green circle in the status bar turns green.
Public functionDocumentonGetBookmarkNamesCallback
Callback called when the names of the bookmarks in the document are retrieved.
Public functionDocumentonGetBookmarksCallback
Callback called when the ids of the bookmarks in the document are retrieved.
Public functionDocumentonGetDocumentMetadataCallback
Callback to get the metadata of the document.
Public functionDocumentonGetPageCallback
Callback called when the active page changes in an opened analysis or when information about a page is retrieved.
Public functionDocumentonGetPagesCallback
Callback called when the list of pages in the document is retrieved.
Public functionDocumentonGetReportsCallback
Callback called when the names of the reports in the document are retrieved.
Public functionFilteringonGetFilteringSchemeCallback
Callback called when a single filtering scheme is retrieved.
Public functionFilteringonGetFilteringSchemesCallback
Callback called when list of filtering schemes is retrieved.
Public functionMarkingonGetMarkingNames
Callback called when the list of marking names is retrieved.
Public functionMarkingonMarkingCallback
Callback called when a marking table is retrieved.
Public functiononApplicationLoadedCallback
Callback which is called when the specified Application and API version is loaded.
Public functiononCreateLoginElementCallback
Callback which is called when a login dialog is needed to be shown. Return a clickable DOM element for launching the login window.
Public functiononGetDistinctValuesCallback
Callback called when the a list of distinct values is retrieved.
Public functiononGetFilterColumnCallback
Callback called when a filter columns is retrieved.
Public functiononGetFilterColumnsCallback
Callback called when a list of filter columns is retrieved.
Public functiononGetPropertiesCallback
Callback called when the a list of properties is retrieved.
Public functiononGetPropertyCallback
Callback called when the property is retrieved.
Enumerations
  EnumerationDescription
Public enumerationcolumnDataType
The different data column types.
Public enumerationerrorCodes
Error code definitions. Used as argument to the Application.onError event.
Public enumerationfilteringOperation
Filtering operation definitions.
Used as argument to define how a set filter operation should be applied.
Public enumerationfilterType
The filter types of a filter column.
Public enumerationincludedFilterSettings
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.
Checkbox hierarchy filters that loads data on request will return an empty list.
Public enumerationmarkingOperation
Marking operation definitions. Used as argument to the Marking.setMarking function.