ForecastHoltWintersFittingModel Properties

Spotfire 14.3 API Reference

The ForecastHoltWintersFittingModel type exposes the following members.

Properties

  NameDescription
Public propertyAllowEmptyValueReplacement
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.
Public propertyAutomaticFrequency
Gets or sets a value indicating whether the frequency parameter is deduced from the visualization.
Public propertyConfidenceCurve
Gets the confidence curve.
Public propertyConfidenceLevel
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.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyEnabled
Gets or sets a value indicating whether this FittingModel is enabled.
(Inherited from FittingModel.)
Public propertyFittedCurve
Gets the fitted curve.
Public propertyForecastCurve
Gets the forecast curve.
Public propertyFrequency
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.
Public propertyFrequencyExpression
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.
Public propertyIndividualFittingModes
The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination.
(Inherited from FittingModel.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLevel
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.
Public propertyManualUpdate
Gets or sets a value indicating whether to use manual updates.
(Inherited from FittingModel.)
Public propertySeasonal
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.
Public propertySeasonalModelType
Gets or sets the seasonal parameter.
Public propertyTimePointsAhead
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.
Public propertyTimePointsAheadExpression
Gets or sets the number of time points in the future at which to predict the values of the time series
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTrend
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.
Public propertyTypeId
Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers.
(Inherited from FittingModel.)
Public propertyUseSeasonal
Gets or sets a value indicating whether the seasonal component should be included or not.
Public propertyUseTrend
Gets or sets a value indicating whether the trend component should be included or not.
Top
See Also

Reference