API Reference
< Back to docs
Switch to new Anvil Editor docs Switch to Classic Editor docs
You are currently viewing the new Anvil Editor Docs.
Switch to the Classic Editor Docs
You are currently viewing the Classic Editor Docs.
Switch to the new Anvil Editor Docs

plotly.graph_objs.scatter Module

Globals

Functions

plotly.graph_objs.scatter.ErrorX([_deprecated=], [array=], [arrayminus=], [arrayminussrc=], [arraysrc=], [color=], [copy_ystyle=], [symmetric=], [thickness=], [traceref=], [tracerefminus=], [type=], [value=], [valueminus=], [visible=], [width=]) → ErrorX

Create a new ‘ErrorX’ object

  • array - Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

  • arrayminus - 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.

  • arrayminussrc - Sets the source reference on Chart Studio Cloud for `arrayminus`.

  • arraysrc - Sets the source reference on Chart Studio Cloud for `array`.

  • color - Sets the stoke color of the error bars.

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

  • thickness - Sets the thickness (in px) of the error bars.

  • type - 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`.

  • value - 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 - 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

  • visible - Determines whether or not this set of error bars is visible.

  • width - Sets the width (in px) of the cross-bar at both ends of the error bars.

plotly.graph_objs.scatter.ErrorY([_deprecated=], [array=], [arrayminus=], [arrayminussrc=], [arraysrc=], [color=], [symmetric=], [thickness=], [traceref=], [tracerefminus=], [type=], [value=], [valueminus=], [visible=], [width=]) → ErrorY

Create a new ‘ErrorY’ object

  • array - Sets the data corresponding the length of each error bar. Values are plotted relative to the underlying data.

  • arrayminus - 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.

  • arrayminussrc - Sets the source reference on Chart Studio Cloud for `arrayminus`.

  • arraysrc - Sets the source reference on Chart Studio Cloud for `array`.

  • color - Sets the stoke color of the error bars.

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

  • thickness - Sets the thickness (in px) of the error bars.

  • type - 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`.

  • value - 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 - 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

  • visible - Determines whether or not this set of error bars is visible.

  • width - Sets the width (in px) of the cross-bar at both ends of the error bars.

plotly.graph_objs.scatter.Fillpattern([bgcolor=], [bgcolorsrc=], [fgcolor=], [fgcolorsrc=], [fgopacity=], [fillmode=], [shape=], [shapesrc=], [size=], [sizesrc=], [solidity=], [soliditysrc=]) → Fillpattern

Create a new ‘Fillpattern’ object

  • bgcolor - When there is no colorscale sets the color of background pattern fill. Defaults to a `marker.color` background when `fillmode` is *overlay*. Otherwise, defaults to a transparent background.

  • bgcolorsrc - Sets the source reference on Chart Studio Cloud for `bgcolor`.

  • fgcolor - When there is no colorscale sets the color of foreground pattern fill. Defaults to a `marker.color` background when `fillmode` is *replace*. Otherwise, defaults to dark grey or white to increase contrast with the `bgcolor`.

  • fgcolorsrc - Sets the source reference on Chart Studio Cloud for `fgcolor`.

  • fgopacity - Sets the opacity of the foreground pattern fill. Defaults to a 0.5 when `fillmode` is *overlay*. Otherwise, defaults to 1.

  • fillmode - Determines whether `marker.color` should be used as a default to `bgcolor` or a `fgcolor`.

  • shape - Sets the shape of the pattern fill. By default, no pattern is used for filling the area.

  • shapesrc - Sets the source reference on Chart Studio Cloud for `shape`.

  • size - Sets the size of unit squares of the pattern fill in pixels, which corresponds to the interval of repetition of the pattern.

  • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

  • solidity - Sets the solidity of the pattern fill. Solidity is roughly the fraction of the area filled by the pattern. Solidity of 0 shows only the background color without pattern and solidty of 1 shows only the foreground color without pattern.

  • soliditysrc - Sets the source reference on Chart Studio Cloud for `solidity`.

plotly.graph_objs.scatter.Hoverlabel([align=], [alignsrc=], [bgcolor=], [bgcolorsrc=], [bordercolor=], [bordercolorsrc=], [font=], [namelength=], [namelengthsrc=]) → Hoverlabel

Create a new ‘Hoverlabel’ object

  • align - Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

  • alignsrc - Sets the source reference on Chart Studio Cloud for `align`.

  • bgcolor - Sets the background color of the hover labels for this trace

  • bgcolorsrc - Sets the source reference on Chart Studio Cloud for `bgcolor`.

  • bordercolor - Sets the border color of the hover labels for this trace.

  • bordercolorsrc - Sets the source reference on Chart Studio Cloud for `bordercolor`.

  • font - Sets the font used in hover labels.

  • namelength - Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

  • namelengthsrc - Sets the source reference on Chart Studio Cloud for `namelength`.

