Spotfire Web Player JavaScript API

https://docs.tibco.com/pub/sfire_dev/area/doc/api/
Admin
The Spotfire Web Player JavaScript API enables developers to embed Spotfire visualizations and...
Tokens:24,402
Snippets:194
Trust Score:9.5
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic JavaScript API Mashup Example

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/index.html

A sample JavaScript code snippet demonstrating the essential steps to open a Spotfire analysis using the web mashup API. This includes authentication, connecting to the API, and opening the document in a specified HTML element.

```javascript
const settings = {
    // Authentication settings
    authentication: {
        // ... authentication options ...
    },
    // Connection settings
    connect: {
        // ... connection options ...
    }
};

spotfire.webPlayer.authenticate(settings.authentication)
    .then(() => {
        return spotfire.webPlayer.connect(settings.connect);
    })
    .then((app) => {
        return app.openDocument("myAnalysis.spk", "myElementId");
    })
    .then((doc) => {
        console.log("Document opened successfully:", doc);
        // ... further document manipulation ...
    })
    .catch((error) => {
        console.error("Error opening document:", error);
    });

```

--------------------------------

### Get Pages

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves all pages within the opened analysis.

```APIDOC
## GET /api/pages

### Description
Gets all pages in the opened analysis.

### Method
GET

### Endpoint
/api/pages

### Parameters
#### Query Parameters
- **callback** (OnGetPages) - Required - The callback function.

### Response
#### Success Response (200)
- **pages** (array) - An array of page objects.

#### Response Example
```json
{
  "pages": [
    {
      "title": "Page 1",
      "index": 0
    },
    {
      "title": "Page 2",
      "index": 1
    }
  ]
}
```
```

--------------------------------

### Get Bookmarks

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves all bookmarks defined within the document.

```APIDOC
## GET /api/bookmarks

### Description
Get the bookmarks in the document.

### Method
GET

### Endpoint
/api/bookmarks

### Parameters
#### Query Parameters
- **callback** (OnGetBookmarks) - Required - The callback function.

### Response
#### Success Response (200)
- **bookmarks** (array) - An array of bookmark objects.

#### Response Example
```json
{
  "bookmarks": [
    {
      "name": "Bookmark 1",
      "description": "Details about bookmark 1"
    }
  ]
}
```
```

--------------------------------

### Type Alias OnGetProperty

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetProperty.html

Callback called when returning a get property function. It takes a Property object as an argument and returns void.

```APIDOC
## Type Alias OnGetProperty

### Description
Callback called when returning a get property function.

### Type Declaration
`OnGetProperty: (property: Property) => void`

### Parameters
* **property** (Property) - The property.

### Returns
void
```

--------------------------------

### Get Bookmark Names

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves the names of all bookmarks available in the document.

```APIDOC
## GET /api/bookmarks/names

### Description
Get the names of the bookmarks in the document.

### Method
GET

### Endpoint
/api/bookmarks/names

### Parameters
#### Query Parameters
- **callback** (OnGetBookmarkNames) - Required - The callback function.

### Response
#### Success Response (200)
- **bookmarkNames** (array) - An array of bookmark names.

#### Response Example
```json
{
  "bookmarkNames": ["Bookmark 1", "Bookmark 2"]
}
```
```

--------------------------------

### FilterSettings Class

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/classes/spotfire.webPlayer.FilterSettings.html

Provides methods to get and set values and settings on filter columns within the Spotfire Web Player.

```APIDOC
## Class FilterSettings

Used to get and set values and settings on filter columns.

### Constructors

#### constructor

`new FilterSettings(): FilterSettings`

**Returns:** `FilterSettings`

### Properties

#### hierarchyPaths

`hierarchyPaths: string[][] | null`

The paths of the checked or unchecked, depending on the selected includedFilterSettings, nodes in a CheckBox Hierarchy Filter. The property contains an array of path elements, one for each selected value. The list will only contain the top most element of the selected nodes. If a node contains only selected children, only that (top) node is returned, not the children.

#### highValue

`highValue: string | null`

The high value of a Range Filter.

#### includeEmpty

`includeEmpty: boolean | null`

Specifies if empty values should be included in the filtering.

#### lowValue

`lowValue: string | null`

The low value of a Range Filter.

#### searchPattern

`searchPattern: string | null`

Specifies search pattern for Text Filters and ListBox Filters.

#### values

`values: string[]`

The values of a filter column.

*   Item Filters
*   CheckBox Filters
*   RadioButton Filter
*   ListBox Filters When used with Item Filters and RadioButton Filters; only the first index in the array is used.
```

--------------------------------

### Get Document Properties

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves a list of all properties defined for the document.

```APIDOC
## GET /api/document/properties

### Description
Get a list of all the properties in the document.

### Method
GET

### Endpoint
/api/document/properties

### Parameters
#### Query Parameters
- **callback** (OnGetProperties) - Required - The callback function.

### Response
#### Success Response (200)
- **properties** (array) - An array of property names.

#### Response Example
```json
{
  "properties": ["Property A", "Property B"]
}
```
```

--------------------------------

### Get Document State

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves the current state of the document.

