Class FittingModelCollection

Collection of FittingModels. Contains methods to add and remove FittingModels and Curves.

Since

2.0

Hierarchy (view full)

DocumentNodeListBase<FittingModel>
- FittingModelCollection

Implements

Methods

Cast

Cast<T1, T2>(this, type): 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 DocumentNodeListBase.Cast

Equals

Equals(obj): 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 DocumentNodeListBase.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNodeListBase.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNodeListBase.ToString

TryCast

TryCast<T1, T2>(this, type): 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 DocumentNodeListBase.TryCast

[iterator]

[iterator](): Iterator<FittingModel, any, undefined>
Returns Iterator<FittingModel, any, undefined>
Overrides DocumentNodeListBase.[iterator]

`Static`Equals

Equals(objA, objB): 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 DocumentNodeListBase.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | Int32, FittingModel>

Gets the element at the specified index.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index.

Since

2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Context

Count

get Count(): number
Gets the number of elements contained in this instance.

Returns number
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Count

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.IsAttached

LabelFontMetadata

get LabelFontMetadata(): FontMetadata
Gets or sets the label font metadata for lines and curves.

Returns FontMetadata
Since
2.0
set LabelFontMetadata(value): void
Parameters
- value: FontMetadata
Returns void

LegendItem

get LegendItem(): LegendFittingModelCollectionItem
Gets the legend item.

Returns LegendFittingModelCollectionItem
Since
2.0

Transactions

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

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Transactions

AddColumnValuesLine

AddColumnValuesLine(dataTable, xValuesColumn, yValuesColumn): ColumnValuesLine
Adds a line or multiline. The points of the line are defined from the values of a pair of columns.
Parameters
- dataTable: DataTable
  The data table containing the columns
- xValuesColumn: DataColumn
  A column containing the x-values.
- yValuesColumn: DataColumn
  A column containing the y-values.
Returns ColumnValuesLine
A Spotfire.Dxp.Application.Visuals.FittingModels.ColumnValuesLine fitting model.

Since
2.0

AddCurve

AddCurve(expression): ReferenceCurveFittingModel
Adds a curve. The curve is defined by the specified expression, for example "5.0*sin(x) + 2.5".
Parameters
- expression: string | String
  The expression defining the curve.
Returns ReferenceCurveFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceCurveFittingModel.

Since
2.0
AddCurve(dataTable, expression): ReferenceCurveFittingModel
Adds a curve. The curve is defined by the specified expression, for example "a + b*x", where a and b are columns in the specified data table.
Parameters
- dataTable: DataTable
  The data table. May be null.
- expression: string | String
  The expression defining the curve.
Returns ReferenceCurveFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceCurveFittingModel.

Since
2.0

AddForecastHoltWinters

AddForecastHoltWinters(): ForecastHoltWintersFittingModel
Adds a Holt Winters forecast with default settings to the collection.

Returns ForecastHoltWintersFittingModel
The newly added Spotfire.Dxp.Application.Visuals.FittingModels.ForecastHoltWintersFittingModel.

Since
2.0

AddHorizontalLine

AddHorizontalLine(expression): ReferenceLineFittingModel
Adds a horizontal reference line. The position of the line is defined by the specified expression, for example "Avg(y)" or "1000.0".
Parameters
- expression: string | String
  The expression defining the position of the line.
Returns ReferenceLineFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceLineFittingModel.

Since
2.0
AddHorizontalLine(dataTable, expression): ReferenceLineFittingModel
Adds a horizontal reference line. The position of the line is defined by the expression, for example "Avg(y)". The expression is evaluated using the columns in the specified data table.
Parameters
- dataTable: DataTable
  The data table. May be null.
- expression: string | String
  The expression defining the position of the line.
Returns ReferenceLineFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceLineFittingModel.

Since
2.0

AddNew

AddNew(fittingModelType): FittingModel
Adds a new fitting model of the specified type.
Parameters
- fittingModelType: Type
  The type of the fitting model.
