ForecastHoltWintersFittingModel Class

Spotfire 14.3 API Reference

A model contining the parameters for a Holt-Winters forecast. Usually applied to time series data, but it can be used with any discrete set of repeated measurements.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.FittingModelsFittingModel
        Spotfire.Dxp.Application.Visuals.FittingModelsForecastHoltWintersFittingModel

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(13, 0)]
public sealed class ForecastHoltWintersFittingModel : FittingModel

The ForecastHoltWintersFittingModel type exposes the following members.

Properties

	Name	Description
	AllowEmptyValueReplacement	Gets or sets a value indicating whether this Holt Winters model allows interpolation to replace missing values. Setting this to true will mean that an empty value in the time series will be replaced by linear interpolation between the values before and after it. If there are multiple empty values in a row then no curve fit is computed. Setting this value to false will mean that if empty values are found in the time series, no curve fit is computed.
	AutomaticFrequency	Gets or sets a value indicating whether the frequency parameter is deduced from the visualization.
	ConfidenceCurve	Gets the confidence curve.
	ConfidenceLevel	Gets or sets the confidence level for the prediction intervals. Must be within the half-open unit interval [0, 1), but is typically close to 1.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Enabled	Gets or sets a value indicating whether this FittingModel is enabled. (Inherited from FittingModel.)
	FittedCurve	Gets the fitted curve.
	ForecastCurve	Gets the forecast curve.
	Frequency	Gets or sets the frequency (the number of observations per sampling period). For example, monthly data have frequency=12. This must be greater than 1 to fit a seasonal component. This is a convenience wrapper of FrequencyExpression. If this property is read when preprocessor expression does not evaluate to a positive integer, -1 is returned.
	FrequencyExpression	Gets or sets the frequency expression (the number of observations per sampling period). For example, monthly data have frequency=12. This string is preprocessed and should evaluate to a positive integer. This must be greater than 1 to fit a seasonal component.
	IndividualFittingModes	The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination. (Inherited from FittingModel.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Level	Gets or sets the level (alpha) parameter of Holt-Winters specifying how to smooth the level component. Must be within the half-open unit interval (0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of alpha.
	ManualUpdate	Gets or sets a value indicating whether to use manual updates. (Inherited from FittingModel.)
	Seasonal	Gets or sets the seasonal (gamma) parameter of Holt-Winters specifying how to smooth the seasonal component. Must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of gamma.
	SeasonalModelType	Gets or sets the seasonal parameter.
	TimePointsAhead	Gets or sets the number of time points in the future at which to predict the values of the time series. This is a convenience wrapper of TimePointsAheadExpression. If this property is read when the preprocessor expression does not evaluate to a positive integer, -1 is returned.
	TimePointsAheadExpression	Gets or sets the number of time points in the future at which to predict the values of the time series
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Trend	Gets or sets the trend (beta) parameter of Holt-Winters specifying how to smooth the trend component. Must be within the unit interval [0, 1]. A small value means that older values in x are weighted more heavily. Values near 1.0 mean that the latest value has more weight. NULL means that the HoltWinters function should find the optimal value of beta.
	TypeId	Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers. (Inherited from FittingModel.)
	UseSeasonal	Gets or sets a value indicating whether the seasonal component should be included or not.
	UseTrend	Gets or sets a value indicating whether the trend component should be included or not.

Top

Methods

	Name	Description
	GetResultsDataSource	Gets the current results as a data source. (Inherited from FittingModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Forces an update of this fitting model. Only allowed if ManualUpdate is set to true. (Inherited from FittingModel.)

Top

Explicit Interface Implementations

	Name	Description
	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

Remarks

This class cannot be inherited. See the CustomFittingModel class for creating custom fitting models.

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