```APIDOC
## GET /api/document/state

### Description
Get the current document state.

### Method
GET

### Endpoint
/api/document/state

### Parameters
#### Query Parameters
- **callback** (OnGetDocumentState) - Required - The callback function.

### Response
#### Success Response (200)
- **documentState** (string) - The current state of the document.

#### Response Example
```json
{
  "documentState": "Ready"
}
```
```

--------------------------------

### Enumeration includedFilterSettings

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/enums/spotfire.webPlayer.includedFilterSettings.html

Defines what settings to include when getting filter columns.

```APIDOC
## Enumeration includedFilterSettings

### Description
Defines what settings to include when getting filter columns.

### Enumeration Members
- ALL_WITH_CHECKED_HIERARCHY_NODES
- ALL_WITH_UNCHECKED_HIERARCHY_NODES
- NONE

### ALL_WITH_CHECKED_HIERARCHY_NODES
- **Value**: "AllWithCheckedHierarchyNodes"
- **Description**: Include all filter settings. Represent hierarchy paths with checked nodes.

### ALL_WITH_UNCHECKED_HIERARCHY_NODES
- **Value**: "AllWithUncheckedHierarchyNodes"
- **Description**: Include all filter settings. Represent hierarchy paths with unchecked nodes.

### NONE
- **Value**: "None"
- **Description**: Do not include any filter settings.
```

--------------------------------

### Get Active Page

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves the currently active page in the analysis.

```APIDOC
## GET /api/pages/active

### Description
Gets the active page.

### Method
GET

### Endpoint
/api/pages/active

### Parameters
#### Query Parameters
- **callback** (OnGetActivePage) - Required - The callback function.

### Response
#### Success Response (200)
- **pageTitle** (string) - The title of the active page.

#### Response Example
```json
{
  "pageTitle": "Sales Overview"
}
```
```

--------------------------------

### Get Reports

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves the names of all reports available in the analysis.

```APIDOC
## GET /api/reports

### Description
Gets the names of the reports in the analysis.

### Method
GET

### Endpoint
/api/reports

### Parameters
#### Query Parameters
- **callback** (OnGetReports) - Required - The callback function.

### Response
#### Success Response (200)
- **reportNames** (array) - An array of report names.

#### Response Example
```json
{
  "reportNames": ["Report A", "Report B"]
}
```
```

--------------------------------

### Load and Connect to Spotfire Analysis

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/index.html

This snippet demonstrates how to set up a web page to authenticate with Spotfire, connect to a specific analysis, and open it. Ensure the API version is set correctly and all required parameters for authentication and connection are provided.

```javascript
<html>
  <head>
    <script src="https://my.spotfire.com/spotfire/js-api/oauth.js"></script>
    <script>
      document.addEventListener('DOMContentLoaded', loadMashup);
      function loadMashup() {
        const server = "https://my.spotfire.com";
        const clientId = "registered_client_id";
        const redirectUri = "https://client.website.com/oauthEnd.html";
        const path = "/user/my analysis";

        /** Declare the version of the API */
        spotfire.webPlayer.setApiVersion("14.5");

        /** Authenticate the user */
        const authSettings = { clientId, server, redirectUri };
        spotfire.webPlayer.authenticate(authSettings).then(connect).then(open).catch(onError);

        /** Connect to a specified analysis using the authentication token */
        function connect(token) {
            const connectSettings = { token, path };
            return spotfire.webPlayer.connect(connectSettings);
        }

        /** Open the start page  */
        function open(application) {
            application.openDocument("SpotfireContent");
        }

        function onError(err) {
            console.error("Spotfire JavaScript API Error:", err.category, err.code, err.message);
        }
      }
    </script>
    </head>
    <body>
        <div id="SpotfireContent" />
    </body>
</html>
```

--------------------------------

### Basic Web Mashup Connection Flow

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/modules.html

Demonstrates the essential steps for a JavaScript web mashup to connect to Spotfire. This includes authenticating the user, connecting to the API, and opening a document within a specified HTML element.

```javascript
// Example of required steps to open a Spotfire analysis using the JavaScript API

// 1. Trigger authentication
spotfire.webPlayer.authenticate(authenticationSettings).then(function() {
    // 2. Connect to Spotfire
    spotfire.webPlayer.connect(connectSettings).then(function(app) {
        // 3. Open the document
        app.openDocument(documentPath, htmlElement).then(function(doc) {
            // Document is now open and ready for interaction
        });
    });
});

```

--------------------------------

### connect

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/functions/spotfire.webPlayer.connect.html

Connects to Spotfire to create an instance of a Spotfire Application.

```APIDOC
## connect

### Description
Connect to Spotfire to create an instance of a Spotfire Application.

### Method
N/A (This is a JavaScript function call, not a REST API endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```javascript
// Example usage (assuming ConnectSettings is defined elsewhere)
spotfire.connect(settings).then(application => {
  console.log('Connected to Spotfire:', application);
}).catch(error => {
  console.error('Failed to connect:', error);
});
```

### Response
#### Success Response (Promise<Application>)
- **Application** (object) - An instance of the Spotfire Application.

#### Response Example
```json
{
  "example": "// The actual structure of the Application object depends on the API"
}
```

### Since
12.0
```

--------------------------------

### Application Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Application.html