Returns FittingModel
The newly created fitting model.

Since
2.0
AddNew(typeIdentifier): FittingModel
Adds a new fitting model. The type identifiers for the built-in fitting models are defined in Spotfire.Dxp.Application.Visuals.FittingModels.FittingModelTypeIdentifiers.
Parameters
- typeIdentifier: TypeIdentifier
  The type identifer of the fitting model.
Returns FittingModel
The newly created fitting model.

Since
2.0
AddNew<T>(typeT): JsType<T>
Adds a new fitting model of the specified type.
Type Parameters
- T extends FittingModel
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns JsType<T>
Since
2.0

AddStraightLineFit

AddStraightLineFit(): StraightLineFittingModel
Adds a straight line that minimizes the sum-of-squares of the y-distances between the data and the line.

Returns StraightLineFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.StraightLineFittingModel.

Since
2.0

AddVerticalLine

AddVerticalLine(expression): ReferenceLineFittingModel
Adds a vertical reference line. The position of the line is defined by the expression, for example "Avg(x)" or "1000.0".
Parameters
- expression: string | String
  The expression defining the position of the line.
Returns ReferenceLineFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceLineFittingModel.

Since
2.0
AddVerticalLine(dataTable, expression): ReferenceLineFittingModel
Adds a vertical reference line. The position of the line is defined by the expression which is evaluated using the columns in the specified data table.
Parameters
- dataTable: DataTable
  The data table. May be null.
- expression: string | String
  The expression defining the position of the line with references to columns in the data table.
Returns ReferenceLineFittingModel
A Spotfire.Dxp.Application.Visuals.FittingModels.ReferenceLineFittingModel.

Since
2.0

Clear

Clear(): void
Removes all fitting models from this collection.

Returns void
Since
2.0

Contains

Contains(value): boolean
Determines whether the specified value is in this collection.
Parameters
- value: FittingModel
  The object to locate in this collection. The value can be null.
Returns boolean
true if value is found in this collection; otherwise, false.

Since
2.0

Inherited from DocumentNodeListBase.Contains

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<FittingModel>
Returns an enumerator that iterates through this collection.

Returns System.Collections.Generic.IEnumerator<FittingModel>
An System.Collections.Generic.IEnumerator for this collection.

Since
2.0

Inherited from DocumentNodeListBase.GetEnumerator

IndexOf

IndexOf(value): number
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
Parameters
- value: FittingModel
  The object to locate. The value can be null.
Returns number
The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

Since
2.0

Inherited from DocumentNodeListBase.IndexOf

Remove

Remove(model): boolean
Removes the specified fitting model from this collection.
Parameters
- model: FittingModel
  The fitting model to remove.
Returns boolean
Since
2.0

ToArray

ToArray(): TypedArray<FittingModel>
Copies the elements of the collection to a new array.

Returns TypedArray<FittingModel>
An array containing the elements.

Since
2.0

Inherited from DocumentNodeListBase.ToArray

Class FittingModelCollection

Since

Hierarchy (view full)

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

[iterator]

Returns Iterator<FittingModel, any, undefined>

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

LabelFontMetadata

Returns FontMetadata

Since

Parameters

Returns void

LegendItem

Returns LegendFittingModelCollectionItem

Since

Transactions

Returns ITransactions

Since

AddColumnValuesLine

Parameters

Returns ColumnValuesLine

Since

AddCurve

Parameters

Returns ReferenceCurveFittingModel

Since

Parameters

Returns ReferenceCurveFittingModel

Since

AddForecastHoltWinters

Returns ForecastHoltWintersFittingModel

Since

AddHorizontalLine

Parameters

Returns ReferenceLineFittingModel

Since

Parameters

Returns ReferenceLineFittingModel

Since

AddNew

Parameters

Returns FittingModel

Since

Parameters

Returns FittingModel

`Static`Equals

`Readonly`Item