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

Class RowsOutputBuilder

Represents a builder class for creating a Spotfire.Dxp.Data.DataFunctions.RowsOutput for a Spotfire.Dxp.Data.DataFunctions.DataFunction. Used as input in Spotfire.Dxp.Data.DataFunctions.DataFunctionOutputCollection.

Since

2.1

Hierarchy (View Summary)

DataFunctionOutputBuilder
- RowsOutputBuilder

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor DataTable IgnoredColumns InputToAdaptSelectionsFrom Map NewRowSourceValue OriginalRowSourceValue RowSourceColumn Transformations

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DataFunctionOutputBuilder.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new RowsOutputBuilder(dataTable: DataTable): RowsOutputBuilder
Initializes a new instance of the Spotfire.Dxp.Data.DataFunctions.RowsOutputBuilder class.
Parameters
- dataTable: DataTable
  The table to add rows to.
Returns RowsOutputBuilder
Since
2.1

Overrides DataFunctionOutputBuilder.constructor

DataTable

get DataTable(): DataTable
Gets or sets the table to add rows to.

Returns DataTable
Since
2.1
set DataTable(value: DataTable): void
Parameters
- value: DataTable
Returns void

IgnoredColumns

get IgnoredColumns(): System.Collections.Generic.IList<DataColumnSignature>
Gets the columns not included in the mapping or the additional columns from the output that should be ignored.

Returns System.Collections.Generic.IList<DataColumnSignature>
Since
2.1

InputToAdaptSelectionsFrom

get InputToAdaptSelectionsFrom(): InputParameter
Gets or sets an input where this output can find selections to remap the output data with.

Returns InputParameter
Since
2.1

Inherited from DataFunctionOutputBuilder.InputToAdaptSelectionsFrom
set InputToAdaptSelectionsFrom(value: InputParameter): void
Parameters
- value: InputParameter
Returns void
Inherited from DataFunctionOutputBuilder.InputToAdaptSelectionsFrom

Map

get Map(): System.Collections.Generic.IDictionary<
DataColumnSignature,
DataColumnSignature,
>
Gets a map matching columns from the original table to columns in the output.

Returns System.Collections.Generic.IDictionary<DataColumnSignature, DataColumnSignature>
Since
2.1

NewRowSourceValue

get NewRowSourceValue(): string
Gets or sets the value that new elements in the row source column should get.

Returns string
Since
2.1
set NewRowSourceValue(value: string): void
Parameters
- value: string
Returns void

OriginalRowSourceValue

get OriginalRowSourceValue(): string
Gets or sets the value that the existing elements in the row source column should get.

Returns string
Since
2.1
set OriginalRowSourceValue(value: string): void
Parameters
- value: string
Returns void

RowSourceColumn

get RowSourceColumn(): string
Gets or sets the column in the table that will be created to indicate the source of the rows.

Returns string
Since
2.1
set RowSourceColumn(value: string): void
Parameters
- value: string
Returns void

Transformations

get Transformations(): System.Collections.Generic.IList<DataTransformation>
Gets the transformations that should be applied to the result.

Returns System.Collections.Generic.IList<DataTransformation>
Since
2.1

Inherited from DataFunctionOutputBuilder.Transformations