The Application class is used to create a Web Player instance, manage document instances, and connect to global events. It provides access to opened documents and methods for closing, logging out, and handling various events.

```APIDOC
## Interface Application
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.
interface Application {
  analysisDocument: Document;
  analysisDocuments: Document[];
  close(): void;
  logout(): void;
  onClosed(callback: OnClosedCallback): void;
  onError(callback: OnErrorCallback): void;
  onLoggedOut(callback: OnLoggedOutCallback): void;
  onOpened(callback: OnOpenedCallback): void;
  open(
    analysisPath: string,
    divId: string,
    parameter: string,
    documentId: string,
  ): void;
  openDocument(
    elementId: string,
    initialPage?: string | number,
    customizationInfo?: ICustomization,
  ): Document;
}

### Properties
#### analysisDocument
`analysisDocument: Document`
Reference to the first Document object loaded. This property will be `null` if no document is loaded.

#### analysisDocuments
`analysisDocuments: Document[]`
Array with all open documents.

### Methods
#### close
`close(): void`
Closes all currently opened documents. Will raise Application.onClosed once per document. Will raise Application.onError if no document is opened, or the closing failed.

#### logout
`logout(): void`
Log out. Can be used without having any open documents.

#### onClosed
`onClosed(callback: OnClosedCallback): void`
Registers an event handler for the onClosed event.

##### Parameters
- **callback** (OnClosedCallback) - The event handler.

#### onError
`onError(callback: OnErrorCallback): void`
Registers an event handler for the onError event.

##### Parameters
- **callback** (OnErrorCallback) - The event handler.

#### onLoggedOut
`onLoggedOut(callback: OnLoggedOutCallback): void`
Registers an event handler for the onLoggedOut event.

##### Parameters
- **callback** (OnLoggedOutCallback) - The event handler.

#### onOpened
`onOpened(callback: OnOpenedCallback): void`
Registers an event handler for the onOpened event.

##### Parameters
- **callback** (OnOpenedCallback) - The event handler.

#### open
`open(analysisPath: string, divId: string, parameter: string, documentId: string): void`
Open a given analysis. The Application.onOpened event will be raised when the document is opened.

##### Parameters
- **analysisPath** (string) - The path in the library to the analysis to open.
- **divId** (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.
- **parameter** (string) - Load parameters for the analysis (bookmarks, Information Link parameters, etc.). Example: 'Parameters.Param = {val1, "Val 2"}; SetPage(pageIndex = 1); ApplyBookmark(bookmarkName="All");'. For more information see: Parameter Configuration Block.
- **documentId** (string) - If set, just refresh an existing web analysis.

##### Deprecated
Use the Application.openDocument function.

#### openDocument
`openDocument(elementId: string, initialPage?: string | number, customizationInfo?: ICustomization): Document`
Open an analysis document instance specified by the application. The Application.onOpened event will fire when the document is loaded. Multiple documents can be opened for a single application using Application.openDocument. When several documents are created for an application these documents will automatically be linked together.

##### Parameters
- **elementId** (string) - The id of the DOM element in which to display the Web Player. The Web Player will adapt to the size of this element.
- **initialPage** (string | number) - Optional. Specifies the initial page when opening the analysis. Either page id (boolean) or page title can be used. If not set, the current page of the analysis will be used.
- **customizationInfo** (ICustomization) - Optional. Customization of the UI. This will override customization set when creating the application.

##### Returns
Document - The document. Note that the API methods defined by this instance will be queued until the Application.onOpened event is raised.
```

--------------------------------

### Get Document Metadata

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves the metadata associated with the current document.

```APIDOC
## GET /api/document/metadata

### Description
Get the metadata for the document.

### Method
GET

### Endpoint
/api/document/metadata

### Parameters
#### Query Parameters
- **callback** (OnGetDocumentMetadata) - Required - The callback function.

### Response
#### Success Response (200)
- **metadata** (object) - An object containing document metadata.

#### Response Example
```json
{
  "metadata": {
    "title": "Sales Analysis",
    "author": "John Doe"
  }
}
```
```

--------------------------------

### Spotfire API Client Registration Output

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/index.html

This is the typical output after successfully registering an API client. It provides the client ID and instructions for viewing, listing, or deleting clients.

```text
Successfully registered a new API client with the display name 'JavaScript API client':
Client ID: 12f4a3c33d377ed5c7ab476d69ea52d1.oauth-clients.spotfire.com
No client secret issued (public client)
To view the full client configuration, please use the 'show-oauth2-client' command.
To get a list of all existing clients, please use the 'list-oauth2-clients' command.
To delete a registered client, please use the 'delete-oauth2-client' command.
```

--------------------------------

### Export to PDF

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Launches the dialog for exporting the current view to PDF.

```APIDOC
## POST /api/export/pdf

### Description
Launches the export to PDF dialog.

### Method
POST

### Endpoint
/api/export/pdf

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "PDF export dialog launched"
}
```
```

--------------------------------

### Print Document

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Launches the print dialog for the current view.

```APIDOC
## POST /api/print

### Description
Launch the print dialog.

### Method
POST

### Endpoint
/api/print

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Print dialog launched"
}
```
```

--------------------------------

### On Document Ready Event

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Registers a callback function to be invoked once the document is fully loaded and ready.

