About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class DataManager

A DataManager contains the data for an analysis.

Since

2.0

Hierarchy (view full)

DocumentNode
- DataManager

Implements

Index

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

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.

Inherited from DocumentNode.Equals

Default capability

AllRows

get AllRows(): DataSelection
Gets a Spotfire.Dxp.Data.DataSelection which is always full for all Spotfire.Dxp.Data.DataTable objects.

Returns DataSelection
Since
2.0

ColumnRelations

get ColumnRelations(): ColumnRelationCollection
Gets the collection of column relations.

Returns ColumnRelationCollection
Since
2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

DataFunctions

get DataFunctions(): DataFunctionCollection
Gets the data functions.

Returns DataFunctionCollection
Since
2.0

ExpressionFunctions

get ExpressionFunctions(): DataFunctionExpressionFunctionCollection
Gets the expression functions.

Returns DataFunctionExpressionFunctionCollection
Since
2.0

Filterings

get Filterings(): DataFilteringSelectionCollection
Gets a collection of the filtering selections that the data manager contains.

Returns DataFilteringSelectionCollection
Since
2.0

Highlight

get Highlight(): HighlightSelection
Gets the highlight selection

Returns HighlightSelection
Since
2.0

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

LoadReport

get LoadReport(): DataLoadReport
Gets the Spotfire.Dxp.Data.DataLoadReport to retrieve information on changes that occured the Spotfire.Dxp.Data.DataManager was loaded using linked data.

Returns DataLoadReport
Since
2.0

Markings

get Markings(): DataMarkingSelectionCollection
Gets a collection of the marking selections that the data manager contains.

Returns DataMarkingSelectionCollection
Since
2.0

Properties

get Properties(): DataPropertyRegistry
Gets the data property registry. This registry is used to modify the definition of metadata properties.

Returns DataPropertyRegistry
Since
2.0

Relations

get Relations(): DataRelationCollection
Gets the collection of relations.

Returns DataRelationCollection
Since
2.0

SaveSettings

get SaveSettings(): DataSaveSettings
Gets or sets the settings that should be used when saving the data in the Spotfire.Dxp.Data.DataManager.

Returns DataSaveSettings
Since
2.0
set SaveSettings(value): void
Parameters
- value: DataSaveSettings
Returns void

Tables

get Tables(): DataTableCollection
Gets a collection of the tables that the data manager contains. A data table is created from calculation or a data source.

Returns DataTableCollection
Since
2.0

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

CreateDataWriter

CreateDataWriter(typeId): DataWriter
Creates the data writer given the typeId.
Parameters
- typeId: TypeIdentifier
  The type identifier for the registered data writer.
Returns DataWriter
A data writer; returns null if no data writer was found.

Since
2.0