Class DataTable

A DataTable is a collection of columns and metadata.

Remark

No public constructors are defined for a data table, see the Spotfire.Dxp.Data.DataTableCollection class for creation methods.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNode
- DataTable

Implements

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): T1
Casts this object to the specified type. Throws error on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

Equals

Equals(obj: any): boolean
Determines whether the specified object is equal to the current object.
Parameters
- obj: any
  The object to compare with the current object.
Returns boolean
true if the specified object is equal to the current object; otherwise, false.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
Casts this object to the specified type. Returns null on failure.
Type Parameters
- T1
  The target type of the cast.
- T2
  The type of the object to cast.
Parameters
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1 | null
Inherited from DocumentNode.TryCast

`Static`Equals

Equals(objA: any, objB: any): boolean
Determines whether the specified object instances are considered equal.
Parameters
- objA: any
  The first object to compare.
- objB: any
  The second object to compare.
Returns boolean
true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Inherited from DocumentNode.Equals

Default capability

AutoCreateFilters

get AutoCreateFilters(): boolean
Gets or sets a value indicating whether to automatically create filters for new columns.

Returns boolean
Since
2.0
set AutoCreateFilters(value: boolean): void
Parameters
- value: boolean
Returns void

Columns

get Columns(): Spotfire.Dxp.Data.DataColumnCollection
Gets the collection of the columns that are part of this data table.

Returns Spotfire.Dxp.Data.DataColumnCollection
Since
2.0

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

HasValidPrimaryKey

get HasValidPrimaryKey(): boolean
Gets a value indicating whether the table has a valid primary key or not.

Returns boolean
Since
2.0

Id

get Id(): System.Guid
Gets a unique identifier for this table.

Returns System.Guid
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

IsExternal

get IsExternal(): boolean
Gets a value indicating whether the data in this table is kept external.

Returns boolean
Since
2.0

IsRefreshableByNeed

get IsRefreshableByNeed(): boolean
Gets a value indicating whether this table is refreshable by need, that is, it supports Spotfire.Dxp.Data.DataTable.RefreshOnDemandData calls and uses the Spotfire.Dxp.Data.DataTable.NeedsRefresh property to indicate if refresh is needed.

Returns boolean
Remark
Default is false.

Since
2.0

Name

get Name(): string
Gets or sets the name of this table.

Returns string
Since
2.0
set Name(value: string): void
Parameters
- value: string
Returns void

NameEscapedForExpression

get NameEscapedForExpression(): string
Gets the name of the table escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(identifier).

Returns string
Since
2.0

NeedsRefresh

get NeedsRefresh(): boolean
Gets a value indicating whether this table needs to be refreshed (by calling Spotfire.Dxp.Data.DataTable.RefreshOnDemandData).

Returns boolean
Since
2.0

PrimaryKey

get PrimaryKey(): System.Collections.Generic.IList<Spotfire.Dxp.Data.DataColumn>
Gets or sets the primary key for this data table. The primary key is a collection of columns in this table that provides a unique combination of values for each row.

Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataColumn>
Since
2.0
set PrimaryKey(
    value: OrExplicit<
        System.Collections.Generic.IList<Spotfire.Dxp.Data.DataColumn>,
    >,
): void
Parameters
- value: OrExplicit<System.Collections.Generic.IList<Spotfire.Dxp.Data.DataColumn>>
Returns void

Properties

get Properties(): Spotfire.Dxp.Data.DataTableProperties
Gets the properties describing this table.

Returns Spotfire.Dxp.Data.DataTableProperties
Since
2.0

Refreshing

get Refreshing(): boolean
Gets a value indicating whether the data table is refreshing.

Returns boolean
Remark
Only external events are raised when this property is changed. Internal events are not raised.

Since
2.0

RowCount

get RowCount(): number
Gets the number of rows in the columns in this table. All columns in a Spotfire.Dxp.Data.DataTable have the same number of rows.

Returns number
Since
2.0

ShowColumnMatchPrompt

get ShowColumnMatchPrompt(): boolean
Gets or sets a value indicating whether to show a prompt for matching columns when data has been replaced.

Returns boolean
Since
2.0
set ShowColumnMatchPrompt(value: boolean): void
Parameters
- value: boolean
Returns void

Transactions

get Transactions(): Spotfire.Dxp.Framework.DocumentModel.ITransactions
Gets a collection of methods for executing transactions on the document.

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddColumns

