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

Interface DataTable

Represents a data table in the Spotfire document.

interface DataTable {
    columnCount: number;
    name: string;
    column(name: string): ReadableProxy<Column>;
    columns(): Readable<Column[]>;
    properties(): Readable<AnalysisPropertyValue<AnalysisPropertyDataType>[]>;
    property(
        name: string,
    ): Readable<AnalysisPropertyValue<AnalysisPropertyDataType>>;
}

Hierarchy (View Summary)

DataTableValues
- DataTable

Index

Properties

columnCount name

Methods

column columns properties property

Properties

columnCount

columnCount: number

Gets the number of columns in this instance.

name

name: string

Gets the name of this instance.

Methods

column

column(name: string): ReadableProxy<Column>
Provides access to the Column with the specified name.
Parameters
- name: string
Returns ReadableProxy<Column>

columns

columns(): Readable<Column[]>
Provides access to the columns of this instance. See Column.

Returns Readable<Column[]>

properties

properties(): Readable<AnalysisPropertyValue<AnalysisPropertyDataType>[]>
Provides access to the properties of this instance. See AnalysisProperty.

Returns Readable<AnalysisPropertyValue<AnalysisPropertyDataType>[]>

property

property(
name: string,
): Readable<AnalysisPropertyValue<AnalysisPropertyDataType>>
Provides access to the AnalysisProperty with the specified name.
Parameters
- name: string
Returns Readable<AnalysisPropertyValue<AnalysisPropertyDataType>>