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

Class ColumnValuesLine

Represents a computer of multilines from a pair of data columns.

Since

2.0

Hierarchy (View Summary)

FittingModel
- ColumnValuesLine

Implements

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from FittingModel.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

AffectAxisRanges

get AffectAxisRanges(): boolean
Gets or sets a value indicating whether this reference curve affects the axis ranges.

Returns boolean
Since
2.0
set AffectAxisRanges(value: boolean): void
Parameters
- value: boolean
Returns void

BreakOnEmpty

get BreakOnEmpty(): boolean
Gets or sets a value indicating whether the line should be split at empty values.

Returns boolean
Since
2.0
set BreakOnEmpty(value: boolean): void
Parameters
- value: boolean
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from FittingModel.Context

DataTableReference

get DataTableReference(): DataTable
Gets or sets the data table.

Returns DataTable
Since
2.0
set DataTableReference(value: DataTable): void
Parameters
- value: DataTable
Returns void

Enabled

get Enabled(): boolean
Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel is enabled.

Returns boolean
Since
2.0

Inherited from FittingModel.Enabled
set Enabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FittingModel.Enabled

IndividualFittingModes

get IndividualFittingModes(): IndividualFittingModes
The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.

Returns IndividualFittingModes
Since
2.0

Inherited from FittingModel.IndividualFittingModes
set IndividualFittingModes(value: IndividualFittingModes): void
Parameters
- value: IndividualFittingModes
Returns void
Inherited from FittingModel.IndividualFittingModes

IsAttached

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

Returns boolean
Since
2.0

Inherited from FittingModel.IsAttached

Line

get Line(): ReferenceCurve
Gets the ReferenceCurve representing the ColumnValuesLine.

Returns ReferenceCurve
Since
2.0

ManualUpdate

get ManualUpdate(): boolean
Gets or sets a value indicating whether to use manual updates.

Returns boolean
Since
2.0

Inherited from FittingModel.ManualUpdate
set ManualUpdate(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from FittingModel.ManualUpdate

SortColumnReference

get SortColumnReference(): null | DataColumn
Gets or sets the optional column used to sort the x- and y-values before conecting the points to a multiline.

Returns null | DataColumn
Since
2.0
set SortColumnReference(value: null | DataColumn): void
Parameters
- value: null | DataColumn
Returns void

Transactions

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

Returns ITransactions
Since
2.0

Inherited from FittingModel.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.

Returns TypeIdentifier
Since
2.0

Inherited from FittingModel.TypeId

XColumnReference

get XColumnReference(): DataColumn
Gets or sets the column containing the x-values.

Returns DataColumn
Since
2.0
set XColumnReference(value: DataColumn): void
Parameters
- value: DataColumn
Returns void

YColumnReference

get YColumnReference(): DataColumn
Gets or sets the column containing the y-values.

Returns DataColumn
Since
2.0
set YColumnReference(value: DataColumn): void
Parameters
- value: DataColumn
Returns void

GetResultsDataSource

GetResultsDataSource(): DataSource
Gets the current results as a data source.

Returns DataSource
The data source.

Since
2.0

Inherited from FittingModel.GetResultsDataSource

Update

Update(): void
Forces an update of this fitting model. Only allowed if Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel.ManualUpdate is set to true.

Returns void
Since
2.0

Inherited from FittingModel.Update