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;
}

Methods

axis data mainTable setMainTable

Methods

axis

  • axis(name): 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

mainTable

setMainTable

  • setMainTable(tableName): void

  • Sets the main DataTable in the Mod visualization.

    Parameters

    • tableName: string

      The name or id of the DataTable to be used as main table.

    Returns void

  • setMainTable(table): void

  • Sets the main DataTable in the Mod visualization.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Methods