FittingModelCollectionAddVerticalLine Method (String)

TIBCO Spotfire 11.4 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: 51.0.16121.3915 (51.0.16121.3915)
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: 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also

Reference