AddColumns(
dataSource: Spotfire.Dxp.Data.DataSource,
settings: Spotfire.Dxp.Data.AddColumnsSettings,
): Spotfire.Dxp.Data.ColumnsChangedResult
Adds columns from the columns retrieved from the dataSource using the settings in the settings parameter. Use Spotfire.Dxp.Data.DataManager.CreateFileDataSource|CreateFileDataSource(filePath) to create a data source from a file path.
Parameters
- dataSource: Spotfire.Dxp.Data.DataSource
  The data source to retrieve the new columns from.
- settings: Spotfire.Dxp.Data.AddColumnsSettings
  The settings to use when adding the columns to the current table.
Returns Spotfire.Dxp.Data.ColumnsChangedResult
Information about the changes that occured in the table.

Remark
If the settings specifies a join condition based on a calculated column, that column must be frozen. See Spotfire.Dxp.Data.CalculatedColumn.Freeze.

Since
2.0

AddRows

AddRows(
dataSource: Spotfire.Dxp.Data.DataSource,
settings: Spotfire.Dxp.Data.AddRowsSettings,
): Spotfire.Dxp.Data.ColumnsChangedResult
Adds rows from the columns retrieved from the dataSource using the settings in the settings parameter. Use Spotfire.Dxp.Data.DataManager.CreateFileDataSource|CreateFileDataSource(filePath) to create a data source from a file path.
Parameters
- dataSource: Spotfire.Dxp.Data.DataSource
  The data source to retrieve the new columns from.
- settings: Spotfire.Dxp.Data.AddRowsSettings
  The settings to use when adding the rows to the current columns.
Returns Spotfire.Dxp.Data.ColumnsChangedResult
Information about the changes that occured in the table.

Since
2.0

AddTransformation

AddTransformation(
transformation: Spotfire.Dxp.Data.DataTransformation,
): Spotfire.Dxp.Data.ColumnsChangedResult
Adds a transformation to the table. The transformation will be applied on the source columns in the table (i.e., the columns originating from a data source or the result of an add columns or add rows operation.) Calculated columns will not be affected.
Parameters
- transformation: Spotfire.Dxp.Data.DataTransformation
  The transformation.
Returns Spotfire.Dxp.Data.ColumnsChangedResult
Information about the changes that occured in the table.

Since
2.0

AddTransformations

AddTransformations(
    transformations: OrExplicit<
        System.Collections.Generic.IEnumerable<
            Spotfire.Dxp.Data.DataTransformation,
        >,
    >,
): Spotfire.Dxp.Data.ColumnsChangedResult
Adds a sequence of transformations to the table. The transformation will be applied on the source columns in the table (i.e., the columns originating from a data source or the result of an add columns or add rows operation.) Calculated columns will not be affected.
Parameters
- transformations: OrExplicit<
      System.Collections.Generic.IEnumerable<
          Spotfire.Dxp.Data.DataTransformation,
      >,
  >
  The transformations.
Returns Spotfire.Dxp.Data.ColumnsChangedResult
Information about the changes that occured in the table.

Since
2.0

CanReloadAllData

CanReloadAllData(): boolean
Gets a value indicating whether the data table can be reloaded using the Spotfire.Dxp.Data.DataTable.ReloadAllData method.

Returns boolean
True if the 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 the data table can be reloaded using the Spotfire.Dxp.Data.DataTable.ReloadLinkedData method.

Returns boolean
True if the data table can be reloaded; false otherwise.

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.

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GenerateSourceView

GenerateSourceView(): Spotfire.Dxp.Data.SourceView
Generates a Spotfire.Dxp.Data.SourceView representing Spotfire.Dxp.Data.DataOperations.DataOperations performed to construct this data table.

Returns Spotfire.Dxp.Data.SourceView
A generated Spotfire.Dxp.Data.SourceView.

Remark
The object returned is only valid as long as the data table structure is not modified, i.e. as long as the set of Spotfire.Dxp.Data.DataOperations.DataOperations is the same. Examples of invalidating modifications include adding rows/columns or transformations.

Since
2.0

GetDistinctRows

