ReferenceLineCollectionAddNew Method TIBCO Spotfire 7.6 API Reference

Note: This API is now obsolete.

Adds a reference line based on a given expression.

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
[ObsoleteAttribute("Use FittingModels instead.")]
public ReferenceLine AddNew(
	ScaleAxis axis,
	string expression
)

Parameters

axis
Type: Spotfire.Dxp.Application.VisualsScaleAxis
The axis on which the line will be rendered. Currenly only axes X and Y are supported.
expression
Type: SystemString
The expression for the reference line.

Return Value

Type: ReferenceLine
The newly created ReferenceLine object.
Exceptions

ExceptionCondition
ArgumentNullException either of the parameters is null .
ArgumentExceptionexpression is empty or if axis does not belong to the plot which this call is being made on.
ExpressionExceptionexpression is not valid, for example it refers to an axis other than axis it does not return a numeric result.
Examples

To add an average line based on the average of the Y axis, call:
C#
myPlot.ReferenceLines.Items.AddNew(myPlot.YAxis, "Avg([Y])");
Version Information

Obsolete (compiler warning) in 7.6
Obsolete (compiler warning) in 7.5
Obsolete (compiler warning) in 7.0
Obsolete (compiler warning) in 6.5
Obsolete (compiler warning) in 6.0
Obsolete (compiler warning) in 5.5
Obsolete (compiler warning) in 5.0
See Also

Reference