Class SourceView

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

Since

2.0

Hierarchy (view full)

Spotfire.Object
- SourceView

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AdditionalDataColumns LastOperation OperationsSupportingTransformations AddColumnsAfter AddRowsAfter AddTransformationAfter AddTransformationsAfter CanAddColumnsAfter CanAddRowsAfter CanAddTransformationsAfter CanRemoveOperation GetAllOperations RemoveOperation

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 Object.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 Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

AdditionalDataColumns

get AdditionalDataColumns(): System.Collections.Generic.IReadOnlyList<DataColumn>
Gets the additional Spotfire.Dxp.Data.DataColumns added to the final data table after Spotfire.Dxp.Data.SourceView.LastOperation.

Returns System.Collections.Generic.IReadOnlyList<DataColumn>
Since
2.0

LastOperation

get LastOperation(): DataOperation
Gets the last Spotfire.Dxp.Data.DataOperations.DataOperation that has been performed on the data table.

Returns DataOperation
Since
2.0

OperationsSupportingTransformations

get OperationsSupportingTransformations(): System.Collections.Generic.IReadOnlyList<DataOperationSupportingTransformations>
Gets all Spotfire.Dxp.Data.DataOperations.DataOperations that can have Spotfire.Dxp.Data.DataTransformations, using the utility class Spotfire.Dxp.Data.DataOperations.DataOperationSupportingTransformations.

Returns System.Collections.Generic.IReadOnlyList<DataOperationSupportingTransformations>
Since
2.0

AddColumnsAfter

AddColumnsAfter(operation, dataSource, settings): SourceView
Adds columns after the specified operation.
Parameters
- operation: DataOperation
  The operation that the added columns should be added after.
- dataSource: DataSource
  The data source to add columns from.
- settings: AddColumnsSettings
  The settings to use when adding the columns.
Returns SourceView
The resulting source view containing the newly added Spotfire.Dxp.Data.DataOperations.AddColumnsOperation.

Since
2.0

AddRowsAfter

AddRowsAfter(operation, dataSource, settings): SourceView
Adds rows after the specified operation.
Parameters
- operation: DataOperation
  The operation that the added rows should be added after.
- dataSource: DataSource
  The data source to add rows from.
- settings: AddRowsSettings
  The settings to use when adding the rows.
Returns SourceView
The resulting source view containing the newly added Spotfire.Dxp.Data.DataOperations.AddRowsOperation.

Since
2.0

AddTransformationAfter

AddTransformationAfter(operation, transformation): SourceView
Adds a transformation after the specified operation.
Parameters
- operation: DataOperation
  The operation to add transformations after.
- transformation: DataTransformation
  The transformation to add.
Returns SourceView
The resulting source view containing the newly added Spotfire.Dxp.Data.DataOperations.DataTransformationsOperation.

Since
2.0

AddTransformationsAfter

AddTransformationsAfter(operation, transformations): SourceView
Adds transformations after the specified operation.
Parameters
- operation: DataOperation
  The operation to add transformations after.
- transformations: OrExplicit<System.Collections.Generic.IEnumerable<DataTransformation>>
  The transformations to add.
Returns SourceView
The resulting source view containing the newly added Spotfire.Dxp.Data.DataOperations.DataTransformationsOperation.

Since
2.0

CanAddColumnsAfter

CanAddColumnsAfter(operation): boolean
Checks whether it is possible to add columns after the specified operation.
Parameters
- operation: DataOperation
  The operation to add columns after.
Returns boolean
true if columns can be added after the operation; otherwise false.

Since
2.0

CanAddRowsAfter

CanAddRowsAfter(operation): boolean
Checks whether it is possible to add rows after the specified operation.
Parameters
- operation: DataOperation
  The operation to add rows after.
Returns boolean
true if rows can be added after the operation; otherwise false.

Since
2.0

CanAddTransformationsAfter

CanAddTransformationsAfter(operation): boolean
Checks whether it is possible to add transformations after the specified operation.
Parameters
- operation: DataOperation
  The operation to add transformations after.
Returns boolean
true if transformations can be added after the operation; otherwise false.

Since
2.0

CanRemoveOperation

CanRemoveOperation(operation): boolean
Checks whether the specified Spotfire.Dxp.Data.DataOperations.DataOperation can be removed.
Parameters
- operation: DataOperation
  The operation to remove.
Returns boolean
true if it can be removed; otherwise false.

Since
2.0

GetAllOperations

GetAllOperations<T>(typeT): System.Collections.Generic.IReadOnlyList<T>
Gets all Spotfire.Dxp.Data.DataOperations.DataOperations of a certain type.
Type Parameters
- T extends DataOperation
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns System.Collections.Generic.IReadOnlyList<T>
A list of Spotfire.Dxp.Data.DataOperations.DataOperations.

Since
2.0

RemoveOperation

RemoveOperation(operation): SourceView
Removes the specified Spotfire.Dxp.Data.DataOperations.DataOperation. As a side effect, other operations may be removed as well, e.g., an add rows operation will implicitly be removed when removing either of its source inputs.
Parameters
- operation: DataOperation
  The operation to remove.
Returns SourceView
The resulting source view.

Since
2.0

Class SourceView

Since

Hierarchy (view full)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

AdditionalDataColumns

Returns System.Collections.Generic.IReadOnlyList<DataColumn>

Since

LastOperation

Returns DataOperation

Since

OperationsSupportingTransformations

Returns System.Collections.Generic.IReadOnlyList<DataOperationSupportingTransformations>

Since

AddColumnsAfter

Parameters

Returns SourceView

Since

AddRowsAfter

Parameters

Returns SourceView

Since

AddTransformationAfter

Parameters

Returns SourceView

Since

AddTransformationsAfter

Parameters

Returns SourceView

Since

CanAddColumnsAfter

Parameters

Returns boolean

Since

CanAddRowsAfter

Parameters

Returns boolean

Since

CanAddTransformationsAfter

Parameters

Returns boolean

Since

CanRemoveOperation

Parameters

Returns boolean

Since

GetAllOperations

Type Parameters

Parameters

Returns System.Collections.Generic.IReadOnlyList<T>

Since

RemoveOperation

Parameters

Returns SourceView

Since

Settings

On This Page

`Static`Equals