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

Interface ModLayer

Represents an instance of a dynamic layer in a mod visualization.

Since

2.4

interface ModLayer {
    id: string;
    type: string;
    axis(name: string): ReadableProxy<Axis>;
    axis(name: string, dataViewName: string): ReadableProxy<Axis>;
    data(): DataViewProxy;
    data(name?: string): DataViewProxy;
    mainTable(): ReadableProxy<DataTable>;
    mainTable(dataViewName?: string): ReadableProxy<DataTable>;
    property<T extends ModPropertyDataType>(
        name: string,
    ): ReadableProxy<ModProperty<T>>;
    setMainTable(tableName: string): void;
    setMainTable(tableName: string, dataViewName?: string): void;
    setMainTable(table: DataTable): void;
    setMainTable(table: DataTable, dataViewName?: string): void;
    title(dataViewName?: string): ReadableProxy<Title>;
}

Index

Properties

Methods

axis data mainTable property setMainTable title

Properties

id

id: string

The id of the layer instance.

type

type: string

The type of the layer, as defined in the manifest.

Methods

axis

axis(name: string): ReadableProxy<Axis>
Provides access to the Axis in the layer 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>
axis(name: string, dataViewName: string): ReadableProxy<Axis>
Provides access to the Axis in the layer with the specified axisName in the data view with name dataViewName. All axes must be declared in the mod-manifest.json.
Parameters
- name: string
- dataViewName: string
  The name of the DataView.
Returns ReadableProxy<Axis>

data

data(): DataViewProxy
Provides access to the main DataView of the layer.

Returns DataViewProxy
data(name?: string): DataViewProxy
Provides access to a DataView of the layer with the specified name.
Parameters
- Optionalname: string
  The name of the view.
Returns DataViewProxy

mainTable

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

Returns ReadableProxy<DataTable>
mainTable(dataViewName?: string): ReadableProxy<DataTable>
Provides access to the DataTable in the Spotfire document that the layer uses as the main table of the named data view.
Parameters
- OptionaldataViewName: string
  The name of the DataView.
Returns ReadableProxy<DataTable>

property

property<T extends ModPropertyDataType>(
name: string,
): ReadableProxy<ModProperty<T>>
Provides access to the ModProperty with the specified name.
Type Parameters
- T extends ModPropertyDataType
Parameters
- name: string
Returns ReadableProxy<ModProperty<T>>

setMainTable

setMainTable(tableName: string): void
Sets the main DataTable in the layer.
Parameters
- tableName: string
  The name or id of the DataTable to be used as main table.
Returns void
setMainTable(tableName: string, dataViewName?: string): void
Sets the main DataTable of the named data view in the layer.
Parameters
- tableName: string
  The name or id of the DataTable to be used as main table.
- OptionaldataViewName: string
  The name of the DataView.
Returns void
setMainTable(table: DataTable): void
Sets the main DataTable in the layer.
Parameters
- table: DataTable
  The DataTable object to be used as main table.
Returns void
setMainTable(table: DataTable, dataViewName?: string): void
Sets the main DataTable of the named data view in the layer.
Parameters
- table: DataTable
  The DataTable object to be used as main table.
- OptionaldataViewName: string
  The name of the DataView.
Returns void

title

title(dataViewName?: string): ReadableProxy<Title>
Provides access to the Title of the layer or named DataView.
Parameters
- OptionaldataViewName: string
  The name of the named DataView as specified in the mod-manifest.json.
Returns ReadableProxy<Title>