```APIDOC
## POST /api/events/onDocumentReady

### Description
Register a callback function that will be called when the document is ready.

### Method
POST

### Endpoint
/api/events/onDocumentReady

### Parameters
#### Request Body
- **callback** (OnDocumentReady) - Required - The callback function.

### Response
#### Success Response (200)
- **status** (string) - Indicates successful registration.

#### Response Example
```json
{
  "status": "Callback registered successfully."
}
```
```

--------------------------------

### Get Document Property

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Retrieves information about a specific document property by its name.

```APIDOC
## GET /api/document/properties/{propertyName}

### Description
Get the information about the property with the given name.

### Method
GET

### Endpoint
/api/document/properties/{propertyName}

### Parameters
#### Path Parameters
- **propertyName** (string) - Required - The name of the property.
#### Query Parameters
- **callback** (OnGetProperty) - Required - The callback function.

### Response
#### Success Response (200)
- **propertyValue** (string) - The value of the specified property.

#### Response Example
```json
{
  "propertyValue": "Example Value"
}
```
```

--------------------------------

### Register Spotfire API Client

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/index.html

Use the `register-api-client` command to register a new API client with Spotfire Server. Specify client name, scopes, grant types, allowed origins, and redirect URIs. Ensure redirect URIs match the `redirectUri` setting and reside on the same origin as the allowed origin.

```bash
register-api-client --name="JavaScript API client" -Sapi.js-api -Soffline --client-profile=user_agent -Gauthorization_code -Grefresh_token -Ahttps://example.com -Rhttps://example.com/foo/return
```

--------------------------------

### ConnectSettings Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.ConnectSettings.html

Defines the structure for connection settings, including customization, open parameters, path, reconnect behavior, and authentication token.

```APIDOC
## Interface ConnectSettings

### Description
Settings for connecting to the Spotfire Web Player.

### Properties

#### `path` (string) - Required
The path, or library id, to the Spotfire analysis to use.

#### `token` (OAuthToken) - Required
The authentication token received from the authenticate function.

#### `customization` (ICustomization) - Optional
Customization settings.

#### `openParameters` (string) - Optional
The open parameters to use, for example allowing a bookmark to be set when initially loading the Spotfire application.

#### `reconnect` (boolean) - Optional
If true, the web mashup will try to re-connect to an already loaded analysis on the server. This is useful when the web mashup needs to support reloading the page, or when another authentication flow needs to be run.

### Example Request Body
```json
{
  "path": "/MyAnalysis",
  "token": {
    "access_token": "your_access_token",
    "token_type": "Bearer",
    "expires_in": 3600
  },
  "customization": {
    "brandings": [
      {
        "name": "MyBranding",
        "path": "/path/to/branding.zip"
      }
    ]
  },
  "openParameters": "bookmarkName=MyBookmark",
  "reconnect": true
}
```

### Example Success Response (Conceptual)
```json
{
  "status": "connected",
  "analysisPath": "/MyAnalysis"
}
```
```

--------------------------------

### Export to PowerPoint

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Launches the dialog for exporting the current view to PowerPoint.

```APIDOC
## POST /api/export/powerpoint

### Description
Launches the export to PowerPoint dialog.

### Method
POST

### Endpoint
/api/export/powerpoint

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "PowerPoint export dialog launched"
}
```
```

--------------------------------

### POST /authenticate

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/functions/spotfire.webPlayer.authenticate.html

Authenticates with the Spotfire server to obtain an OAuth token.

```APIDOC
## POST /authenticate

### Description
Creates an authentication token for the specified Spotfire server.

### Method
POST

### Endpoint
/authenticate

### Parameters
#### Request Body
- **settings** (AuthenticationSettings) - Required - The authentication settings.

### Request Example
```json
{
  "settings": {
    "clientId": "your_client_id",
    "clientSecret": "your_client_secret",
    "scope": "your_scope"
  }
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - The obtained OAuth access token.
- **tokenType** (string) - The type of the token (e.g., "Bearer").
- **expiresIn** (number) - The token's expiration time in seconds.

#### Response Example
```json
{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "tokenType": "Bearer",
  "expiresIn": 3600
}
```
```

--------------------------------

### OnGetMarkingNames Callback

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetMarkingNames.html

Callback function signature and description for OnGetMarkingNames.

```APIDOC
## Type Alias OnGetMarkingNames

### Description
Callback called when returning marking names from the Marking.getMarkingNames function.

### Type Declaration
```typescript
(names: string[]) => void
```

### Parameters
#### names
- **names** (string[]) - Required - The names of all markings in the document.

### Returns
- void
```

--------------------------------

### AuthenticationSettings Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.AuthenticationSettings.html

Defines the structure for authentication settings used in the authenticate function of the Spotfire Web Player JavaScript API.

```APIDOC
## Interface AuthenticationSettings

Authentication settings used in the authenticate function.

### Properties
- **anonymous** (boolean) - Optional - When true, anonymous user is accepted. This requires the Spotfire analysis to be publicly available.
- **clientId** (string) - Required - The registered client id.
- **redirectUri** (string) - Required - The redirect uri to use when the authentication flow has finished.
- **server** (string) - Required - The server URL.
- **silent** (boolean) - Optional - If set to true, silent authentication is used.
- **subjectToken** (string) - Optional - The subject token.
```

