Spotfire.Dxp.Data Namespace

This class describes the settings used when performing the AddColumns(DataSource, AddColumnsSettings) operation on a DataTable.

This class describes the settings used when performing the AddRows(DataSource, AddRowsSettings) operation on a DataTable.

Maps row indexes between a base view and a derived view. A base view is typically a DataTable and a derived view is a DataView.

Represents a value of datatype Binary. The inner representation of the data is not accessible directly, instead a BinaryLargeObject is created from a byte stream and the data is retrieved through a byte stream.

An instance of this class can be retrieved from a DataColumn using the AsT method when the column type of the DataColumn is Calculated. This class is used for modifying the calculated column.

Abstract class representing a calculation.

Contains property name constants for the public properties of Calculation.

This class describes an equality relation between two columns in different tables. A relation like '[Tbl1].[Column1] = Upper([Tbl2].[Column1])' is defined using two expressions '[Tbl1].[Column1]' and 'Upper([Tbl2].[Column1])'. These expressions are evaluated in the different source tables, so if one of the tables are external then you can use the methods provided by that external data source and if the table is not external then you can use the standard Spotfire expression language functions. Additionally you can also provide left and right transform expressions which are evaluated on top of the left/right expressions supporting all standard Spotfire expression language functions. These expression refer to the result of the corresponding expression using the name ValueColumnName. For example you need to perform "Upper" on Tbl2 but the external system doesn't support that method you can define left and right expressions like '[Tbl1].[Column1]' and '[Tbl2].[Column1]' but add additional transform expressions like '[Value]' and 'Upper([Value])'.

A collection of ColumnRelation objects.

The property names for ColumnRelationCollection.

This is a report on the changes in a DataTable after a large operation such as ReplaceData(DataSource) is performed. It should be used to notify the user of the changes.

This is a data column which is part of a data table and can be used to retrieve data on row values, hierarchies and properties. The data column implements the IDataColumn which is to be used for non-modification operations on the data column. This class has no public constructors, see the DataColumnCollection class for methods which create data columns.

Contains property name constants for the public properties of DataColumn.

This is a collection of DataColumn columns in a DataTable. This class is used to retrieve columns and to add new columns.

Contains property name constants for the public properties of DataColumnCollection.

Represents a collection of the properties in a column.

Contains predefined name constants for the standard column properties.

A data column signature is used to identify matching columns in the context of linked data. It contains certain key properties, such as the name, data type, and external id of a previously known column.

This is a DataSelection representing a filtering in the DataTables as a subset of the rows.

Contains property name constants for the public properties of DataFilteringSelection.

This a collection of the DataFilteringSelections. This collection can be retrieved from the DataManager.

Contains property name constants for the public properties of DataFilteringSelectionCollection.

Represents a flow of data from the DataSource through an ordered set of DataTransformation's.

This class is a builder that can be used to dynamically create a DataFlow instance.

A potentially multilevel index of a data column.

Represents a builder class to create detail information for the data history. The builder is used to add information to the data history for custom extensions such as DataTransformation, DataSource, Calculation, and so forth.

A single level in a DataHierarchy.

A collection of the levels in a DataHierarchy.

Captured error messages during load of (typically linked) data. This can be retrieved from the LoadReport.

A categorized message item.

A DataManager contains the data for an analysis.

This is a DataSelection representing a marking of rows in the DataTables.

Contains property name constants for the public properties of DataMarkingSelection.

This a collection of the DataMarkingSelection objects. This collection can be retrieved from the DataManager.

Contains property name constants for the public properties of DataMarkingSelectionCollection.

A node in a DataNodeCollection.

A collection of nodes in a hierarchy level.

Definition of a data property.

Contains property name constants for the public properties of DataProperty.

The DataProperty registry is part of the DataManager and contains the properties that can be defined in the analysis. All properties (metadata) that are set must be defined in this registry.

Contains property name constants for the public properties of DataPropertyRegistry.

Provides reading of a forward-only stream of data rows.

This class describes a relation between two DataTables. The relations are contained in a DataRelationCollection, use the Add(DataTable, DataTable, String) method to add new relations.

Contains property name constants for the public properties of DataRelation.

A collection of DataRelation objects.

Contains property name constants for the public properties of DataRelationCollection.

Flyweight row class used for iterating over a data table.

Class for sequential scanning through the rows of a data set defined by a collection of columns.

Represents a resettable iterator of rows values. It is used to retrieve data from a DataSource or DataTransformation.

Represents a column returned by a DataRowReader.

Represents a collection of the DataRowReaderColumns that a DataRowReader returns.

Container for data-related save settings. This class is set on the DataManager class and defines how the data should be stored when saving the document.

This is the base class for all selections. A selection is an object that defines a subset of rows as a RowSelection for all data tables in the document.

See the DataMarkingSelection and DataFilteringSelection for concrete classes.

Contains property name constants for the public properties of DataSelection.

Abstract class for data sources. Used when loading and saving linked data.

Represents an open connection to a data source.

A DataTable is a collection of columns and metadata.

