Adds a reference line based on a given expression.
Namespace: Spotfire.Dxp.Application.VisualsAssembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)
Syntax
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: ReferenceLineThe 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
See Also