Line (Plotly.NET)

Plotly.NET

Documentation for 4.2.0

Line Type

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

The line object determines the style of the line in various aspect of plots such as a line connecting datums, outline of layout objects, etc..

Constructors

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

Static members

Static member Description

Static member	Description
`Line.init (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)` Full Usage: `Line.init (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)` Parameters: ?BackOff : `BackOff` - Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous". ?AutoColorScale : `bool` - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. ?CAuto : `bool` - Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. ?CMax : `float` - Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. ?CMid : `float` - Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. ?CMin : `float` - Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. ?Color : `Color` - Sets the line color. ?ColorAxis : `SubPlotId` - Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. ?Colorscale : `Colorscale` - Sets the line colorscale ?ReverseScale : `bool` - Reverses the color mapping if true. ?ShowScale : `bool` - Whether or not to show the color bar ?ColorBar : `ColorBar` - Sets the colorbar. ?Dash : `DrawingStyle` - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?Shape : `Shape` - Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. ?Simplify : `bool` - Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected. ?Smoothing : `float` - Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape). ?Width : `float` - Sets the line width (in px). ?MultiWidth : `seq<float>` - Sets the individual line width (in px). ?OutlierColor : `Color` - Sets the color of the outline of outliers ?OutlierWidth : `float` - Sets the width of the outline of outliers Returns: `Line`	Returns a new Line object with the given styling. ?BackOff : `BackOff` Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous". ?AutoColorScale : `bool` Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. ?CAuto : `bool` Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. ?CMax : `float` Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. ?CMid : `float` Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. ?CMin : `float` Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. ?Color : `Color` Sets the line color. ?ColorAxis : `SubPlotId` Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. ?Colorscale : `Colorscale` Sets the line colorscale ?ReverseScale : `bool` Reverses the color mapping if true. ?ShowScale : `bool` Whether or not to show the color bar ?ColorBar : `ColorBar` Sets the colorbar. ?Dash : `DrawingStyle` Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?Shape : `Shape` Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. ?Simplify : `bool` Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected. ?Smoothing : `float` Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape). ?Width : `float` Sets the line width (in px). ?MultiWidth : `seq<float>` Sets the individual line width (in px). ?OutlierColor : `Color` Sets the color of the outline of outliers ?OutlierWidth : `float` Sets the width of the outline of outliers Returns: `Line`
`Line.style (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)` Full Usage: `Line.style (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)` Parameters: ?BackOff : `BackOff` - Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous". ?AutoColorScale : `bool` - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. ?CAuto : `bool` - Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. ?CMax : `float` - Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. ?CMid : `float` - Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. ?CMin : `float` - Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. ?Color : `Color` - Sets the line color. ?ColorAxis : `SubPlotId` - Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. ?Colorscale : `Colorscale` - Sets the line colorscale ?ReverseScale : `bool` - Reverses the color mapping if true. ?ShowScale : `bool` - Whether or not to show the color bar ?ColorBar : `ColorBar` - Sets the colorbar. ?Dash : `DrawingStyle` - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?Shape : `Shape` - Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. ?Simplify : `bool` - Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected. ?Smoothing : `float` - Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape). ?Width : `float` - Sets the line width (in px). ?MultiWidth : `seq<float>` - Sets the individual line width (in px). ?OutlierColor : `Color` - Sets the color of the outline of outliers ?OutlierWidth : `float` - Sets the width of the outline of outliers Returns: `Line -> Line`	Returns a function that applies the given styles to a Line object. ?BackOff : `BackOff` Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous". ?AutoColorScale : `bool` Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed. ?CAuto : `bool` Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user. ?CMax : `float` Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well. ?CMid : `float` Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`. ?CMin : `float` Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well. ?Color : `Color` Sets the line color. ?ColorAxis : `SubPlotId` Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis. ?Colorscale : `Colorscale` Sets the line colorscale ?ReverseScale : `bool` Reverses the color mapping if true. ?ShowScale : `bool` Whether or not to show the color bar ?ColorBar : `ColorBar` Sets the colorbar. ?Dash : `DrawingStyle` Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px"). ?Shape : `Shape` Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes. ?Simplify : `bool` Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected. ?Smoothing : `float` Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape). ?Width : `float` Sets the line width (in px). ?MultiWidth : `seq<float>` Sets the individual line width (in px). ?OutlierColor : `Color` Sets the color of the outline of outliers ?OutlierWidth : `float` Sets the width of the outline of outliers Returns: `Line -> Line`


                
                  
                    
                      Line.init (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)

Full Usage:

Line.init (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)

Parameters:

?BackOff : BackOff - Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".

?AutoColorScale : bool - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.

?CAuto : bool - Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.

?CMax : float - Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.

?CMid : float - Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.

?CMin : float - Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.

?Color : Color - Sets the line color.

?ColorAxis : SubPlotId - Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.

?Colorscale : Colorscale - Sets the line colorscale

?ReverseScale : bool - Reverses the color mapping if true.

?ShowScale : bool - Whether or not to show the color bar

?ColorBar : ColorBar - Sets the colorbar.

?Dash : DrawingStyle - Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").

?Shape : Shape - Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

?Simplify : bool - Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.

?Smoothing : float - Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).

?Width : float - Sets the line width (in px).

?MultiWidth : seq<float> - Sets the individual line width (in px).

?OutlierColor : Color - Sets the color of the outline of outliers

?OutlierWidth : float - Sets the width of the outline of outliers

Returns: Line

Returns a new Line object with the given styling.

?BackOff : BackOff: Sets the line back off from the end point of the nth line segment (in px). This option is useful e.g. to avoid overlap with arrowhead markers. With "auto" the lines would trim before markers if `marker.angleref` is set to "previous".
?AutoColorScale : bool: Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `line.colorscale`. Has an effect only if in `line.color`is set to a numerical array. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
?CAuto : bool: Determines whether or not the color domain is computed with respect to the input data (here in `line.color`) or the bounds set in `line.cmin` and `line.cmax` Has an effect only if in `line.color`is set to a numerical array. Defaults to `false` when `line.cmin` and `line.cmax` are set by the user.
?CMax : float: Sets the upper bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmin` must be set as well.
?CMid : float: Sets the mid-point of the color domain by scaling `line.cmin` and/or `line.cmax` to be equidistant to this point. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color`. Has no effect when `line.cauto` is `false`.
?CMin : float: Sets the lower bound of the color domain. Has an effect only if in `line.color`is set to a numerical array. Value should have the same units as in `line.color` and if set, `line.cmax` must be set as well.
?Color : Color: Sets the line color.
?ColorAxis : SubPlotId: Sets a reference to a shared color axis. References to these shared color axes are "coloraxis", "coloraxis2", "coloraxis3", etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
?Colorscale : Colorscale: Sets the line colorscale
?ReverseScale : bool: Reverses the color mapping if true.
?ShowScale : bool: Whether or not to show the color bar
?ColorBar : ColorBar: Sets the colorbar.
?Dash : DrawingStyle: Sets the dash style of lines. Set to a dash type string ("solid", "dot", "dash", "longdash", "dashdot", or "longdashdot") or a dash length list in px (eg "5px,10px,2px,2px").
?Shape : Shape: Determines the line shape. With "spline" the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.
?Simplify : bool: Simplifies lines by removing nearly-collinear points. When transitioning lines, it may be desirable to disable this so that the number of points along the resulting SVG path is unaffected.
?Smoothing : float: Has an effect only if `shape` is set to "spline" Sets the amount of smoothing. "0" corresponds to no smoothing (equivalent to a "linear" shape).
?Width : float: Sets the line width (in px).
?MultiWidth : seq<float>: Sets the individual line width (in px).
?OutlierColor : Color: Sets the color of the outline of outliers
?OutlierWidth : float: Sets the width of the outline of outliers

Returns: Line


                
                  
                    
                      Line.style (?BackOff, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?ColorAxis, ?Colorscale, ?ReverseScale, ?ShowScale, ?ColorBar, ?Dash, ?Shape, ?Simplify, ?Smoothing, ?Width, ?MultiWidth, ?OutlierColor, ?OutlierWidth)