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: 23.18.9504.3877 (23.18.9504.3877)
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: ReferenceLineThe newly created ReferenceLine object.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | either of the parameters is null . |
ArgumentException | expression is empty or if axis does not belong to the plot which this call is being made on. |
ExpressionException | expression is not valid, for example it refers to an axis other than axis it does not return a numeric result. |
Examples
C#
myPlot.ReferenceLines.Items.AddNew(myPlot.YAxis, "Avg([Y])");
Version Information
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