--------------------------------

### Type Alias: OnGetDataColumn

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetDataColumn.html

Callback function signature and description for OnGetDataColumn.

```APIDOC
## Type Alias: OnGetDataColumn

### Description
Callback called when a data column object is retrieved.

### Type Declaration
```typescript
(column: DataColumn) => void
```

### Parameters
* **column** (DataColumn) - The data column.

### Returns
void
```

--------------------------------

### Marking Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Marking.html

The Marking interface provides methods to interact with markings in a Spotfire analysis. It is accessible via the 'marking' property of the Document object.

```APIDOC
## Interface Marking

Contains marking related functionality. This object is created when the analysis document is loaded. To get an instance of this object use the marking property in the Document object.

### Methods
- getMarking
- getMarkingNames
- onChanged
- setMarking
```

--------------------------------

### Document Methods API

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Document.html

Interact with the Spotfire document using various methods.

```APIDOC
## Document Methods

### applyBookmark

#### Description
Applies a bookmark by its name. The onError event will be raised if the bookmarks does not exist or if several bookmark have the name.

#### Method
`applyBookmark(bookmarkName: string): void`

#### Parameters
- **bookmarkName** (string) - Required - The bookmark name.

#### Returns
void

#### Deprecated
Use Document.applyBookmarkById from API version 3.3 and forward.

### applyBookmarkById

#### Description
Applies a bookmark by its id. The onError event will be raised if the bookmarks does not exist.

#### Method
`applyBookmarkById(id: string): void`

#### Parameters
- **id** (string) - Required - The identifier of the bookmark to apply.

#### Returns
void

#### Since
3.3

### close

#### Description
Close the document. The onClosed callback will be called for the document. Note that there may be other open document instances for the application.

#### Method
`close(): void`

#### Returns
void

#### Since
7.5

### downloadAsDxp

#### Description
Download the analysis as a dxp file.

#### Method
`downloadAsDxp(): void`

#### Returns
void

#### Since
7.5

### executeCustomExportTool

#### Description
Execute a custom export tool.

#### Method
`executeCustomExportTool(fullToolName: string): void`

#### Parameters
- **fullToolName** (string) - Required - The full name of the export tool to execute, including namespace (e.g. "MyCompany.Spotfire.CustomTools.MyTool").

#### Returns
void

#### Since
7.5

### executeCustomTool

#### Description
Execute a custom tool.

#### Method
`executeCustomTool(fullToolName: string): void`

#### Parameters
- **fullToolName** (string) - Required - The full name of the tool to execute, including namespace (e.g. "MyCompany.Spotfire.CustomTools.MyTool").

#### Returns
void

#### Since
7.5

### exportActiveVisualAsImage

#### Description
Export active visualization image.

#### Method
`exportActiveVisualAsImage(width: number, height: number): void`

#### Parameters
- **width** (number) - Optional - The width of the exported image. Default value is 800px.
- **height** (number) - Optional - The height of the exported image. Default value is 600px.

#### Returns
void

#### Since
7.5

### exportReport

#### Description
Exports the report specified by name to PDF.

#### Method
`exportReport(reportName: string): void`

#### Parameters
- **reportName** (string) - Required - The name of the report to export.

#### Returns
void

#### Since
7.5
```

--------------------------------

### DataTable Interface Reference

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.DataTable.html

Provides details on the properties and methods available for interacting with data tables in the Spotfire Web Player.

```APIDOC
## Interface DataTable
Holds information about a data table in the document. To get the information use the Data data object.
#### Since
3.1
interface DataTable {
  dataTableName: string;
  getDataColumn(dataColumnName: string, callback: OnGetDataColumn): void;
  getDataColumns(callback: OnGetDataColumns): void;
  getDataTableProperties(callback: OnGetProperties): void;
  getDataTableProperty(propertyName: string, callback: OnGetProperty): void;
  onDataTablePropertyChanged(
    propertyName: string,
    callback: OnGetProperty,
  ): void;
  searchDataColumns(
    searchExpression: string,
    callback: OnGetDataColumns,
  ): void;
  setDataTableProperty(propertyName: string, propertyValue: any): void;
}

### Properties
#### dataTableName
`dataTableName`: string
The name of the data table.

### Methods
#### getDataColumn
`getDataColumn(dataColumnName: string, callback: OnGetDataColumn): void`
Get a data column with given name.
##### Parameters
- **dataColumnName** (string) - Required - The name of the data column.
- **callback** (OnGetDataColumn) - Required - The callback function.

#### getDataColumns
`getDataColumns(callback: OnGetDataColumns): void`
Get all data columns in the table.
##### Parameters
- **callback** (OnGetDataColumns) - Required - The callback function.

#### getDataTableProperties
`getDataTableProperties(callback: OnGetProperties): void`
List all properties in a table.
##### Parameters
- **callback** (OnGetProperties) - Required - The callback function.

#### getDataTableProperty
`getDataTableProperty(propertyName: string, callback: OnGetProperty): void`
Get the information about the property with given name.
##### Parameters
- **propertyName** (string) - Required - The name of the property.
- **callback** (OnGetProperty) - Required - The callback function.

#### onDataTablePropertyChanged
`onDataTablePropertyChanged(propertyName: string, callback: OnGetProperty): void`
Register a callback function that is called when a data table property has changed value.
##### Parameters
- **propertyName** (string) - Required - The name of the property to monitor.
- **callback** (OnGetProperty) - Required - The callback function.

#### searchDataColumns
`searchDataColumns(searchExpression: string, callback: OnGetDataColumns): void`
Get the data columns that matches the search expression.
##### Parameters
- **searchExpression** (string) - Required - The search expression. For search syntax see Spotfire user manual.
- **callback** (OnGetDataColumns) - Required - The callback function.

#### setDataTableProperty
`setDataTableProperty(propertyName: string, propertyValue: any): void`
Set the value of an existing property.
##### Parameters
- **propertyName** (string) - Required - The name of the property.
- **propertyValue** (any) - Required - The value of the property as a formatted string or an array of formatted strings, in the users locale.

```