Contains property name constants for the public properties of DataTable.

A collection of DataTable objects. The collection of data tables exists in the DataManager.

Contains property name constants for the public properties of DataTableCollection.

The collection of the properties (metadata) of a DataTable.

Save settings for a data table. This can be added or retrieved from the DataTableSettings list.

Represents a transformation of data, when data is imported from a DataSource it may optionally be transformed by one or more transformations. A transformation takes a DataRowReader as input and a DataRowReader as output with the transformed rows.

Represents a connected DataTransformation. The connection is created when the transformation is bound to a DataRowReader that is used as input to the transformation.

This class contains information about a Spotfire data type and the properties of that data type. This is an enumeration class with one static instance for each of the supported data types.

An abstract base class for flyweight data value containers. More precisely, a DataValue instance contains a value of a particular DataType, and thus every DataValue has a corresponding DataType. (This is not necessarily true for the methods marked Obsolete in this class.) Instances of the generic subclass are normally used, often explicitly, and this non-generic base class is provided only for convenience in contexts where the generic type is not known, or variable. Note that this class is intended as a flyweight, that is, as a reusable container. This means that it is not optimized for memory and is unsuitable for representing arrays or matrices of data values, where a separate DataValue instance is used for each cell. Consider using a more compact representation of the values for such purposes. The DataValue class is not serializable and should not be used for persistent storage.

Generic flyweight data value container.

A collection of the row values in a IDataColumn.

Non-generic cursor class for efficient enumeration of data values.

Generic cursor class for efficient enumeration of data values.

A class holding properties for a data value.

Represents a collection of data values that serves as input to produce a result value.

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.

Contains property name constants for the public properties of DataView.

Settings for how to display data column values in filters and categorical axes.

Property names for the DisplayValueSettings document node.

A wrapper class that holds a value that can occur in the column of a data table. The class provides equality and an ordering of the values even if they are of different underlying types. Values of the class can therefore be used in UndoableList and UndoableDictionary.

An instance of this class can be retrieved from a DataColumn using the AsT method when the column type of the DataColumn is Hierarchy. This class is used for modifying the hierarchy column.

This is a definition of a hierarchy.

This is a highlight selection, it changes when the user moves the mouse cursor over the plots. A highlight selection is a special kind of selection which should only be used from user interface code and the events from this selection can only be received by external event handlers.

Contains property name constants for the public properties of DataFilteringSelection.

A bitset-like class that represents a collection of indices, typically a subset of the rows in a IDataColumn or similar.

A generic mutable cursor class that should be used when reading data from a DataRowReader.

Provides static utility methods for validating and creating strings representing names.
These methods should be used when creating names for elements in the data manager, like a data table or a data column.

A mapping between the rows in the column/table and the nodes in a hierarchy level.

Represents a report containing error messages from a data loading phase.

This is a wrapper class around a DataView which performs the code for serializing the DataView since a data view is not possible to persist.

Contains property name constants for the public properties of PersistentDataView.

An instance of this class can be retrieved from a DataColumn using the AsT method when the column type of the DataColumn is Result. This class is used for modifying the result column.

Represents the metadata about the result from a data source, transformation or calculation. These properties are used to set properties on the resulting data table.

This is a representation of a selection of rows in a table. It is currently created from an enumeration of row indexes or IndexSet but may be extended in the future to support symbolic marking.

This class describes operations performed on a DataTable. The SourceView consists of DataOperations and the columns returned by AdditionalDataColumns.

An instance of this class can be retrieved from a DataColumn using the AsT method when the column type of the DataColumn is Tags. This class is used for modifying the tags column.

A Range represents a double-precision floating-point interval.

This is the interface for reading data from a column. You should not implement this interface. Use the ColumnBuilderT class to create columns.

This is the interface for creating data nodes.

Producer interface for data values, used with enumerators.

Validates an item of a specific DataType.

Validates an item of the specified type.

A delegate for executing a transformation and returning a DataRowReader.

Generic data value transform.

A delegate for executing query and returning a DataReader.

A delegate for executing query and returning a DataRowReader.

Specifies prompt modes for calculation executions.

Specifies the update behavior for calculations.

Enum for IDataColumn categories. The DataColumnType for an IDataColumn can be retrieved from the ColumnType property.

Attributes for a DataProperty. Custom data properties should almost always use DefaultAttributes.

The different classes that a DataProperty can belong to.

Defines how to combine data selections.

Enum for data selection operations.

Specifies the reset behavior of a DataSelection. This setting specifies what the value of a selection should be by default.

Specifies the scope of a DataSelection. Determines which tables are affected by a setting a selection.

Defines how a DataSource should prompt a user for settings when loading data.

Defines how display values in a data column are sorted in filters and categorical axes.

Determines how each level in the Hierarchy should relate to the next level.

Describes which join type that should be used when joining two tables into a new table. This is used in the AddColumnsSettings class to specify how the join should be performed.

Defines alternatives for visualization of empty data selections.

The behavior for propagation of filter selections between related tables. This is used in DataFilteringSelection.

Defines the order for a sort operation.