FittingModelCollectionAddHorizontalLine Method (DataTable, String)

 Spotfire 14.3 API Reference
Adds a horizontal reference line. The position of the line is defined by the expression, for example "Avg(y)". The expression is evaluated using the columns in the specified data table.

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#
Copy
public ReferenceLineFittingModel AddHorizontalLine(
	DataTable dataTable,
	string expression
)

Parameters

dataTable
Type: Spotfire.Dxp.DataDataTable
The data table. May be null.
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.
Remarks
As of version 3.3, any columns to be used for labels and tooltips must be specified by the DataTableDetailItemsExpression property.
Examples
The following example shows how to add horizontal lines at values found in a table.
C#
Copy
ScatterPlot plot = ...;
DataTable dataTable = ...;
ReferenceLineFittingModel horizontal = plot.FittingModels.AddHorizontalLine(dataTable, "[Value]");
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

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