PersistentDataView Class

Spotfire 14.3 API Reference

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.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataPersistentDataView

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]
[PersistenceVersionAttribute(13, 0)]
public sealed class PersistentDataView : DocumentNode

The PersistentDataView type exposes the following members.

Constructors

	Name	Description
	PersistentDataView	Initializes a new instance of the PersistentDataView class. Create a new persistent data view. This is a wrapper class around a DataView which performs the creation of the view and the serialization.

Top

Properties

	Name	Description
	BaseSelectionReference	Gets or sets the selection that this view is based on. This selection defines which rows of the base table should be included when calculating the values. May be null.
	BaseTableReference	Gets or sets the table that the view is based on.
	ColumnExpressions	Gets or sets the column expressions. This is the same expression syntax as calculated columns. See the ColumnExpression class for utility methods in handling expressions.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataView	Gets the data view that is calculated from the other parameters.
	GroupByColumns	Gets or sets columns which are grouped by. The list may be empty. The columns has to be part of the baseTable/>.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	MarkingCombinationMethod	Gets or sets a value indicating how the data marking selections shall be combined to limit the data show by the visualization.
	Name	Gets or sets the name of the view.
	SortBy	Gets or sets a list of column aliases combined with sort order to sort by. The column aliases has to match aliases of the ColumnExpressions in this view. The list may not be null, and is not mutable so you cannot modify the returned list. If no sort by configuration is provided the view will be sorted by the group by columns.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	GetAdditionalSelections	Gets the additional selections that define which rows of the base table should be included when calculating the values. These selections are used in combination with the BaseSelectionReference.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	SetAdditionalSelections	Sets the additional selections that define which rows of the base table should be included when calculating the values. These selections are used in combination with the BaseSelectionReference.
	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

This is the only way to create a DataView and should be used even if the view does not need to be persisted. If a real persistence of the view is not needed then the persistent data view may be set to null after the DataView has been used.

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