Class DataTable

A DataTable is a collection of columns and metadata.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AutoCreateFilters Columns Context HasValidPrimaryKey Id IsAttached IsExternal IsRefreshableByNeed Name NameEscapedForExpression NeedsRefresh PrimaryKey Properties Refreshing RowCount ShowColumnMatchPrompt Transactions AddColumns AddRows AddTransformation AddTransformations CanReloadAllData CanReloadLinkedData GenerateSourceView GetDistinctRows GetMethods GetRows RefreshOnDemandData ReloadAllData ReloadLinkedData RemoveRows ReplaceData Select

Extended capability 'LibraryWrite'

ExportDataToLibrary

Methods

Cast

  • Cast<T1, T2>(this, type): 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

    Returns T1

Equals

  • Equals(obj): 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

    Returns null | T1

StaticEquals

  • Equals(objA, objB): 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.

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): void

  • Parameters

    • value: boolean

    Returns void

Columns

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

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(): Guid

  • Gets a unique identifier for this table.

    Returns Guid

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsExternal

  • get IsExternal(): boolean

  • Gets a value indicating whether the data in this table is kept external.

    Returns boolean

    Since

    2.0

IsRefreshableByNeed

Name

  • get Name(): string

  • Gets or sets the name of this table.

    Returns string

    Since

    2.0

  • set Name(value): 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

PrimaryKey

Properties

Refreshing

  • get Refreshing(): boolean

  • Gets a value indicating whether the data table is refreshing.

    Returns boolean

    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): void

  • Parameters

    • value: boolean

    Returns void

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

AddColumns

  • AddColumns(dataSource, settings): 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: DataSource

      The data source to retrieve the new columns from.

    • settings: AddColumnsSettings

      The settings to use when adding the columns to the current table.

    Returns ColumnsChangedResult

    Information about the changes that occured in the table.

    Since

    2.0

AddRows

  • AddRows(dataSource, settings): 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: DataSource

      The data source to retrieve the new columns from.

    • settings: AddRowsSettings

      The settings to use when adding the rows to the current columns.

    Returns ColumnsChangedResult

    Information about the changes that occured in the table.

    Since

    2.0

AddTransformation

  • AddTransformation(transformation): 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

    Returns ColumnsChangedResult

    Information about the changes that occured in the table.

    Since

    2.0

AddTransformations

  • AddTransformations(transformations): 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

    Returns 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.

    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.

    Since

    2.0

GenerateSourceView

GetDistinctRows

  • GetDistinctRows(rowIndexes, ...valueCursors): System.Collections.Generic.IEnumerable<DataRow>

  • Gets the distinct rows for the specified cursors. Note that this method is not supported for external data tables.

    Parameters

    • rowIndexes: null | IndexSet

      The row indexes to enumerate. May be null for all rows.

    • Rest...valueCursors: 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<DataRow>

    An enumerator of the distinct rows in the subset. The order of the returned rows is not specified.

    Since

    2.0

GetMethods

GetRows

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

    Since

    2.0

ReloadAllData

  • ReloadAllData(): void

  • Reloads all data in this data table including data sources set to store their data.

    Returns void

    Since

    2.0

ReloadLinkedData

  • ReloadLinkedData(): void

  • Reloads only linked data in this data table.

    Returns void

    Since

    2.0

RemoveRows

  • RemoveRows(rowMask): void

  • Remove rows from this table.

    Parameters

    • rowMask: RowSelection

      A row selection defining which rows to remove.

    Returns void

    Since

    2.0

ReplaceData

  • ReplaceData(dataSource): 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: DataSource

      The data source to get the new data from.

    Returns ColumnsChangedResult

    Information about the changes that occured in the table.

    Since

    2.0

Select

  • Select(whereClause): RowSelection

  • Returns the rows that matches the where clause expression. The expression must be a boolean Spotfire expression.

    Parameters

    • whereClause: string | String

      A where clause expression.

    Returns RowSelection

    The rows that matches the expression.

    Since

    2.0

Extended capability 'LibraryWrite'

ExportDataToLibrary

  • ExportDataToLibrary(libraryItem, title): LibraryItem

  • Export the data in the data table as a data file in the library.

    Parameters

    • libraryItem: LibraryItem

      This library item is either the folder where the data file should be stored or a data file to overwrite.

    • title: string | String

      The title of the file to store in the library.

    Returns LibraryItem

    The created library item.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability
Extended capability 'LibraryWrite'