DataView Class

Spotfire 14.3 API Reference

A DataView is a derived view which values are derived from a DataTable. It cannot be added to the DataTableCollection. A DataView cannot be serialized to the document.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataDataTable
        Spotfire.Dxp.DataDataView

Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[NotPersistedAttribute]
public sealed class DataView : DataTable

The DataView type exposes the following members.

Properties

	Name	Description
	AutoCreateFilters	Gets or sets a value indicating whether to automatically create filters for new columns. (Inherited from DataTable.)
	BaseMap	Gets the mapping between the rows in this view and in the BaseTable.
	BaseTable	Gets the DataTable that this view is based on.
	Columns	Gets the collection of the columns that are part of this data table. (Inherited from DataTable.)
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	HasValidPrimaryKey	Gets a value indicating whether the table has a valid primary key or not. (Inherited from DataTable.)
	Id	Gets a unique identifier for this table. (Inherited from DataTable.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsExternal	Gets a value indicating whether the data in this table is kept external. (Inherited from DataTable.)
	IsRefreshable	Obsolete. Gets a value indicating whether this table is refreshable, that is, it supports Refresh calls. (Inherited from DataTable.)
	IsRefreshableByNeed	Gets a value indicating whether this table is refreshable by need, that is, it supports RefreshOnDemandData calls and uses the NeedsRefresh property to indicate if refresh is needed. (Inherited from DataTable.)
	IsValid	Gets a value indicating whether this view is valid or not.
	Name	Gets or sets the name of this table. (Inherited from DataTable.)
	NameEscapedForExpression	Gets the name of the table escaped for usage in an expression. This is a utility method which uses EscapeIdentifier(String). (Inherited from DataTable.)
	NeedsRefresh	Gets a value indicating whether this table needs to be refreshed (by calling RefreshOnDemandData). (Inherited from DataTable.)
	PrimaryKey	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. (Inherited from DataTable.)
	Properties	Gets the properties describing this table. (Inherited from DataTable.)
	Refreshing	Gets a value indicating whether the data table is refreshing. (Inherited from DataTable.)
	RowCount	Gets the number of rows in the columns in this table. All columns in a DataTable have the same number of rows. (Inherited from DataTable.)
	ShowColumnMatchPrompt	Gets or sets a value indicating whether to show a prompt for matching columns when data has been replaced. (Inherited from DataTable.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddColumns	Adds columns from the columns retrieved from the dataSource using the settings in the settings parameter. Use CreateFileDataSource(String) to create a data source from a file path. (Inherited from DataTable.)
	AddRows	Adds rows from the columns retrieved from the dataSource using the settings in the settings parameter. Use CreateFileDataSource(String) to create a data source from a file path. (Inherited from DataTable.)
	AddTransformation	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. (Inherited from DataTable.)
	AddTransformations	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. (Inherited from DataTable.)
	CanReloadAllData	Gets a value indicating whether the data table can be reloaded using the ReloadAllData method. (Inherited from DataTable.)
	CanReloadLinkedData	Gets a value indicating whether the data table can be reloaded using the ReloadLinkedData method. (Inherited from DataTable.)
	ExportDataToLibrary	Export the data in the data table as a data file in the library. (Inherited from DataTable.)
	GenerateSourceView	Generates a SourceView representing DataOperations performed to construct this data table. (Inherited from DataTable.)
	GetDistinctRows	Gets the distinct rows for the specified cursors. Note that this method is not supported for external data tables. (Inherited from DataTable.)
	GetMethods	Gets the methods that can be used in expressions on this table. (Inherited from DataTable.)
	GetRows(DataValueCursor)	Enumerates all rows for the columns specified by the given valueCursors. (Inherited from DataTable.)
	GetRows(IEnumerableInt32, DataValueCursor)	Enumerates a subset of the rows for the columns specified by the given Copy valueCursors s. (Inherited from DataTable.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Refresh	Obsolete. Refreshes this table to be up-to-date with the current settings. This will reload data from the DataSource or recalculate depending on the type of table. (Inherited from DataTable.)
	RefreshOnDemandData	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. (Inherited from DataTable.)
	RefreshOnDemandData(Action)	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. (Inherited from DataTable.)
	ReloadAllData	Reloads all data in this data table including data sources set to store their data. (Inherited from DataTable.)
	ReloadLinkedData	Reloads only linked data in this data table. (Inherited from DataTable.)
	RemoveRows	Remove rows from this table. (Inherited from DataTable.)
	ReplaceData	Replace the data in the table with the columns in the data source. Use CreateFileDataSource(String) to create a data source from a file path. (Inherited from DataTable.)
	Select	Returns the rows that matches the where clause expression. The expression must be a boolean Spotfire expression. (Inherited from DataTable.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

It is not possible to create a DataView directly, instead the PersistentDataView class can be used to handle the creation.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Data Namespace