GetDistinctRows(
rowIndexes: Spotfire.Dxp.Data.IndexSet | null,
...valueCursors: Spotfire.Dxp.Data.DataValueCursor[],
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
Gets the distinct rows for the specified cursors. Note that this method is not supported for external data tables.
Parameters
- rowIndexes: Spotfire.Dxp.Data.IndexSet | null
  The row indexes to enumerate. May be null for all rows.
- ...valueCursors: Spotfire.Dxp.Data.DataValueCursor[]
  Specifies which columns to include in the enumeration. These are used to access the individual data values for each row. You need to specify at least one value cursor.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
An enumerator of the distinct rows in the subset. The order of the returned rows is not specified.

Remark
Note that the Index property on the DataRow will not return any valid values for this method.

Since
2.0

GetMethods

GetMethods(): System.Collections.Generic.IList<
Spotfire.Dxp.Data.Computations.IPublicMethod,
>
Gets the methods that can be used in expressions on this table.

Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.Computations.IPublicMethod>
The methods that can be used on this table.

Since
2.0

GetRows

GetRows(
...valueCursors: Spotfire.Dxp.Data.DataValueCursor[],
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
Enumerates all rows for the columns specified by the given valueCursors.
Parameters
- ...valueCursors: Spotfire.Dxp.Data.DataValueCursor[]
  Specifies what columns to include in the enumeration and are used to access the individual data values for each row.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
An enumeration of all rows.

Since
2.0
GetRows(
    rowIndexes: OrExplicit<
        System.Collections.Generic.IEnumerable<number | System.Int32>,
    >,
    ...valueCursors: Spotfire.Dxp.Data.DataValueCursor[],
): System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
Enumerates a subset of the rows for the columns specified by the given valueCursorss.
Parameters
- rowIndexes: OrExplicit<System.Collections.Generic.IEnumerable<number | System.Int32>>
  The row indexes to enumerate.
- ...valueCursors: Spotfire.Dxp.Data.DataValueCursor[]
  Specifies what columns to include in the enumeration and are used to access the individual data values for each row.
Returns System.Collections.Generic.IEnumerable<Spotfire.Dxp.Data.DataRow>
An enumeration of the rows in the subset.

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 the data table if the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

Since
2.0

ReloadAllData

ReloadAllData(): void
Reloads all data in this data table including 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

ReloadLinkedData

ReloadLinkedData(): void
Reloads only linked data in this data table.

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

RemoveRows

RemoveRows(rowMask: Spotfire.Dxp.Data.RowSelection): void
Remove rows from this table.
Parameters
- rowMask: Spotfire.Dxp.Data.RowSelection
  A row selection defining which rows to remove.
Returns void
Since
2.0

ReplaceData

ReplaceData(
dataSource: Spotfire.Dxp.Data.DataSource,
): Spotfire.Dxp.Data.ColumnsChangedResult
Replace the data in the table with the columns in the data source. Use Spotfire.Dxp.Data.DataManager.CreateFileDataSource|CreateFileDataSource(filePath) to create a data source from a file path.
Parameters
- dataSource: Spotfire.Dxp.Data.DataSource
  The data source to get the new data from.
Returns Spotfire.Dxp.Data.ColumnsChangedResult
Information about the changes that occured in the table.

Since
2.0

Select

Select(whereClause: string | System.String): Spotfire.Dxp.Data.RowSelection
Returns the rows that matches the where clause expression. The expression must be a boolean Spotfire expression.
Parameters
- whereClause: string | System.String
  A where clause expression.
Returns Spotfire.Dxp.Data.RowSelection
The rows that matches the expression.

Since
2.0

Extended capability 'LibraryWrite'

ExportDataToLibrary

ExportDataToLibrary(
libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem,
title: string | System.String,
): Spotfire.Dxp.Framework.Library.LibraryItem
Export the data in the data table as a data file in the library.
Parameters
- libraryItem: Spotfire.Dxp.Framework.Library.LibraryItem
  This library item is either the folder where the data file should be stored or a data file to overwrite.
- title: string | System.String
  The title of the file to store in the library.
Returns Spotfire.Dxp.Framework.Library.LibraryItem
The created library item.

Since
2.0

Class DataTable

Remark

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Extended capability 'LibraryWrite'

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

AutoCreateFilters

Returns boolean

Since

Parameters

Returns void

Columns

Returns Spotfire.Dxp.Data.DataColumnCollection

Since

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

HasValidPrimaryKey

Returns boolean

Since

Id

Returns System.Guid

Since

IsAttached

Returns boolean

Since

IsExternal

Returns boolean

Since

IsRefreshableByNeed

Returns boolean

Remark

Since

Name

Returns string

Since

Parameters

Returns void

NameEscapedForExpression

Returns string

Since

NeedsRefresh

Returns boolean

Since

PrimaryKey

Returns System.Collections.Generic.IList<Spotfire.Dxp.Data.DataColumn>

Since

Parameters

Returns void

Properties

Returns Spotfire.Dxp.Data.DataTableProperties

Since

Refreshing

Returns boolean

Remark

Since

RowCount

`Static`Equals