--------------------------------

### OnDocumentReady Callback

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnDocumentReady.html

The OnDocumentReady callback is invoked when the document in the Spotfire Web Player becomes ready. This is indicated by the status bar icon turning green.

```APIDOC
## Type Alias OnDocumentReady

### Description
Callback called when the document switches to the ready state (the round icon in the status bar becomes green).

### Type Declaration
```typescript
(): void
```

### Returns
void
```

--------------------------------

### Customization API

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/classes/spotfire.webPlayer.Customization.html

The Customization class allows for the modification of the Web Player's appearance and behavior by controlling the visibility of various UI elements and features.

```APIDOC
## Class Customization

### Description
Customize the appearance of the Web Player. All have default value true, except panels that have null.

**Deprecated**: Use a plain JavaScript object implementing ICustomization. This class is not available until after the promise returned from connect has been resolved.

**Implements**: ICustomization

### Constructor

#### `new Customization()`
Initialized a new instance of a Customization.

**Returns**: Customization

### Properties

#### `showAbout` (boolean, optional)
Shows/hides the about menu item.

#### `showAnalysisInformationTool` (boolean, optional)
Shows/hides the analysis information tool menu item.

#### `showAuthor` (boolean, optional)
Shows/hides the button for enabling authoring.

#### `showClose` (boolean, optional)
Shows/hides the analysis close menu item.

#### `showCollaboration` (boolean, optional)
Shows/hides the collaboration conversation feature.

#### `showCustomizableHeader` (boolean, optional)
Shows/hides the customizable header (including the logo).

#### `showDodPanel` (boolean | null, optional)
Shows/hides the details on demand panel in the visualization. If `null` (default value), panel is shown as saved in the analysis.

#### `showExportFile` (boolean, optional)
Shows/hides the export file menu item.

#### `showFilterPanel` (boolean | null, optional)
Shows/hides the filter panel. If `null` (default value), panel is shown as saved in the analysis.

#### `showHelp` (boolean, optional)
Shows/hides the help menu item.

#### `showLogin` (boolean, optional)
Shows/hides the login button.

#### `showLogout` (boolean, optional)
Shows/hides the logout menu item.

#### `showMenu` (boolean, optional)
Shows/hides only the analysis toolbar menu.

#### `showPageNavigation` (boolean, optional)
Shows/hides the page navigation controls in the analysis.

#### `showStatusBar` (boolean, optional)
Shows/hides statusbar in the Web Player.

#### `showToolBar` (boolean, optional)
Shows/hides the analysis toolbar and menu.

#### `showUndoRedo` (boolean, optional)
Shows/hides the undo/redo menu item.
```

--------------------------------

### Customize Web Player Appearance

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.ICustomization.html

Use the ICustomization interface to control the visibility of various UI elements in the Web Player. Set properties to `false` to hide them or `null` for default behavior.

```javascript
const customization = {
 showCustomizableHeader = false;
};

const app = await spotfire.webPlayer.connect({ path, token, customization }) 
```

--------------------------------

### ICustomization Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.ICustomization.html

The ICustomization interface defines properties that control the visibility of various UI elements within the Spotfire Web Player. These properties allow developers to tailor the user experience by showing or hiding elements like toolbars, menus, panels, and action buttons.

```APIDOC
## Interface ICustomization

Customize the appearance of the Web Player. All properties have a default value of `true`, except for `showDodPanel` and `showFilterPanel` which default to `null`.

### Properties

- **showAbout** (boolean) - Optional - Shows/hides the about menu item.
- **showAnalysisInformationTool** (boolean) - Optional - Shows/hides the analysis information tool menu item.
- **showAuthor** (boolean) - Optional - Shows/hides the button for enabling authoring.
- **showClose** (boolean) - Optional - Shows/hides the analysis close menu item.
- **showCollaboration** (boolean) - Optional - Shows/hides the collaboration conversation feature.
- **showCustomizableHeader** (boolean) - Optional - Shows/hides the customizable header (including the logo).
- **showDodPanel** (boolean | null) - Optional - Shows/hides the details on demand panel in the visualization. If `null` (default value), panel is shown as saved in the analysis.
- **showExportFile** (boolean) - Optional - Shows/hides the export file menu item.
- **showFilterPanel** (boolean | null) - Optional - Shows/hides the filter panel. If `null` (default value), panel is shown as saved in the analysis.
- **showHelp** (boolean) - Optional - Shows/hides the help menu item.
- **showLogin** (boolean) - Optional - Shows/hides the login button.
- **showLogout** (boolean) - Optional - Shows/hides the logout menu item.
- **showMenu** (boolean) - Optional - Shows/hides only the analysis toolbar menu.
- **showPageNavigation** (boolean) - Optional - Shows/hides the page navigation controls in the analysis.
- **showStatusBar** (boolean) - Optional - Shows/hides statusbar in the Web Player.
- **showToolBar** (boolean) - Optional - Shows/hides the analysis toolbar and menu.
- **showUndoRedo** (boolean) - Optional - Shows/hides the undo/redo menu item.

### Example

```javascript
const customization = {
 showCustomizableHeader: false
};

