Class ResultAccumulator

Accumulator used to add the results of a calculation.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- ResultAccumulator

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AddColumns AddTable Dispose

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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: any): 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: T2, type: TypeRef<T1>): 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: any, objB: any): 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

AddColumns

AddColumns(
    id: CalculationResultsIdentifier,
    table: DataTable,
    builder: ColumnBuilder,
): void
Adds a column to an existing table or replaces it if it already exist.
Parameters
- id: CalculationResultsIdentifier
  A unique identifier for this result.
- table: DataTable
  The Spotfire.Dxp.Data.DataTable to insert the columns in.
- builder: ColumnBuilder
  A Spotfire.Dxp.Data.Columns.ColumnBuilder containing the values that the column should contain. Column name will be made unique within this Spotfire.Dxp.Data.DataTable.
Returns void
Remark
This method can be called multiple times with new builders to add to the same id within a calculation. In that case they all need to reference the same table.

Since
2.0
AddColumns(
    id: CalculationResultsIdentifier,
    table: DataTable,
    columns: OrExplicit<System.Collections.Generic.IEnumerable<ColumnBuilder>>,
): void
Adds columns to an existing table or replaces them if they already exist.
Parameters
- id: CalculationResultsIdentifier
  A unique identifier for this result.
- table: DataTable
  The Spotfire.Dxp.Data.DataTable to insert the columns in.
- columns: OrExplicit<System.Collections.Generic.IEnumerable<ColumnBuilder>>
  The Spotfire.Dxp.Data.Columns.ColumnBuilder instances containing the values that the columns should contain. Column names will be made unique within this Spotfire.Dxp.Data.DataTable.
Returns void
Remark
This method can be called multiple times with new builders to add to the same id within a calculation. In that case they all need to reference the same table.

Since
2.0

AddTable

AddTable(
    id: CalculationResultsIdentifier,
    tableName: string | String,
    builder: ColumnBuilder,
): void
Adds a completely new Spotfire.Dxp.Data.DataTable consisting of the columns provided here or replaces them if the table already exists.
Parameters
- id: CalculationResultsIdentifier
  A unique identifier for this result.
- tableName: string | String
  The name of the Spotfire.Dxp.Data.DataTable to create. If the table exists and is given another name it will be renamed. If the name is not unique it will be made unique.
- builder: ColumnBuilder
  A Spotfire.Dxp.Data.Columns.ColumnBuilder containing the values that the column should contain.
Returns void
Remark
Column name will be made unique. This method can be called multiple times with new builders to add to the same id within a calculation. In that case they all need to reference the same table.

Since
2.0
AddTable(
    id: CalculationResultsIdentifier,
    tableName: string | String,
    newColumns: OrExplicit<
        System.Collections.Generic.IEnumerable<ColumnBuilder>,
    >,
): void
Adds a completely new Spotfire.Dxp.Data.DataTable consisting of the columns provided here or replaces them if the table already exists.
Parameters
- id: CalculationResultsIdentifier
  A unique identifier for this result.
- tableName: string | String
  The name of the Spotfire.Dxp.Data.DataTable to create. If the table exists and is given another name it will be renamed. If the name is not unique it will be made unique.
- newColumns: OrExplicit<System.Collections.Generic.IEnumerable<ColumnBuilder>>
  Spotfire.Dxp.Data.Columns.ColumnBuilder instances containing the values that the columns should contain. Column names will be made unique within the table.
Returns void
Remark
This method can be called multiple times with new builders to add to the same id within a calculation. In that case they all need to reference the same table.

Since
2.0

Dispose

Dispose(): void
Disposes this Spotfire.Dxp.Application.Calculations.ResultAccumulator

Returns void
Since
2.0

Class ResultAccumulator

Since

Hierarchy (View Summary)

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

AddColumns

Parameters

Returns void

Remark

Since

Parameters

Returns void

Remark

Since

AddTable

Parameters

Returns void

Remark

Since

Parameters

Returns void

Remark

Since

Dispose

Returns void

Since

Settings

On This Page

`Static`Equals