About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface SpotfireDocument

Represents the Spotfire document and provides access to read and modify parts of it.

interface SpotfireDocument {
    activePage(): ReadableProxy<Page>;
    pages(): Readable<Page[]>;
    properties(): Readable<AnalysisProperty<AnalysisPropertyDataType>[]>;
    property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(
        name: string,
    ): ReadableProxy<AnalysisProperty<T>>;
    setActivePage(name: string): void;
    setActivePage(index: number): void;
    setActivePage(page: Page): void;
    table(name: string): ReadableProxy<DataTable>;
    tables(): Readable<DataTable[]>;
}

Index

Methods

activePage pages properties property setActivePage table tables

Methods

activePage

activePage(): ReadableProxy<Page>
Provides access to the active Page in the Spotfire document. That is, the page that is currently visible.

Returns ReadableProxy<Page>

pages

pages(): Readable<Page[]>
Provides access to the Pages in the Spotfire document.

Returns Readable<Page[]>

properties

properties(): Readable<AnalysisProperty<AnalysisPropertyDataType>[]>
Provides access to the Document Properties in the Spotfire Document.

Returns Readable<AnalysisProperty<AnalysisPropertyDataType>[]>

property

property<T extends AnalysisPropertyDataType = AnalysisPropertyDataType>(
name: string,
): ReadableProxy<AnalysisProperty<T>>
Provides access to the Document Property with the specified name in the Spotfire Document.
Type Parameters
- T extends AnalysisPropertyDataType = AnalysisPropertyDataType
Parameters
- name: string
Returns ReadableProxy<AnalysisProperty<T>>

setActivePage

setActivePage(name: string): void
Sets the specified Page as the active page.
Parameters
- name: string
  The name/title or id of the page to set as active.
Returns void
setActivePage(index: number): void
Sets the specified index as the active page index.
Parameters
- index: number
  The index of the page to set as active.
Returns void
setActivePage(page: Page): void
Sets the specified Page as the active page.
Parameters
- page: Page
  The Page object to set as active.
Returns void

table

table(name: string): ReadableProxy<DataTable>
Provides access to the DataTable with the specified name in the Spotfire document.
Parameters
- name: string
Returns ReadableProxy<DataTable>

tables

tables(): Readable<DataTable[]>
Provides access to the DataTables in the Spotfire document.

Returns Readable<DataTable[]>