Class DataTableCollection

[iterator]

• "[iterator]"(): Iterator<DataTable>

  Returns Iterator<DataTable>

ReadonlyItem

Count

• get Count(): number

  Gets the number of tables.

  Returns number

  Since

  2.0

DefaultTableReference

• get DefaultTableReference(): null | DataTable

  Gets or sets the current default table. The value may not be set to null but will be null when there are no tables in the collection.

  Returns null | DataTable

  Remark

  If the current active table is needed, instead use the Spotfire.Dxp.Application.Document.ActiveDataTableReference property.

  Since

  2.0

• set DefaultTableReference(value: null | DataTable): void

  Parameters

  • value: null | DataTable

  Returns void

Add

• Add(dataTableName: string | String, dataSource: DataSource): DataTable

  Create and add a Spotfire.Dxp.Data.DataTable from a Spotfire.Dxp.Data.DataSource. Use Spotfire.Dxp.Data.DataManager.CreateFileDataSource|CreateFileDataSource(filePath) to create a Spotfire.Dxp.Data.DataSource from a file path.

  Parameters

  • dataTableName: string | String

    The name of the data table.

  • dataSource: DataSource

    The Spotfire.Dxp.Data.DataSource to retrieve data from.

  Returns DataTable

  The data table.

  Since

  2.0

• Add(
      dataTableName: string | String,
      dataSource: DataSource,
      autoCreateFilters: boolean | Boolean,
  ): DataTable

  Create and add a Spotfire.Dxp.Data.DataTable from a Spotfire.Dxp.Data.DataSource. Use Spotfire.Dxp.Data.DataManager.CreateFileDataSource|CreateFileDataSource(filePath) to create a Spotfire.Dxp.Data.DataSource from a file path.

  Parameters

  • dataTableName: string | String

    The name of the data table.

  • dataSource: DataSource

    The Spotfire.Dxp.Data.DataSource to retrieve data from.

  • autoCreateFilters: boolean | Boolean

    If set to true filters are automatically created for all columns in the newly created data table. If set to false filters may be added manually when needed.

  Returns DataTable

  The data table.

  Since

  2.0

CanReloadAllData

• CanReloadAllData(): boolean

  Gets a value indicating whether any data tables can be reloaded using the Spotfire.Dxp.Data.DataTableCollection.ReloadAllData method.

  Returns boolean

  True if any data table can be reloaded; false otherwise.

  Remark

  Reloading data might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data.

  Since

  2.0

• CanReloadAllData(
      tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>,
  ): boolean

  Gets a value indicating whether any of the specified data tables can be reloaded using the ReloadAllData(tables) method.

  Parameters

  • tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>

    The data tables to reload.

  Returns boolean

  True if any data table can be reloaded; false otherwise.

  Remark

  Reloading data might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data.

  Since

  2.0

CanReloadLinkedData

• CanReloadLinkedData(): boolean

  Gets a value indicating whether any data tables can be reloaded using the Spotfire.Dxp.Data.DataTableCollection.ReloadLinkedData method.

  Returns boolean

  True if any data table can be reloaded; false otherwise.

  Remark

  Reloading only linked data is not possible for embedded data tables, and might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data, or data sources that have been set to store their data.

  Since

  2.0

• CanReloadLinkedData(
      tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>,
  ): boolean

  Gets a value indicating whether any of the specified data tables can be reloaded using the ReloadLinkedData(tables) method.

  Parameters

  • tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>

    The data tables to reload.

  Returns boolean

  True if any data table can be reloaded; false otherwise.

  Remark

  Reloading only linked data is not possible for embedded data tables, and might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data, or data sources that have been set to store their data.

  Since

  2.0

Contains

• Contains(dataTable: DataTable): boolean

  Check if the dataTable exists in this collection.

  Parameters

  • dataTable: DataTable

    The data table to search for.

  Returns boolean

  True if the dataTable exists in the collection, false otherwise.

  Since

  2.0

• Contains(id: Guid): boolean

  Check if a table with the given id exists in the collection.

  Parameters

  • id: Guid

    The id to search for.

  Returns boolean

  True if there exists a table with the given id in the collection, false otherwise.

  Since

  2.0

• Contains(name: string | String): boolean

  Check if a table with the given name exists in the collection.

  Parameters

  • name: string | String

    The name of a table to check if it exists in the collection.

  Returns boolean

  True if there exists a table with the given name in the collection, false otherwise.

  Since

  2.0

CreateUniqueName