plotly.graph_objs.scatter.Legendgrouptitle([font=], [text=]) → Legendgrouptitle

Create a new ‘Legendgrouptitle’ object

  • font - Sets this legend group's title font.

  • text - Sets the title of the legend group.

plotly.graph_objs.scatter.Line([backoff=], [backoffsrc=], [color=], [dash=], [shape=], [simplify=], [smoothing=], [width=]) → Line

Create a new ‘Line’ object

  • 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*.

  • backoffsrc - Sets the source reference on Chart Studio Cloud for `backoff`.

  • color - Sets the line color.

  • dash - 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 - Determines the line shape. With *spline* the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

  • simplify - 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 - 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 - Sets the line width (in px).

plotly.graph_objs.scatter.Marker([angle=], [angleref=], [anglesrc=], [autocolorscale=], [cauto=], [cmax=], [cmid=], [cmin=], [color=], [coloraxis=], [colorbar=], [colorscale=], [colorsrc=], [gradient=], [line=], [maxdisplayed=], [opacity=], [opacitysrc=], [reversescale=], [showscale=], [size=], [sizemin=], [sizemode=], [sizeref=], [sizesrc=], [standoff=], [standoffsrc=], [symbol=], [symbolsrc=]) → Marker

Create a new ‘Marker’ object

  • angle - Sets the marker angle in respect to `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.

  • anglesrc - Sets the source reference on Chart Studio Cloud for `angle`.

  • autocolorscale - 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 - 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 - 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 - 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 - 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 - 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.

  • coloraxis - 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 - Sets the colorscale. Has an effect only if in `marker.color` 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.

  • colorsrc - Sets the source reference on Chart Studio Cloud for `color`.

  • maxdisplayed - Sets a maximum number of points to be drawn on the graph. *0* corresponds to no limit.

  • opacity - Sets the marker opacity.

  • opacitysrc - Sets the source reference on Chart Studio Cloud for `opacity`.

  • reversescale - 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 - 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 - Sets the marker size (in px).

  • sizemin - 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 - 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 - 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`.

  • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

  • standoff - 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.

  • standoffsrc - Sets the source reference on Chart Studio Cloud for `standoff`.

  • symbol - Sets the marker symbol type. Adding 100 is equivalent to appending *-open* to a symbol name. Adding 200 is equivalent to appending *-dot* to a symbol name. Adding 300 is equivalent to appending *-open-dot* or *dot-open* to a symbol name.

  • symbolsrc - Sets the source reference on Chart Studio Cloud for `symbol`.

plotly.graph_objs.scatter.Selected([marker=], [textfont=]) → Selected

Create a new ‘Selected’ object

    plotly.graph_objs.scatter.Stream([maxpoints=], [token=]) → Stream

    Create a new ‘Stream’ object

    • maxpoints - Sets the maximum number of points to keep on the plots from an incoming stream. If `maxpoints` is set to *50*, only the newest 50 points will be displayed on the plot.

    • token - The stream id number links a data trace on a plot with a stream. See https://chart-studio.plotly.com/settings for more details.

    plotly.graph_objs.scatter.Textfont([color=], [colorsrc=], [family=], [familysrc=], [size=], [sizesrc=]) → Textfont

    Create a new ‘Textfont’ object

    • colorsrc - Sets the source reference on Chart Studio Cloud for `color`.

    • family - HTML font family - the typeface that will be applied by the web browser. The web browser will only be able to apply a font if it is available on the system which it operates. Provide multiple font families, separated by commas, to indicate the preference in which to apply fonts if they aren't available on the system. The Chart Studio Cloud (at https://chart-studio.plotly.com or on-premise) generates images on a server, where only a select number of fonts are installed and supported. These include *Arial*, *Balto*, *Courier New*, *Droid Sans*,, *Droid Serif*, *Droid Sans Mono*, *Gravitas One*, *Old Standard TT*, *Open Sans*, *Overpass*, *PT Sans Narrow*, *Raleway*, *Times New Roman*.

    • familysrc - Sets the source reference on Chart Studio Cloud for `family`.

    • sizesrc - Sets the source reference on Chart Studio Cloud for `size`.

    plotly.graph_objs.scatter.Transform() → Transform

    Create a new ‘Transform’ object

    plotly.graph_objs.scatter.Unselected([marker=], [textfont=]) → Unselected

    Create a new ‘Unselected’ object

      Globals

      Do you still have questions?

      Our Community Forum is full of helpful information and Anvil experts.

      plotly.graph_objs.sankey.node.hoverlabel plotly.graph_objs.scatter.hoverlabel

      plotly.graph_objs.scatter