FittingModelCollection Class

Spotfire 14.3 API Reference

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

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseFittingModel
        Spotfire.Dxp.Application.Visuals.FittingModelsFittingModelCollection

Namespace: Spotfire.Dxp.Application.Visuals.FittingModels
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(17, 0)]
public sealed class FittingModelCollection : DocumentNodeListBase<FittingModel>

The FittingModelCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of elements contained in this instance. (Inherited from DocumentNodeListBaseT.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the element at the specified index. (Inherited from DocumentNodeListBaseT.)
	LabelFont	Obsolete. Gets or sets the label font for lines and curves.
	LabelFontMetadata	Gets or sets the label font metadata for lines and curves.
	LegendItem	Gets the legend item.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddColumnValuesLine	Adds a line or multiline. The points of the line are defined from the values of a pair of columns.
	AddCurve(String)	Adds a curve. The curve is defined by the specified expression, for example "5.0*sin(x) + 2.5".
	AddCurve(DataTable, String)	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.
	AddForecastHoltWinters	Adds a Holt Winters forecast with default settings to the collection.
	AddHorizontalLine(String)	Adds a horizontal reference line. The position of the line is defined by the specified expression, for example "Avg(y)" or "1000.0".
	AddHorizontalLine(DataTable, String)	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.
	AddNew(Type)	Adds a new fitting model of the specified type.
	AddNew(TypeIdentifier)	Adds a new fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers.
	AddNewT	Adds a new fitting model of the specified type.
	AddStraightLineFit	Adds a straight line that minimizes the sum-of-squares of the y-distances between the data and the line.
	AddVerticalLine(String)	Adds a vertical reference line. The position of the line is defined by the expression, for example "Avg(x)" or "1000.0".
	AddVerticalLine(DataTable, String)	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.
	Clear	Removes all fitting models from this collection.
	Contains	Determines whether the specified value is in this collection. (Inherited from DocumentNodeListBaseT.)
	GetEnumerator	Returns an enumerator that iterates through this collection. (Inherited from DocumentNodeListBaseT.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified value and returns the zero-based index of the first occurrence within this collection. (Inherited from DocumentNodeListBaseT.)
	Remove	Removes the specified fitting model from this collection.
	ToArray	Copies the elements of the collection to a new array. (Inherited from DocumentNodeListBaseT.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from DocumentNodeListBaseT.)
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals.FittingModels Namespace