const app = await spotfire.webPlayer.connect({ path, token, customization });
```

### Implemented by

- Customization
```

--------------------------------

### ICustomization Interface Definition

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.ICustomization.html

Defines the available properties for customizing the Spotfire Web Player's appearance and functionality. Properties are optional booleans or booleans with a null option.

```typescript
interface ICustomization {
 showAbout?: boolean;
 showAnalysisInformationTool?: boolean;
 showAuthor?: boolean;
 showClose?: boolean;
 showCollaboration?: boolean;
 showCustomizableHeader?: boolean;
 showDodPanel?: boolean | null;
 showExportFile?: boolean;
 showFilterPanel?: boolean | null;
 showHelp?: boolean;
 showLogin?: boolean;
 showLogout?: boolean;
 showMenu?: boolean;
 showPageNavigation?: boolean;
 showStatusBar?: boolean;
 showToolBar?: boolean;
 showUndoRedo?: boolean;
}
```

--------------------------------

### Spotfire Web Player JavaScript API Reference

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/modules/spotfire.webPlayer.html

This section details the Spotfire Web Player JavaScript API, including its namespaces, enumerations, classes, interfaces, type aliases, and functions.

```APIDOC
## Spotfire Web Player JavaScript API Reference

This API allows for interaction with the Spotfire Web Player using JavaScript.

### Namespace: webPlayer

#### Enumerations
- `columnDataType`
- `errorCodes`
- `filteringOperation`
- `filterType`
- `includedFilterSettings`
- `markingOperation`

#### Classes
- `Customization`
- `FilterSettings`

#### Interfaces
- `Application`
- `AuthenticationSettings`
- `ConnectSettings`
- `Data`
- `DataColumn`
- `DataColumnRangeState`
- `DataTable`
- `Document`
- `DocumentMetadata`
- `DocumentState`
- `FilterColumn`
- `Filtering`
- `FilteringScheme`
- `ICustomization`
- `Marking`
- `OAuthToken`
- `PageState`
- `Property`
- `WebBookmark`

#### Type Aliases
- `OnActivePageChanged`
- `OnClosedCallback`
- `OnDocumentReady`
- `OnErrorCallback`
- `OnGetActivePage`
- `OnGetBookmarkNames`
- `OnGetBookmarks`
- `OnGetDataColumn`
- `OnGetDataColumns`
- `OnGetDataTable`
- `OnGetDataTables`
- `OnGetDistinctValues`
- `OnGetDocumentMetadata`
- `OnGetDocumentState`
- `OnGetFilterColumn`
- `OnGetFilterColumns`
- `OnGetFilteringScheme`
- `OnGetFilteringSchemes`
- `OnGetMarkingNames`
- `OnGetPages`
- `OnGetProperties`
- `OnGetProperty`
- `OnGetReports`
- `OnLoggedOutCallback`
- `OnMarking`
- `OnOpenedCallback`
- `OnRangeChanged`

#### Functions
- `authenticate()`
- `connect()`
- `oauthEnd()`
- `setApiVersion()`

```

--------------------------------

### Data Interface Methods

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Data.html

This section details the methods available within the Data interface for retrieving and managing data tables, as well as handling data range changes.

```APIDOC
## Data Interface

Contains data related functionality. This object is created when the document is loaded. To get an instance of this object use the Document.data property.

### Methods

#### getActiveDataTable
  * getActiveDataTable(callback: OnGetDataTable): void
Get the current data table object.

##### Parameters
    * callback: OnGetDataTable
      The callback function.

##### Returns
  void

##### Since
  3.1

#### getDataTable
  * getDataTable(dataTableName: string, callback: OnGetDataTable): void
Get the data table with given name.

##### Parameters
    * dataTableName: string
      The name of the data table.
    * callback: OnGetDataTable
      The callback function.

##### Returns
  void

##### Since
  3.1

#### getDataTables
  * getDataTables(callback: OnGetDataTables): void
Get all data tables in the document.

##### Parameters
    * callback: OnGetDataTables
      The callback function.

##### Returns
  void

##### Since
  3.1

#### onRangeChanged
  * onRangeChanged(
filteringSchemeName: string,
dataTableName: string,
dataColumnName: string,
callback: OnRangeChanged,
): void
Register a callback function that will be called when filtered range in a data column is changed.

##### Parameters
    * filteringSchemeName: string
      The name of the filtering scheme in which to listen for filtering changes.
    * dataTableName: string
      The name of the data table in which to listen for filtering changes.
    * dataColumnName: string
      The name of the filtering data column in which to listen for filtering changes.
    * callback: OnRangeChanged
      The callback function.

##### Returns
  void

##### Remarks
  Note that the callback will be called when the filtered data changes, and will only specify the range of the filtered data column. The range will always be `[null, null]` for Hierarchy Filters.
```

