Class StraightLineFittingModel

The straight line fitting model defines a straight line that minimizes the sum-of-squares of the y-distances between the data and the line.

Remark

This class cannot be inherited. See the Spotfire.Dxp.Application.Extension.CustomFittingModel class for creating custom fitting models.

Since

2.0

Hierarchy (View Summary)

FittingModel
- StraightLineFittingModel

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Enabled IndividualFittingModes IsAttached Line ManualUpdate Transactions TypeId ForEachNodeInSubTree GetResultsDataSource Update

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

Context

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

Returns INodeContext
Since
2.0

Inherited from FittingModel.Context

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 straight line.

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

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

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from FittingModel.ForEachNodeInSubTree

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

Class StraightLineFittingModel

Remark

Since

Hierarchy (View Summary)

Implements

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

Context

Returns INodeContext

Since

Enabled

Returns boolean

Since

Parameters

Returns void

IndividualFittingModes

Returns IndividualFittingModes

Since

Parameters

Returns void

IsAttached

Returns boolean

Since

Line

Returns ReferenceCurve

Since

ManualUpdate

Returns boolean

Since

Parameters

Returns void

Transactions

Returns ITransactions

Since

TypeId

Returns TypeIdentifier

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetResultsDataSource

Returns DataSource

Since

Update

Returns void

Since

Settings

On This Page

`Static`Equals