Error (Plotly.NET)

Plotly.NET

Documentation for 4.2.0

Error Type

Namespace: Plotly.NET.TraceObjects
Assembly: Plotly.NET.dll
Base Type: DynamicObj
All Interfaces: IDynamicMetaObjectProvider

Error type inherits from dynamic object

Constructors

Constructor	Description
`Error()` Full Usage: `Error()` Returns: `Error`	Returns: `Error`

Static members

Static member Description

Static member	Description
`Error.init (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)` Full Usage: `Error.init (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)` Parameters: ?Visible : `bool` - Determines whether or not this set of error bars is visible. ?Type : `ErrorType` - Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`. ?Symmetric : `bool` - Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. ?Array : `seq<'a>` - Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. ?Arrayminus : `seq<'b>` - Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. ?Value : `float` - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. ?Valueminus : `float` - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars ?Traceref : `int` - ?Tracerefminus : `int` - ?Copy_ystyle : `bool` - ?Color : `Color` - Sets the stoke color of the error bars. ?Thickness : `float` - Sets the thickness (in px) of the error bars. ?Width : `float` - Sets the width (in px) of the cross-bar at both ends of the error bars. Returns: `Error`	Returns a new Error object with the given styling. ?Visible : `bool` Determines whether or not this set of error bars is visible. ?Type : `ErrorType` Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`. ?Symmetric : `bool` Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. ?Array : `seq<'a>` Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. ?Arrayminus : `seq<'b>` Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. ?Value : `float` Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. ?Valueminus : `float` Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars ?Traceref : `int` ?Tracerefminus : `int` ?Copy_ystyle : `bool` ?Color : `Color` Sets the stoke color of the error bars. ?Thickness : `float` Sets the thickness (in px) of the error bars. ?Width : `float` Sets the width (in px) of the cross-bar at both ends of the error bars. Returns: `Error`
`Error.style (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)` Full Usage: `Error.style (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)` Parameters: ?Visible : `bool` - Determines whether or not this set of error bars is visible. ?Type : `ErrorType` - Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`. ?Symmetric : `bool` - Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. ?Array : `seq<'a>` - Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. ?Arrayminus : `seq<'b>` - Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. ?Value : `float` - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. ?Valueminus : `float` - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars ?Traceref : `int` - ?Tracerefminus : `int` - ?Copy_ystyle : `bool` - ?Color : `Color` - Sets the stoke color of the error bars. ?Thickness : `float` - Sets the thickness (in px) of the error bars. ?Width : `float` - Sets the width (in px) of the cross-bar at both ends of the error bars. Returns: `Error -> Error`	Returns a function that applies the given style parameters to an Error object ?Visible : `bool` Determines whether or not this set of error bars is visible. ?Type : `ErrorType` Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`. ?Symmetric : `bool` Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars. ?Array : `seq<'a>` Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data. ?Arrayminus : `seq<'b>` Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data. ?Value : `float` Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars. ?Valueminus : `float` Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars ?Traceref : `int` ?Tracerefminus : `int` ?Copy_ystyle : `bool` ?Color : `Color` Sets the stoke color of the error bars. ?Thickness : `float` Sets the thickness (in px) of the error bars. ?Width : `float` Sets the width (in px) of the cross-bar at both ends of the error bars. Returns: `Error -> Error`


                
                  
                    
                      Error.init (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)

Full Usage:

Error.init (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)

Parameters:

?Visible : bool - Determines whether or not this set of error bars is visible.

?Type : ErrorType - Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.

?Symmetric : bool - Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.

?Array : seq<'a> - Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

?Arrayminus : seq<'b> - Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.

?Value : float - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.

?Valueminus : float - Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars

?Traceref : int -

?Tracerefminus : int -

?Copy_ystyle : bool -

?Color : Color - Sets the stoke color of the error bars.

?Thickness : float - Sets the thickness (in px) of the error bars.

?Width : float - Sets the width (in px) of the cross-bar at both ends of the error bars.

Returns: Error

Returns a new Error object with the given styling.

?Visible : bool: Determines whether or not this set of error bars is visible.
?Type : ErrorType: Determines the rule used to generate the error bars. If "constant`, the bar lengths are of a constant value. Set this constant in `value`. If "percent", the bar lengths correspond to a percentage of underlying data. Set this percentage in `value`. If "sqrt", the bar lengths correspond to the square of the underlying data. If "data", the bar lengths are set with data set `array`.
?Symmetric : bool: Determines whether or not the error bars have the same length in both direction (top/bottom for vertical bars, left/right for horizontal bars.
?Array : seq<'a>: Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.
?Arrayminus : seq<'b>: Sets the data corresponding the length of each error bar in the bottom (left) direction for vertical (horizontal) bars Values are plotted relative to the underlying data.
?Value : float: Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars.
?Valueminus : float: Sets the value of either the percentage (if `type` is set to "percent") or the constant (if `type` is set to "constant") corresponding to the lengths of the error bars in the bottom (left) direction for vertical (horizontal) bars
?Traceref : int
?Tracerefminus : int
?Copy_ystyle : bool
?Color : Color: Sets the stoke color of the error bars.
?Thickness : float: Sets the thickness (in px) of the error bars.
?Width : float: Sets the width (in px) of the cross-bar at both ends of the error bars.

Returns: Error


                
                  
                    
                      Error.style (?Visible, ?Type, ?Symmetric, ?Array, ?Arrayminus, ?Value, ?Valueminus, ?Traceref, ?Tracerefminus, ?Copy_ystyle, ?Color, ?Thickness, ?Width)