Class

SpotfireDataTable

SpotfireDataTable(dataTableDescription)

Constructor

new SpotfireDataTable(dataTableDescription)

Represents a data table in the SpotfireDocumentEditor state to be created when calling applyState.

Parameters:
Name Type Description
dataTableDescription DataTableDescription
name String

The name of the data table.

fromUrl String

The URL of the source.

fromInformationLink String

The information link to be used to load the data table.

informationLinkParameters String

The parameters of the information link.

addedColumnsDefinitions Array.<AddedColumnsDefinition>

Array of columns to add (calculated column, etc ...).

[].type SpotfireDataColumnsTypes  {Enum} 

The type of the column to add from SpotfireDataColumnsTypes.

Enum options: calculatedDataColumn
[].name String

The name of the column to add.

[].expression String

The expression to be used to calculate the column.

importedDataAsColumns Array.<ImportedDataAsColumnDefinition>

Array of columns to import.

[].urlSource String

The URL of the source containing the columns to be imported.

[].dataTableTarget String

The name of the data table in which new columns will be imported.

[].targetIdColumn String

The name of the column in the target data table to use for the matching.

[].sourceIdColumn String

The name of the column in the source data table to use for the matching.

[ [].otherColumnsMatching ] Array.<ColumnMatching>

Array of the description of other column matches.

[].targetColumn String

The name of the column in the target data table to use for the matching.

[].sourceColumn String

The name of the column in the source data table to use for the matching.

[ [].replaceCommonColumns = false ] Boolean

Specifies whether the columns in the target data table should be replaced by the imported columns if they are common. Otherwise, the name of imported columns will be indexed.

[].columnsToReplace Array.<String>

Columns to be replaced by the imported data.

importedDataAsRows Array.<ImportedDataAsRowDefinition>

Array of rows to import.

[].urlSource String

The URL of the source containing the columns to be imported.

[].dataTableTarget String

The name of the data table in which new rows will be imported.

[ [].ignoredColumn ] Array.<String>

The list of columns to be ignored during importation.

[ [].rowSourceColumn ] String

The column that identifies the origin of the row.

[ [].rowSourceValue ] String

The value that identifies the source of the row from the imported source.

[ [].originalRowSourceValue ] String

The value that identifies the source of the row from the target data table.

[ [].mappings ] Array.<ColumnMatching>

The list of columns to map between imported rows to existing rows. If not set, all common columns are merged. If set, common columns will be created with an indexed name.

[].targetColumn String

The name of the column in the target data table to use for the matching.

[].sourceColumn String

The name of the column in the source data table to use for the matching.

properties Array.<DataTablePropertyDefinition>

Array of data table properties.

[].name String
[].value string | boolean | number

Members

Array.<Object>

addedColumns

String

dataTableName

Array.<Object>

importedDataAsColumns

Array.<Object>

importedDataAsRows

String

informationLink

Array.<InformationLinkParameter>

informationLinkParameters

Array.<Object>

properties

String

url