Class PropertyOutputBuilder

Represents a builder class for outputmappings that create a new table. Used as input in Spotfire.Dxp.Data.DataFunctions.DataFunctionOutputCollection.

Since

2.1

Hierarchy (View Summary)

DataFunctionOutputBuilder
- PropertyOutputBuilder

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

InputToAdaptSelectionsFrom PropertyName Transformations SetDataColumnProperty SetDataTableProperty SetDocumentProperty CreateDataColumnPropertyOutput CreateDataTablePropertyOutput CreateDocumentPropertyOutput

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

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

PropertyName

get PropertyName(): string
Gets the name of property to set. If there is no property with that name it will become auto created when the data function is run.

Returns string
Since
2.1

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

SetDataColumnProperty

SetDataColumnProperty(propertyName: string | String, column: DataColumn): void
Create a mapping to a column property.
Parameters
- propertyName: string | String
  The property name.
- column: DataColumn
  The data column.
Returns void
Since
2.1

SetDataTableProperty

SetDataTableProperty(propertyName: string | String, dataTable: DataTable): void
Create a mapping to a table property.
Parameters
- propertyName: string | String
  The property name.
- dataTable: DataTable
  The data table.
Returns void
Since
2.1

SetDocumentProperty

SetDocumentProperty(
propertyName: string | String,
dataManager: DataManager,
): void
Create a mapping to a document property.
Parameters
- propertyName: string | String
  The property name.
- dataManager: DataManager
  The data manager.
Returns void
Since
2.1

`Static`CreateDataColumnPropertyOutput

CreateDataColumnPropertyOutput(
propertyName: string | String,
dataColumn: DataColumn,
): PropertyOutputBuilder
Create a Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder where a data column property is used as output.
Parameters
- propertyName: string | String
  The name of the property to use as output.
- dataColumn: DataColumn
  The data column where the property should be set.
Returns PropertyOutputBuilder
The newly created Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder

Since
2.1

`Static`CreateDataTablePropertyOutput

CreateDataTablePropertyOutput(
propertyName: string | String,
dataTable: DataTable,
): PropertyOutputBuilder
Create a Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder where a datatable property is used as output.
Parameters
- propertyName: string | String
  The name of the property to use as output.
- dataTable: DataTable
  The data table where the property should be set.
Returns PropertyOutputBuilder
The newly created Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder

Since
2.1

`Static`CreateDocumentPropertyOutput

CreateDocumentPropertyOutput(
propertyName: string | String,
dataManager: DataManager,
): PropertyOutputBuilder
Create a Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder where a document property is used as output.
Parameters
- propertyName: string | String
  The name of the property to use as output.
- dataManager: DataManager
  The data manager.
Returns PropertyOutputBuilder
The newly created Spotfire.Dxp.Data.DataFunctions.PropertyOutputBuilder

Since
2.1

Class PropertyOutputBuilder

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

InputToAdaptSelectionsFrom

Returns InputParameter

Since

Parameters

Returns void

PropertyName

Returns string

Since

Transformations

Returns System.Collections.Generic.IList<DataTransformation>

Since

SetDataColumnProperty

Parameters

Returns void

Since

SetDataTableProperty

Parameters

Returns void

Since

SetDocumentProperty

Parameters

Returns void

Since

StaticCreateDataColumnPropertyOutput

Parameters

Returns PropertyOutputBuilder

Since

StaticCreateDataTablePropertyOutput

Parameters

Returns PropertyOutputBuilder

Since

StaticCreateDocumentPropertyOutput

Parameters

Returns PropertyOutputBuilder

Since

Settings

On This Page

`Static`Equals

`Static`CreateDataColumnPropertyOutput

`Static`CreateDataTablePropertyOutput

`Static`CreateDocumentPropertyOutput