ReferenceLineCollection.AddNew Method

ReferenceLineCollection AddNew Method

TIBCO Spotfire 6.5 API Reference

Adds a reference line based on a given expression.

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

Syntax

C++

Copy to Clipboard Print

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

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

Parameters

axis: Type: Spotfire.Dxp.Application.Visuals ScaleAxis
The axis on which the line will be rendered. Currenly only axes X and Y are supported.

expression: Type: System String
The expression for the reference line.

Return Value

Type: ReferenceLine
The newly created ReferenceLine object.

Exceptions

Exception	Condition
System ArgumentNullException	either of the parameters is null .
System ArgumentException	expression is empty or if axis does not belong to the plot which this call is being made on.
Spotfire.Dxp.Data.Exceptions ExpressionException	expression 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++

Copy to Clipboard Print

myPlot.ReferenceLines.Items.AddNew(myPlot.YAxis, "Avg([Y])");

myPlot.ReferenceLines.Items.AddNew(myPlot.YAxis, "Avg([Y])");

Version Information

Obsolete (compiler warning) in 6.5
Obsolete (compiler warning) in 6.0
Obsolete (compiler warning) in 5.5
Obsolete (compiler warning) in 5.0
Obsolete (compiler warning) in 4.5