PersistentDataView Class

TIBCO Spotfire 7.6 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
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataPersistentDataView

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

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

Methods

	Name	Description
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableListT)	Creates an UndoableListT and assigns it to the specified field. The UndoableListT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableSetT)	Creates an UndoableSetT and assigns it to the specified field. The UndoableSetT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode)	Creates an UndoableCrossReferencePropertyT and assigns it to the specified field. The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoablePropertyT, T)	Creates an UndoablePropertyT and assigns it to the specified field. The UndoablePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue)	Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field. The UndoableDictionaryTKey, TValue will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field. The UndoableKeyedCollectionTKey, TNode will have the specified propertyName. (Inherited from DocumentNode.)
	CreateReadOnlyPropertyT	Creates a read-only property of type T and assigns it to the specified field. (Inherited from DocumentNode.)
	CreateRuntimeConstantT	Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT)	Obsolete. Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT)	Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	DeclareInternalEventHandlers	Override this method to declare handlers of internal events. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT)	Deserializes an UndoableCrossReferencePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT)	Deserializes an UndoableListT with value of type T stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT)	Deserializes an UndoablePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT)	Deserializes an UndoableSetT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue)	Deserializes an UndoableDictionaryTKey, TValue stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Deserializes an UndoableKeyedCollectionTKey, TNode stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializeReadOnlyPropertyT	Deserializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DuplicateSubtreeT	Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately. (Inherited from DocumentNode.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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.
	GetPersistedTypeName	Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (Inherited from DocumentNode.)
	GetPersistedVersion	Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (Inherited from DocumentNode.)
	GetService	Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set. (Inherited from Node.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InternalTransaction	Starts an internal transaction on the document model by executing the specified executor delegate. (Inherited from DocumentNode.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnConfigure	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnConfigured	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnReconfigure	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	OnReconfigured	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)	Serializes an Undoable*Property with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)	Serializes an UndoableList with values of type T storing it in info with key list.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)	Serializes an UndoableProperty with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)	Serializes an UndoableSet storing it in info with key given by the property name of the set. (Inherited from DocumentNode.)
	SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue)	Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary. (Inherited from DocumentNode.)
	SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode)	Serializes an UndoableKeyedCollectionTKey, TNode storing it in info with key given by the property name of the keyedCollection. (Inherited from DocumentNode.)
	SerializeReadOnlyPropertyT	Serializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	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.
	ValidateAttached	Validates that the node is attached. (Inherited from DocumentNode.)

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

Explicit Interface Implementations

	Name	Description
	IServiceProviderGetService	Implements IServiceProvider. (Inherited from Node.)
	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.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (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: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

Spotfire.Dxp.Data Namespace

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0See Also

Reference

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also