• CreateUniqueName(tableName: string | String): string

  Create a new unique table name from a suggestion. The suggested name is used if possible.

  Parameters

  • tableName: string | String

    The suggested table name.

  Returns string

  A table name which is unique in the collection.

  Since

  2.0

GetEnumerator

• GetEnumerator(): System.Collections.Generic.IEnumerator<DataTable>

  Returns an enumerator that iterates through the collection.

  Returns System.Collections.Generic.IEnumerator<DataTable>

  A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

  Since

  2.0

IsValidName

• IsValidName(tableName: string | String): boolean

  Check if the suggested table name is a valid unique name in the collection.

  Parameters

  • tableName: string | String

    The suggested table name.

  Returns boolean

  True if the suggested name is a valid name for a new table in the collection, false otherwise.

  Since

  2.0

RefreshOnDemandData

• RefreshOnDemandData(): void

  Refreshes data that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate.

  Returns void

  Remark

  This will only refresh data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

  Since

  2.0

• RefreshOnDemandData(
      tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>,
  ): void

  Refreshes data that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate.

  Parameters

  • tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>

    The data tables to refresh.

  Returns void

  Remark

  This will only refresh data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

  Since

  2.0

ReloadAllData

• ReloadAllData(): void

  Reloads all data in all data tables, including embedded data tables and data sources set to store their data.

  Returns void

  Remark

  Reloading data might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data. For more fine-grained control over data reloading, use the Spotfire.Dxp.Data.DataOperations.DataOperation API on the Spotfire.Dxp.Data.SourceView

  Since

  2.0

• ReloadAllData(
      tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>,
  ): void

  Reloads all data in the specified data tables, including embedded data tables and data sources set to store their data.

  Parameters

  • tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>

    The data tables to reload.

  Returns void

  Remark

  Reloading data might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data. For more fine-grained control over data reloading, use the Spotfire.Dxp.Data.DataOperations.DataOperation API on the Spotfire.Dxp.Data.SourceView

  Since

  2.0

ReloadLinkedData

• ReloadLinkedData(): void

  Reloads only linked data in all data tables. Embedded data tables and data sources set to store their data will be ignored.

  Returns void

  Remark

  Reloading only linked data is not possible for an embedded data table, and might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data, or data sources that have been set to store their data. For more fine-grained control over data reloading, use the Spotfire.Dxp.Data.DataOperations.DataOperation API on the Spotfire.Dxp.Data.SourceView

  Since

  2.0

• ReloadLinkedData(
      tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>,
  ): void

  Reloads only linked data in the specified data tables. Embedded data tables and data sources set to store their data will be ignored.

  Parameters

  • tables: OrExplicit<System.Collections.Generic.IEnumerable<DataTable>>

    The data tables to reload.

  Returns void

  Remark

  Reloading only linked data is not possible for an embedded data table, and might not be possible if the data table contains parts that cannot be reloaded, such as clipboard data, or data sources that have been set to store their data. For more fine-grained control over data reloading, use the Spotfire.Dxp.Data.DataOperations.DataOperation API on the Spotfire.Dxp.Data.SourceView

  Since

  2.0

Remove

• Remove(dataTable: DataTable): void

  Remove the dataTable from the collection.

  Parameters

  • dataTable: DataTable

    The data table to remove.

  Returns void

  Remark

  All relations that the table is part of will also be removed.

  Since

  2.0

• Remove(tableName: string | String): void

  Remove the Spotfire.Dxp.Data.DataTable with the given name from the collection.

  Parameters

  • tableName: string | String

    The table name.

  Returns void

  Remark

  All relations that the table is part of will also be removed.

  Since

  2.0

TryGetValue

• TryGetValue(id: Guid, dataTable: OutParam<DataTable>): boolean

  Try to get a Spotfire.Dxp.Data.DataTable with a given id.

  Parameters

  • id: Guid

    The id of the data table to get.

  • dataTable: OutParam<DataTable>

    The resulting Spotfire.Dxp.Data.DataTable, or null if not found.

  Returns boolean

  True if the Spotfire.Dxp.Data.DataTable with the given id could be found, false otherwise.

  Since

  2.0

• TryGetValue(name: string | String, dataTable: OutParam<DataTable>): boolean

  Try to get a Spotfire.Dxp.Data.DataTable with a given name.

  Parameters

  • name: string | String

    The name of the data table to get.

  • dataTable: OutParam<DataTable>

    The resulting Spotfire.Dxp.Data.DataTable, or null if not found.

  Returns boolean

  True if the Spotfire.Dxp.Data.DataTable with the given name could be found, false otherwise.

  Since

  2.0