FittingModelCollectionAddVerticalLine Method (String)

Spotfire 14.3 API Reference
Adds a vertical reference line. The position of the line is defined by the expression, for example "Avg(x)" or "1000.0".

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

C#
public ReferenceLineFittingModel AddVerticalLine(
	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 vertical average line.
C#
ScatterPlot plot = ...;
ReferenceLineFittingModel vertical = plot.FittingModels.AddVerticalLine("Avg([X])");
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
See Also

Reference