Interface ModVisualization

Represents the content in the Mod Visualization that can be read and/or modified.

The content is a combination of state stored by the Mod Visualization in the Spotfire document, its view of the data and relevant UI properties. All values are Readable objects and are typically accessed using the Reader object.

interface ModVisualization {
    axis(name: string): ReadableProxy<Axis>;
    data(): DataViewProxy;
    mainTable(): ReadableProxy<DataTable>;
    setMainTable(tableName: string): void;
    setMainTable(table: DataTable): void;
}

Index

Methods

axis data mainTable setMainTable

Methods

axis

axis(name: string): ReadableProxy<Axis>
Provides access to the Axis in the Mod Visualization with the specified name. All axes must be declared in the mod-manifest.json.
Parameters
- name: string
  The name of the Axis.
Returns ReadableProxy<Axis>

data

data(): DataViewProxy
Provides access to the DataView that the Mod Visualization is to render.

Returns DataViewProxy

mainTable

mainTable(): ReadableProxy<DataTable>
Provides access to the DataTable in the Spotfire document that the Mod Visualization uses as its main table.

Returns ReadableProxy<DataTable>

setMainTable

setMainTable(tableName: string): void
Sets the main DataTable in the Mod visualization.
Parameters
- tableName: string
  The name of the DataTable to be used as main table.
Returns void
setMainTable(table: DataTable): void
Sets the main DataTable in the Mod visualization.
Parameters
- table: DataTable
  The DataTable object to be used as main table.
Returns void

Interface ModVisualization

Index

Methods

Methods

axis

Parameters

Returns ReadableProxy<Axis>

data

Returns DataViewProxy

mainTable

Returns ReadableProxy<DataTable>

setMainTable

Parameters

Returns void

Parameters

Returns void

Settings

On This Page