--------------------------------

### DocumentState Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.DocumentState.html

The DocumentState interface provides access to the current state of the document loaded in the Spotfire Web Player.

```APIDOC
## Interface DocumentState

### Description
Contains information about the current state of the document.

### Properties
- **hasUnsavedChanges** (boolean) - Value indicating whether there are unsaved changes in the document.
- **isEditing** (boolean) - Value indicating whether the Spotfire UI is in editing or viewing mode.

### Since
11.4
```

--------------------------------

### Spotfire Namespace

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/modules/spotfire.html

The root namespace for the Spotfire Web Player JavaScript API.

```APIDOC
## Namespace spotfire

### Description
The root namespace for the Spotfire Web Player JavaScript API.

### Sub-namespaces

- **webPlayer**: Provides access to functionalities related to the Spotfire Web Player.
```

--------------------------------

### OnGetBookmarkNames Callback

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetBookmarkNames.html

Callback function that is invoked when bookmark names are retrieved from the getBookmarkNames function. It receives an array of bookmark names as its argument.

```APIDOC
## Type Alias OnGetBookmarkNames

### Description
Callback called when returning bookmark names from the getBookmarkNames function.

### Type Declaration
```typescript
(bookmarkNames: string[]) => void
```

### Parameters
#### bookmarkNames
- **bookmarkNames** (string[]) - Required - Array of the bookmark names.

### Returns
- void
```

--------------------------------

### Property Interface

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.Property.html

Defines the structure for representing properties in Spotfire, such as document, table, or column properties.

```APIDOC
## Interface Property

Contains information about a property. This can be document properties, table properties or column properties.

### Properties

- **name** (string) - The name of the property.
- **value** (string | string[]) - The value of the property as a formatted string or an array of formatted strings, in the user's locale.
```

--------------------------------

### DataColumn Methods

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/interfaces/spotfire.webPlayer.DataColumn.html

Details of the methods available for the DataColumn interface.

```APIDOC
### Method: getDataColumnProperties
- **Description**: Get a list of the properties in the column.
- **Parameters**:
  - **callback** (OnGetProperties): The callback function.
- **Returns**: void
```

```APIDOC
### Method: getDataColumnProperty
- **Description**: Get the information about the property with the given name.
- **Parameters**:
  - **propertyName** (string): The name of the property.
  - **callback** (OnGetProperty): The callback function.
- **Returns**: void
```

```APIDOC
### Method: getDistinctValues
- **Description**: Get a list of the unique values in the data column.
- **Parameters**:
  - **startIndex** (number): The zero-based start index of the distinct values.
  - **responseLimit** (number): Limit the response to this number of values.
  - **callback** (OnGetDistinctValues): The callback function.
- **Returns**: void
- **Since**: 7.5
```

```APIDOC
### Method: onDataColumnPropertyChanged
- **Description**: Register a callback function that is called when a column property has changed value.
- **Parameters**:
  - **propertyName** (string): The name of the property to monitor.
  - **callback** (OnGetProperty): The callback function.
- **Returns**: void
```

```APIDOC
### Method: setDataColumnProperty
- **Description**: Set the value of an existing property.
- **Parameters**:
  - **propertyName** (string): The name of the property.
  - **propertyValue** (any): The value of the property as a formatted string or an array of formatted strings, in the user's locale.
- **Returns**: void
```

--------------------------------

### OnGetBookmarks Callback

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetBookmarks.html

Callback function invoked when bookmarks are returned from the getBookmarks function.

```APIDOC
## Type Alias OnGetBookmarks

### Description
Callback called when returning bookmarks from the getBookmarks function.

### Type Declaration
```typescript
(bookmarks: WebBookmark[]) => void
```

### Parameters
* **bookmarks** (WebBookmark[]) - Required - Array of bookmarks.
```

--------------------------------

### Spotfire OAuth Redirect Handler

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/index.html

This HTML page is used as the redirect URI for the OAuth flow. It must be hosted on the same domain as the web mashup and simply calls `spotfire.webPlayer.oauthEnd()` to process the authentication result.

```html
<!DOCTYPE html>
<html>
  <head>
    <title>Generic OAuth Endpoint</title>
    <script src="https://my.spotfire.com/spotfire/js-api/oauth.js"></script>
    <script>
      /** Processes the oauth result and redirects back. */
      spotfire.webPlayer.oauthEnd();
    </script>
  </head>
</html>
```

--------------------------------

### OnGetProperties Callback

Source: https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/types/spotfire.webPlayer.OnGetProperties.html

The OnGetProperties callback is invoked when a list of properties is successfully retrieved. It accepts an array of properties as an argument.

```APIDOC
## Type Alias OnGetProperties

### Description
Callback called when a list of properties is retrieved.

### Type Declaration
```typescript
(properties: Property[]) => void
```

### Parameters
#### properties
- **properties** (Property[]) - Required - The properties array.
```
Tokens:
Raw