TraceStyle Type

Namespace: Plotly.NET
Assembly: Plotly.NET.dll
Base Type: obj

Contains general, visualization-unspecific functions to style Trace objects. These functions are used internally to style traces of Chart objects. Users should usually be pointed to the API layer provided by the `Chart` module/object first. Visualization-specific equivalents are suffixed with the respective trace subtype, e.g. `TraceStyle2D`

Constructors

Constructor Description

TraceStyle()

Full Usage: TraceStyle()

Returns: TraceStyle

Returns: TraceStyle

Static members

Static member Description

TraceStyle.Domain(?X, ?Y, ?Row, ?Column)

Full Usage: TraceStyle.Domain(?X, ?Y, ?Row, ?Column)

Parameters:
Returns: 'T -> 'T

Returns a function that applies the given styles to the trace's domain object.

?X : Range
?Y : Range
?Row : int
?Column : int
Returns: 'T -> 'T

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

Full Usage: TraceStyle.Line(?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: 'T -> 'T

Returns a function that applies the given styles to the trace's line object. Overwrites attributes with the same name that are already set.

?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: 'T -> 'T

TraceStyle.Marker(?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Full Usage: TraceStyle.Marker(?Angle, ?AngleRef, ?AutoColorScale, ?CAuto, ?CMax, ?CMid, ?CMin, ?Color, ?Colors, ?ColorAxis, ?ColorBar, ?Colorscale, ?CornerRadius, ?Gradient, ?Outline, ?MaxDisplayed, ?Opacity, ?MultiOpacity, ?Pattern, ?ReverseScale, ?ShowScale, ?Size, ?MultiSize, ?SizeMin, ?SizeMode, ?SizeRef, ?StandOff, ?MultiStandOff, ?Symbol, ?MultiSymbol, ?Symbol3D, ?MultiSymbol3D, ?OutlierColor, ?OutlierWidth)

Parameters:
    ?Angle : float - Sets the marker angle in respect to `angleref`.
    ?AngleRef : AngleRef - Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.
    ?AutoColorScale : bool - Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.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 `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.
    ?CMax : float - Sets the upper bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmin` must be set as well.
    ?CMid : float - Sets the mid-point of the color domain by scaling `marker.cmin` and/or `marker.cmax` to be equidistant to this point. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color`. Has no effect when `marker.cauto` is `false`.
    ?CMin : float - Sets the lower bound of the color domain. Has an effect only if in `marker.color`is set to a numerical array. Value should have the same units as in `marker.color` and if set, `marker.cmax` must be set as well.
    ?Color : Color - Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.
    ?Colors : seq<Color> - Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.
    ?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.
    ?ColorBar : ColorBar - Sets the marker's color bar.
    ?Colorscale : Colorscale - Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.
    ?CornerRadius : int - Sets the maximum rounding of corners (in px).
    ?Gradient : Gradient - Sets the marker's gradient
    ?Outline : Line - Sets the marker's outline.
    ?MaxDisplayed : int - Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.
    ?Opacity : float - Sets the marker opacity.
    ?MultiOpacity : seq<float> - Sets the individual marker opacity.
    ?Pattern : Pattern - Sets the pattern within the marker.
    ?ReverseScale : bool - Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.
    ?ShowScale : bool - Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.
    ?Size : int - Sets the marker's size.
    ?MultiSize : seq<int> - Sets the individual marker's size.
    ?SizeMin : int - Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.
    ?SizeMode : MarkerSizeMode - Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.
    ?SizeRef : int - Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.
    ?StandOff : float - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?MultiStandOff : seq<float> - Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.
    ?Symbol : MarkerSymbol - Sets the marker symbol.
    ?MultiSymbol : seq<MarkerSymbol> - Sets the individual marker symbols.
    ?Symbol3D : MarkerSymbol3D - Sets the marker symbol for 3d traces.
    ?MultiSymbol3D : seq<MarkerSymbol3D> - Sets the individual marker symbols for 3d traces.
    ?OutlierColor : Color - Sets the color of the outlier sample points.
    ?OutlierWidth : int - Sets the width of the outlier sample points.

Returns: 'T -> 'T

Returns a function that applies the given styles to the trace's marker object. Overwrites attributes with the same name that are already set.

?Angle : float

Sets the marker angle in respect to `angleref`.

?AngleRef : AngleRef

Sets the reference for marker angle. With "previous", angle 0 points along the line from the previous point to this one. With "up", angle 0 points toward the top of the screen.

?AutoColorScale : bool

Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `marker.colorscale`. Has an effect only if in `marker.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 `marker.color`) or the bounds set in `marker.cmin` and `marker.cmax` Has an effect only if in `marker.color`is set to a numerical array. Defaults to `false` when `marker.cmin` and `marker.cmax` are set by the user.

?CMax : float

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

?CMid : float

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

?CMin : float

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

?Color : Color

Sets the marker color. It accepts either a specific color or an array of numbers that are mapped to the colorscale relative to the max and min values of the array or relative to `marker.cmin` and `marker.cmax` if set.

?Colors : seq<Color>

Sets the color of each sector. If not specified, the default trace color set is used to pick the sector colors.

?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.

?ColorBar : ColorBar

Sets the marker's color bar.

?Colorscale : Colorscale

Sets the colorscale. Has an effect only if colors is set to a numerical array. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` may be a palette name string of the following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

?CornerRadius : int

Sets the maximum rounding of corners (in px).

?Gradient : Gradient

Sets the marker's gradient

?Outline : Line

Sets the marker's outline.

?MaxDisplayed : int

Sets a maximum number of points to be drawn on the graph. "0" corresponds to no limit.

?Opacity : float

Sets the marker opacity.

?MultiOpacity : seq<float>

Sets the individual marker opacity.

?Pattern : Pattern

Sets the pattern within the marker.

?ReverseScale : bool

Reverses the color mapping if true. Has an effect only if in `marker.color`is set to a numerical array. If true, `marker.cmin` will correspond to the last color in the array and `marker.cmax` will correspond to the first color.

?ShowScale : bool

Determines whether or not a colorbar is displayed for this trace. Has an effect only if in `marker.color`is set to a numerical array.

?Size : int

Sets the marker's size.

?MultiSize : seq<int>

Sets the individual marker's size.

?SizeMin : int

Has an effect only if `marker.size` is set to a numerical array. Sets the minimum size (in px) of the rendered marker points.

?SizeMode : MarkerSizeMode

Has an effect only if `marker.size` is set to a numerical array. Sets the rule for which the data in `size` is converted to pixels.

?SizeRef : int

Has an effect only if `marker.size` is set to a numerical array. Sets the scale factor used to determine the rendered size of marker points. Use with `sizemin` and `sizemode`.

?StandOff : float

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?MultiStandOff : seq<float>

Moves the marker away from the data point in the direction of `angle` (in px). This can be useful for example if you have another marker at this location and you want to point an arrowhead marker at it.

?Symbol : MarkerSymbol

Sets the marker symbol.

?MultiSymbol : seq<MarkerSymbol>

Sets the individual marker symbols.

?Symbol3D : MarkerSymbol3D

Sets the marker symbol for 3d traces.

?MultiSymbol3D : seq<MarkerSymbol3D>

Sets the individual marker symbols for 3d traces.

?OutlierColor : Color

Sets the color of the outlier sample points.

?OutlierWidth : int

Sets the width of the outlier sample points.

Returns: 'T -> 'T

TraceStyle.Selection(?SelectedPoints, ?Selected, ?Unselected)

Full Usage: TraceStyle.Selection(?SelectedPoints, ?Selected, ?Unselected)

Parameters:
    ?SelectedPoints : seq<'a> - Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
    ?Selected : TraceSelection - Sets the style of selected points of this trace.
    ?Unselected : TraceSelection - Sets the style of unselected points of this trace.

Returns: 'T -> 'T

Returns a function that applies the given styles to the trace's selection.

?SelectedPoints : seq<'a>

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.

?Selected : TraceSelection

Sets the style of selected points of this trace.

?Unselected : TraceSelection

Sets the style of unselected points of this trace.

Returns: 'T -> 'T

TraceStyle.TextLabel(?Text, ?MultiText, ?TextPosition, ?MultiTextPosition, ?TextTemplate, ?MultiTextTemplate, ?HoverText, ?MultiHoverText, ?HoverInfo, ?HoverTemplate, ?MultiHoverTemplate, ?TextFont)

Full Usage: TraceStyle.TextLabel(?Text, ?MultiText, ?TextPosition, ?MultiTextPosition, ?TextTemplate, ?MultiTextTemplate, ?HoverText, ?MultiHoverText, ?HoverInfo, ?HoverTemplate, ?MultiHoverTemplate, ?TextFont)

Parameters:
    ?Text : 'a - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
    ?MultiText : seq<'a> - Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.
    ?TextPosition : TextPosition - Sets the positions of the `text` elements with respects to the (x,y) coordinates.
    ?MultiTextPosition : seq<TextPosition> - Sets the positions of the `text` elements with respects to the (x,y) coordinates.
    ?TextTemplate : string - Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.
    ?MultiTextTemplate : seq<string> - Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.
    ?HoverText : string - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
    ?MultiHoverText : seq<string> - Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.
    ?HoverInfo : HoverInfo - Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
    ?HoverTemplate : string - Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``.
    ?MultiHoverTemplate : seq<string> - Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``.
    ?TextFont : Font - Sets the text font of this trace.

Returns: 'T -> 'T

Returns a function that applies the given styles to the trace's text items.

?Text : 'a

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

?MultiText : seq<'a>

Sets text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. If trace `hoverinfo` contains a "text" flag and "hovertext" is not set, these elements will be seen in the hover labels.

?TextPosition : TextPosition

Sets the positions of the `text` elements with respects to the (x,y) coordinates.

?MultiTextPosition : seq<TextPosition>

Sets the positions of the `text` elements with respects to the (x,y) coordinates.

?TextTemplate : string

Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

?MultiTextTemplate : seq<string>

Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

?HoverText : string

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

?MultiHoverText : seq<string>

Sets hover text elements associated with each (x,y) pair. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y) coordinates. To be seen, trace `hoverinfo` must contain a "text" flag.

?HoverInfo : HoverInfo

Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

?HoverTemplate : string

Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``.

?MultiHoverTemplate : seq<string>

Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}" as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When showing info for several points, "xother" will be added to those with different x positions from the first point. An underscore before or after "(x|y)other" will add a space on that side, only when this field is shown. Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. variable `norm` Anything contained in tag `` is displayed in the secondary box, for example "{fullData.name}". To hide the secondary box completely, use an empty tag ``.

?TextFont : Font

Sets the text font of this trace.

Returns: 'T -> 'T

TraceStyle.TraceInfo(?Name, ?Visible, ?ShowLegend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle)

Full Usage: TraceStyle.TraceInfo(?Name, ?Visible, ?ShowLegend, ?LegendRank, ?LegendGroup, ?LegendGroupTitle)

Parameters:
    ?Name : string - Sets the name of the chart's trace(s). When the chart is a multichart (it contains multiple traces), the name is suffixed by '_%i' where %i is the index of the trace.
    ?Visible : Visible - Whether or not the chart's traces are visible
    ?ShowLegend : bool - Determines whether or not item(s) corresponding to this chart's trace(s) is/are shown in the legend.
    ?LegendRank : int - Sets the legend rank for the chart's trace(s). Items and groups with smaller ranks are presented on top/left side while with `"reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.
    ?LegendGroup : string - Sets the legend group for the chart's trace(s). Traces part of the same legend group hide/show at the same time when toggling legend items.
    ?LegendGroupTitle : Title - Sets the title for the chart's trace legend group

Returns: 'T -> 'T

Sets trace information on the given trace.

?Name : string

Sets the name of the chart's trace(s). When the chart is a multichart (it contains multiple traces), the name is suffixed by '_%i' where %i is the index of the trace.

?Visible : Visible

Whether or not the chart's traces are visible

?ShowLegend : bool

Determines whether or not item(s) corresponding to this chart's trace(s) is/are shown in the legend.

?LegendRank : int

Sets the legend rank for the chart's trace(s). Items and groups with smaller ranks are presented on top/left side while with `"reversed" `legend.traceorder` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.

?LegendGroup : string

Sets the legend group for the chart's trace(s). Traces part of the same legend group hide/show at the same time when toggling legend items.

?LegendGroupTitle : Title

Sets the title for the chart's trace legend group

Returns: 'T -> 'T

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

Full Usage: TraceStyle.XError(?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: 'T -> 'T

Returns a function that applies the given styles to the trace's Error object for the x dimension. Overwrites attributes with the same name that are already set.

?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: 'T -> 'T

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

Full Usage: TraceStyle.YError(?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: 'T -> 'T

Returns a function that applies the given styles to the trace's Error object for the y dimension. Overwrites attributes with the same name that are already set.

?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: 'T -> 'T

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

Full Usage: TraceStyle.ZError(?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: 'T -> 'T

Returns a function that applies the given styles to the trace's Error object for the z dimension.

?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: 'T -> 'T