FittingModelCollectionAddHorizontalLine Method (String)

 Spotfire 14.7 API Reference
Adds a horizontal reference line. The position of the line is defined by the specified expression, for example "Avg(y)" or "1000.0".

Namespace:  Spotfire.Dxp.Application.Visuals.FittingModels
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 69.0.21424.2902 (69.0.21424.2902)
Syntax
C#
Copy
public ReferenceLineFittingModel AddHorizontalLine(
	string expression
)

Parameters

expression
Type: SystemString
The expression defining the position of the line.

Return Value

Type: ReferenceLineFittingModel
A ReferenceLineFittingModel.
Exceptions
ExceptionCondition
ArgumentNullException Thrown if the expression is null.
Examples
The following example shows how to add a horizontal average line.
C#
Copy
ScatterPlot plot = ...;
ReferenceLineFittingModel horizontal = plot.FittingModels.AddHorizontalLine("Avg([Y])");
Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

FittingModelCollection Class
AddHorizontalLine Overload
Spotfire.Dxp.Application.Visuals.FittingModels Namespace