plotly.graph_objects.Scatter

class plotly.graph_objects.Scatter(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, orientation=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)
__init__(arg=None, cliponaxis=None, connectgaps=None, customdata=None, customdatasrc=None, dx=None, dy=None, error_x=None, error_y=None, fill=None, fillcolor=None, groupnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hoveron=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, line=None, marker=None, meta=None, metasrc=None, mode=None, name=None, opacity=None, orientation=None, r=None, rsrc=None, selected=None, selectedpoints=None, showlegend=None, stackgaps=None, stackgroup=None, stream=None, t=None, text=None, textfont=None, textposition=None, textpositionsrc=None, textsrc=None, texttemplate=None, texttemplatesrc=None, tsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, x0=None, xaxis=None, xcalendar=None, xsrc=None, y=None, y0=None, yaxis=None, ycalendar=None, ysrc=None, **kwargs)

Construct a new Scatter object

The scatter trace type encompasses line charts, scatter charts, text charts, and bubble charts. The data visualized as scatter point or lines is set in x and y. Text (appearing either on the chart or on hover only) is via text. Bubble charts are achieved by setting marker.size and/or marker.color to numerical arrays.

Parameters

  • arg – dict of properties compatible with this constructor or an instance of plotly.graph_objects.Scatter

  • cliponaxis – Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to below traces.

  • connectgaps – Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

  • customdata – Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

  • customdatasrc – Sets the source reference on Chart Studio Cloud for customdata .

  • dx – Sets the x coordinate step. See x0 for more info.

  • dy – Sets the y coordinate step. See y0 for more info.

  • error_x – plotly.graph_objects.scatter.ErrorX instance or dict with compatible properties

  • error_y – plotly.graph_objects.scatter.ErrorY instance or dict with compatible properties

  • fill – Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • fillcolor – Sets the fill color. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

  • groupnorm – Only relevant when stackgroup is used, and only the first groupnorm found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the normalization for the sum of this stackgroup. With “fraction”, the value of each trace at each location is divided by the sum of all trace values at that location. “percent” is the same but multiplied by 100 to show percentages. If there are multiple subplots, or multiple `stackgroup`s on one subplot, each will be normalized within its own set.

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

  • hoverinfosrc – Sets the source reference on Chart Studio Cloud for hoverinfo .

  • hoverlabel – plotly.graph_objects.scatter.Hoverlabel instance or dict with compatible properties

  • hoveron – Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

  • hovertemplate – 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}”. Numbers are formatted using d3-format’s syntax %{variable:d3-format}, for example “Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#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-3.x-api- reference/blob/master/Time-Formatting.md#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. Anything contained in tag <extra> is displayed in the secondary box, for example “<extra>{fullData.name}</extra>”. To hide the secondary box completely, use an empty tag <extra></extra>.

  • hovertemplatesrc – Sets the source reference on Chart Studio Cloud for hovertemplate .

  • hovertext – 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.

  • hovertextsrc – Sets the source reference on Chart Studio Cloud for hovertext .

  • ids – Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

  • idssrc – Sets the source reference on Chart Studio Cloud for ids .

  • legendgroup – Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

  • line – plotly.graph_objects.scatter.Line instance or dict with compatible properties

  • marker – plotly.graph_objects.scatter.Marker instance or dict with compatible properties

  • meta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace name, graph, axis and colorbar title.text, annotation text rangeselector, updatemenues and sliders label text all support meta. To access the trace meta values in an attribute in the same trace, simply use %{meta[i]} where i is the index or key of the meta item in question. To access trace meta in layout attributes, use %{data[n[.meta[i]} where i is the index or key of the meta and n is the trace index.

  • metasrc – Sets the source reference on Chart Studio Cloud for meta .

  • mode – Determines the drawing mode for this scatter trace. If the provided mode includes “text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is “lines+markers”. Otherwise, “lines”.

  • name – Sets the trace name. The trace name appear as the legend item and on hover.

  • opacity – Sets the opacity of the trace.

  • orientation – Only relevant when stackgroup is used, and only the first orientation found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Sets the stacking direction. With “v” (“h”), the y (x) values of subsequent traces are added. Also affects the default value of fill.

  • r – r coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the radial coordinatesfor legacy polar chart only.

  • rsrc – Sets the source reference on Chart Studio Cloud for r .

  • selected – plotly.graph_objects.scatter.Selected instance or dict with compatible properties

  • selectedpoints – 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.

  • showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.

  • stackgaps – Only relevant when stackgroup is used, and only the first stackgaps found in the stackgroup will be used - including if visible is “legendonly” but not if it is false. Determines how we handle locations at which other traces in this group have data but this one does not. With infer zero we insert a zero at these locations. With “interpolate” we linearly interpolate between existing values, and extrapolate a constant beyond the existing values.

  • stackgroup – Set several scatter traces (on the same subplot) to the same stackgroup in order to add their y values (or their x values if orientation is “h”). If blank or omitted this trace will not be stacked. Stacking also turns fill on by default, using “tonexty” (“tonextx”) if orientation is “h” (“v”) and sets the default mode to “lines” irrespective of point count. You can only stack on a numeric (linear or log) axis. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple `stackgroup`s or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

  • stream – plotly.graph_objects.scatter.Stream instance or dict with compatible properties

  • t – t coordinates in scatter traces are deprecated!Please switch to the “scatterpolar” trace type.Sets the angular coordinatesfor legacy polar chart only.

  • text – 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.

  • textfont – Sets the text font.

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

  • textpositionsrc – Sets the source reference on Chart Studio Cloud for textposition .

  • textsrc – Sets the source reference on Chart Studio Cloud for text .

  • texttemplate – 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-3.x-api- reference/blob/master/Formatting.md#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-3.x-api- reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

  • texttemplatesrc – Sets the source reference on Chart Studio Cloud for texttemplate .

  • tsrc – Sets the source reference on Chart Studio Cloud for t .

  • uid – Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

  • uirevision – Controls persistence of some user-driven changes to the trace: constraintrange in parcoords traces, as well as some editable: true modifications such as name and colorbar.title. Defaults to layout.uirevision. Note that other user-driven trace attribute changes are controlled by layout attributes: trace.visible is controlled by layout.legend.uirevision, selectedpoints is controlled by layout.selectionrevision, and colorbar.(x|y) (accessible with config: {editable: true}) is controlled by layout.editrevision. Trace changes are tracked by uid, which only falls back on trace index if no uid is provided. So if your app can add/remove traces before the end of the data array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a uid that stays with it as it moves.

  • unselected – plotly.graph_objects.scatter.Unselected instance or dict with compatible properties

  • visible – Determines whether or not this trace is visible. If “legendonly”, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

  • x – Sets the x coordinates.

  • x0 – Alternate to x. Builds a linear space of x coordinates. Use with dx where x0 is the starting coordinate and dx the step.

  • xaxis – Sets a reference between this trace’s x coordinates and a 2D cartesian x axis. If “x” (the default value), the x coordinates refer to layout.xaxis. If “x2”, the x coordinates refer to layout.xaxis2, and so on.

  • xcalendar – Sets the calendar system to use with x date data.

  • xsrc – Sets the source reference on Chart Studio Cloud for x .

  • y – Sets the y coordinates.

  • y0 – Alternate to y. Builds a linear space of y coordinates. Use with dy where y0 is the starting coordinate and dy the step.

  • yaxis – Sets a reference between this trace’s y coordinates and a 2D cartesian y axis. If “y” (the default value), the y coordinates refer to layout.yaxis. If “y2”, the y coordinates refer to layout.yaxis2, and so on.

  • ycalendar – Sets the calendar system to use with y date data.

  • ysrc – Sets the source reference on Chart Studio Cloud for y .

Returns

Return type

Scatter

plotly.graph_objects.scatter

plotly.graph_objects.scatter

class plotly.graph_objects.scatter.ErrorX(arg=None, array=None, arrayminus=None, arrayminussrc=None, arraysrc=None, color=None, copy_ystyle=None, symmetric=None, thickness=None, traceref=None, tracerefminus=None, type=None, value=None, valueminus=None, visible=None, width=None, **kwargs)
property array

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

The ‘array’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

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

The ‘arrayminus’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property arrayminussrc

Sets the source reference on Chart Studio Cloud for arrayminus .

The ‘arrayminussrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property arraysrc

Sets the source reference on Chart Studio Cloud for array .

The ‘arraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property color

Sets the stoke color of the error bars.

The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

property copy_ystyle

The ‘copy_ystyle’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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

The ‘symmetric’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property thickness

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

The ‘thickness’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property traceref
The ‘traceref’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property tracerefminus
The ‘tracerefminus’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property 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 sqaure of the underlying data. If “data”, the bar lengths are set with data set array.

The ‘type’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘percent’, ‘constant’, ‘sqrt’, ‘data’]

Returns

Return type

Any

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

The ‘value’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property 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

The ‘valueminus’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property visible

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

The ‘visible’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property width

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

The ‘width’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

class plotly.graph_objects.scatter.ErrorY(arg=None, array=None, arrayminus=None, arrayminussrc=None, arraysrc=None, color=None, symmetric=None, thickness=None, traceref=None, tracerefminus=None, type=None, value=None, valueminus=None, visible=None, width=None, **kwargs)
property array

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

The ‘array’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

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

The ‘arrayminus’ property is an array that may be specified as a tuple, list, numpy array, or pandas Series

Returns

Return type

numpy.ndarray

property arrayminussrc

Sets the source reference on Chart Studio Cloud for arrayminus .

The ‘arrayminussrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property arraysrc

Sets the source reference on Chart Studio Cloud for array .

The ‘arraysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property color

Sets the stoke color of the error bars.

The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

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

The ‘symmetric’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property thickness

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

The ‘thickness’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property traceref
The ‘traceref’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property tracerefminus
The ‘tracerefminus’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [0, 9223372036854775807]

Returns

Return type

int

property 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 sqaure of the underlying data. If “data”, the bar lengths are set with data set array.

The ‘type’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘percent’, ‘constant’, ‘sqrt’, ‘data’]

Returns

Return type

Any

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

The ‘value’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property 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

The ‘valueminus’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property visible

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

The ‘visible’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property width

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

The ‘width’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

class plotly.graph_objects.scatter.Hoverlabel(arg=None, align=None, alignsrc=None, bgcolor=None, bgcolorsrc=None, bordercolor=None, bordercolorsrc=None, font=None, namelength=None, namelengthsrc=None, **kwargs)
property 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

The ‘align’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘left’, ‘right’, ‘auto’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property alignsrc

Sets the source reference on Chart Studio Cloud for align .

The ‘alignsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property bgcolor

Sets the background color of the hover labels for this trace

The ‘bgcolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bgcolorsrc

Sets the source reference on Chart Studio Cloud for bgcolor .

The ‘bgcolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property bordercolor

Sets the border color of the hover labels for this trace.

The ‘bordercolor’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property bordercolorsrc

Sets the source reference on Chart Studio Cloud for bordercolor .

The ‘bordercolorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property font

Sets the font used in hover labels.

The ‘font’ property is an instance of Font that may be specified as:

  • An instance of plotly.graph_objects.scatter.hoverlabel.Font

  • A dict of string/value properties that will be passed to the Font constructor

    Supported dict properties:

    color

    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 .

    size

    sizesrc

    Sets the source reference on Chart Studio Cloud for size .

Returns

Return type

plotly.graph_objects.scatter.hoverlabel.Font

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

The ‘namelength’ property is a integer and may be specified as:

  • An int (or float that will be cast to an int) in the interval [-1, 9223372036854775807]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|numpy.ndarray

property namelengthsrc

Sets the source reference on Chart Studio Cloud for namelength .

The ‘namelengthsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.scatter.Line(arg=None, color=None, dash=None, shape=None, simplify=None, smoothing=None, width=None, **kwargs)
property color

Sets the line color.

The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

Returns

Return type

str

property 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”).

The ‘dash’ property is an enumeration that may be specified as:
  • One of the following dash styles:

    [‘solid’, ‘dot’, ‘dash’, ‘longdash’, ‘dashdot’, ‘longdashdot’]

  • A string containing a dash length list in pixels or percentages

    (e.g. ‘5px 10px 2px 2px’, ‘5, 10, 2, 2’, ‘10% 20% 40%’, etc.)

Returns

Return type

str

property shape

Determines the line shape. With “spline” the lines are drawn using spline interpolation. The other available values correspond to step-wise line shapes.

The ‘shape’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘linear’, ‘spline’, ‘hv’, ‘vh’, ‘hvh’, ‘vhv’]

Returns

Return type

Any

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

The ‘simplify’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property 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).

The ‘smoothing’ property is a number and may be specified as:

  • An int or float in the interval [0, 1.3]

Returns

Return type

int|float

property width

Sets the line width (in px).

The ‘width’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

class plotly.graph_objects.scatter.Marker(arg=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, colorsrc=None, gradient=None, line=None, maxdisplayed=None, opacity=None, opacitysrc=None, reversescale=None, showscale=None, size=None, sizemin=None, sizemode=None, sizeref=None, sizesrc=None, symbol=None, symbolsrc=None, **kwargs)
property 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.

The ‘autocolorscale’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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

The ‘cauto’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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

The ‘cmax’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

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

The ‘cmid’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

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

The ‘cmin’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property color

Sets themarkercolor. 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.

The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A number that will be interpreted as a color according to scatter.marker.colorscale

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

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

The ‘coloraxis’ property is an identifier of a particular subplot, of type ‘coloraxis’, that may be specified as the string ‘coloraxis’ optionally followed by an integer >= 1 (e.g. ‘coloraxis’, ‘coloraxis1’, ‘coloraxis2’, ‘coloraxis3’, etc.)

Returns

Return type

str

property colorbar

The ‘colorbar’ property is an instance of ColorBar that may be specified as:

  • An instance of plotly.graph_objects.scatter.marker.ColorBar

  • A dict of string/value properties that will be passed to the ColorBar constructor

    Supported dict properties:

    bgcolor

    Sets the color of padded area.

    bordercolor

    Sets the axis line color.

    borderwidth

    Sets the width (in px) or the border enclosing this color bar.

    dtick

    Sets the step in-between ticks on this axis. Use with tick0. Must be a positive number, or special strings available to “log” and “date” axes. If the axis type is “log”, then ticks are set every 10^(n*dtick) where n is the tick number. For example, to set a tick mark at 1, 10, 100, 1000, … set dtick to 1. To set tick marks at 1, 100, 10000, … set dtick to 2. To set tick marks at 1, 5, 25, 125, 625, 3125, … set dtick to log_10(5), or 0.69897000433. “log” has several special values; “L<f>”, where f is a positive number, gives ticks linearly spaced in value (but not position). For example tick0 = 0.1, dtick = “L0.5” will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus small digits between, use “D1” (all digits) or “D2” (only 2 and 5). tick0 is ignored for “D1” and “D2”. If the axis type is “date”, then you must convert the time to milliseconds. For example, to set the interval between ticks to one day, set dtick to 86400000.0. “date” also has special values “M<n>” gives ticks spaced by a number of months. n must be a positive integer. To set ticks on the 15th of every third month, set tick0 to “2000-01-15” and dtick to “M3”. To set ticks every 4 years, set dtick to “M48”

    exponentformat

    Determines a formatting rule for the tick exponents. For example, consider the number 1,000,000,000. If “none”, it appears as 1,000,000,000. If “e”, 1e+9. If “E”, 1E+9. If “power”, 1x10^9 (with 9 in a super script). If “SI”, 1G. If “B”, 1B.

    len

    Sets the length of the color bar This measure excludes the padding of both ends. That is, the color bar length is this length minus the padding on both ends.

    lenmode

    Determines whether this color bar’s length (i.e. the measure in the color variation direction) is set in units of plot “fraction” or in *pixels. Use len to set the value.

    nticks

    Specifies the maximum number of ticks for the particular axis. The actual number of ticks will be chosen automatically to be less than or equal to nticks. Has an effect only if tickmode is set to “auto”.

    outlinecolor

    Sets the axis line color.

    outlinewidth

    Sets the width (in px) of the axis line.

    separatethousands

    If “true”, even 4-digit integers are separated

    showexponent

    If “all”, all exponents are shown besides their significands. If “first”, only the exponent of the first tick is shown. If “last”, only the exponent of the last tick is shown. If “none”, no exponents appear.

    showticklabels

    Determines whether or not the tick labels are drawn.

    showtickprefix

    If “all”, all tick labels are displayed with a prefix. If “first”, only the first tick is displayed with a prefix. If “last”, only the last tick is displayed with a suffix. If “none”, tick prefixes are hidden.

    showticksuffix

    Same as showtickprefix but for tick suffixes.

    thickness

    Sets the thickness of the color bar This measure excludes the size of the padding, ticks and labels.

    thicknessmode

    Determines whether this color bar’s thickness (i.e. the measure in the constant color direction) is set in units of plot “fraction” or in “pixels”. Use thickness to set the value.

    tick0

    Sets the placement of the first tick on this axis. Use with dtick. If the axis type is “log”, then you must take the log of your starting tick (e.g. to set the starting tick to 100, set the tick0 to 2) except when dtick`=*L<f>* (see `dtick for more info). If the axis type is “date”, it should be a date string, like date data. If the axis type is “category”, it should be a number, using the scale where each category is assigned a serial number from zero in the order it appears.

    tickangle

    Sets the angle of the tick labels with respect to the horizontal. For example, a tickangle of -90 draws the tick labels vertically.

    tickcolor

    Sets the tick color.

    tickfont

    Sets the color bar’s tick label font

    tickformat

    Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-3.x-api- reference/blob/master/Formatting.md#d3_format And for dates see: https://github.com/d3/d3-3.x-api- reference/blob/master/Time-Formatting.md#format We add one item to d3’s date formatter: “%{n}f” for fractional seconds with n digits. For example, 2016-10-13 09:15:23.456 with tickformat “%H~%M~%S.%2f” would display “09~15~23.46”

    tickformatstops

    A tuple of plotly.graph_objects.scatter .marker.colorbar.Tickformatstop instances or dicts with compatible properties

    tickformatstopdefaults

    When used in a template (as layout.template.dat a.scatter.marker.colorbar.tickformatstopdefault s), sets the default property values to use for elements of scatter.marker.colorbar.tickformatstops

    ticklen

    Sets the tick length (in px).

    tickmode

    Sets the tick mode for this axis. If “auto”, the number of ticks is set via nticks. If “linear”, the placement of the ticks is determined by a starting position tick0 and a tick step dtick (“linear” is the default value if tick0 and dtick are provided). If “array”, the placement of the ticks is set via tickvals and the tick text is ticktext. (“array” is the default value if tickvals is provided).

    tickprefix

    Sets a tick label prefix.

    ticks

    Determines whether ticks are drawn or not. If “”, this axis’ ticks are not drawn. If “outside” (“inside”), this axis’ are drawn outside (inside) the axis lines.

    ticksuffix

    Sets a tick label suffix.

    ticktext

    Sets the text displayed at the ticks position via tickvals. Only has an effect if tickmode is set to “array”. Used with tickvals.

    ticktextsrc

    Sets the source reference on Chart Studio Cloud for ticktext .

    tickvals

    Sets the values at which ticks on this axis appear. Only has an effect if tickmode is set to “array”. Used with ticktext.

    tickvalssrc

    Sets the source reference on Chart Studio Cloud for tickvals .

    tickwidth

    Sets the tick width (in px).

    title

    plotly.graph_objects.scatter.marker.col orbar.Title instance or dict with compatible properties

    titlefont

    Deprecated: Please use scatter.marker.colorbar.title.font instead. Sets this color bar’s title font. Note that the title’s font used to be set by the now deprecated titlefont attribute.

    titleside

    Deprecated: Please use scatter.marker.colorbar.title.side instead. Determines the location of color bar’s title with respect to the color bar. Note that the title’s location used to be set by the now deprecated titleside attribute.

    x

    Sets the x position of the color bar (in plot fraction).

    xanchor

    Sets this color bar’s horizontal position anchor. This anchor binds the x position to the “left”, “center” or “right” of the color bar.

    xpad

    Sets the amount of padding (in px) along the x direction.

    y

    Sets the y position of the color bar (in plot fraction).

    yanchor

    Sets this color bar’s vertical position anchor This anchor binds the y position to the “top”, “middle” or “bottom” of the color bar.

    ypad

    Sets the amount of padding (in px) along the y direction.

Returns

Return type

plotly.graph_objects.scatter.marker.ColorBar

property 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: Greys,YlGnB u,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland ,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.

The ‘colorscale’ property is a colorscale and may be specified as:

  • A list of colors that will be spaced evenly to create the colorscale. Many predefined colorscale lists are included in the sequential, diverging, and cyclical modules in the plotly.colors package.

  • A list of 2-element lists where the first element is the normalized color level value (starting at 0 and ending at 1), and the second item is a valid color string. (e.g. [[0, ‘green’], [0.5, ‘red’], [1.0, ‘rgb(0, 0, 255)’]])

  • One of the following named colorscales:
    [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’,

    ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

    Appending ‘_r’ to a named colorscale reverses it.

Returns

Return type

str

property colorsrc

Sets the source reference on Chart Studio Cloud for color .

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property gradient

The ‘gradient’ property is an instance of Gradient that may be specified as:

  • An instance of plotly.graph_objects.scatter.marker.Gradient

  • A dict of string/value properties that will be passed to the Gradient constructor

    Supported dict properties:

    color

    Sets the final color of the gradient fill: the center color for radial, the right for horizontal, or the bottom for vertical.

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    type

    Sets the type of gradient used to fill the markers

    typesrc

    Sets the source reference on Chart Studio Cloud for type .

Returns

Return type

plotly.graph_objects.scatter.marker.Gradient

property line

The ‘line’ property is an instance of Line that may be specified as:

  • An instance of plotly.graph_objects.scatter.marker.Line

  • A dict of string/value properties that will be passed to the Line constructor

    Supported dict properties:

    autocolorscale

    Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by marker.line.colorscale. Has an effect only if in marker.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

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

    cmax

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

    cmid

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

    cmin

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

    color

    Sets themarker.linecolor. 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.line.cmin and marker.line.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.line.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.line.cmin` and marker.line.cmax. Alternatively, colorscale may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black body,Earth,Electric,Viridis,Cividis.

    colorsrc

    Sets the source reference on Chart Studio Cloud for color .

    reversescale

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

    width

    Sets the width (in px) of the lines bounding the marker points.

    widthsrc

    Sets the source reference on Chart Studio Cloud for width .

Returns

Return type

plotly.graph_objects.scatter.marker.Line

property maxdisplayed

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

The ‘maxdisplayed’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

property opacity

Sets the marker opacity.

The ‘opacity’ property is a number and may be specified as:

  • An int or float in the interval [0, 1]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property opacitysrc

Sets the source reference on Chart Studio Cloud for opacity .

The ‘opacitysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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

The ‘reversescale’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

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

The ‘showscale’ property must be specified as a bool (either True, or False)

Returns

Return type

bool

property size

Sets the marker size (in px).

The ‘size’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

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

The ‘sizemin’ property is a number and may be specified as:

  • An int or float in the interval [0, inf]

Returns

Return type

int|float

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

The ‘sizemode’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [‘diameter’, ‘area’]

Returns

Return type

Any

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

The ‘sizeref’ property is a number and may be specified as:

  • An int or float

Returns

Return type

int|float

property sizesrc

Sets the source reference on Chart Studio Cloud for size .

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

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

The ‘symbol’ property is an enumeration that may be specified as:
  • One of the following enumeration values:

    [0, ‘circle’, 100, ‘circle-open’, 200, ‘circle-dot’, 300, ‘circle-open-dot’, 1, ‘square’, 101, ‘square-open’, 201, ‘square-dot’, 301, ‘square-open-dot’, 2, ‘diamond’, 102, ‘diamond-open’, 202, ‘diamond-dot’, 302, ‘diamond-open-dot’, 3, ‘cross’, 103, ‘cross-open’, 203, ‘cross-dot’, 303, ‘cross-open-dot’, 4, ‘x’, 104, ‘x-open’, 204, ‘x-dot’, 304, ‘x-open-dot’, 5, ‘triangle-up’, 105, ‘triangle-up-open’, 205, ‘triangle-up-dot’, 305, ‘triangle-up-open-dot’, 6, ‘triangle-down’, 106, ‘triangle-down-open’, 206, ‘triangle-down-dot’, 306, ‘triangle-down-open-dot’, 7, ‘triangle-left’, 107, ‘triangle-left-open’, 207, ‘triangle-left-dot’, 307, ‘triangle-left-open-dot’, 8, ‘triangle-right’, 108, ‘triangle-right-open’, 208, ‘triangle-right-dot’, 308, ‘triangle-right-open-dot’, 9, ‘triangle-ne’, 109, ‘triangle-ne-open’, 209, ‘triangle-ne-dot’, 309, ‘triangle-ne-open-dot’, 10, ‘triangle-se’, 110, ‘triangle-se-open’, 210, ‘triangle-se-dot’, 310, ‘triangle-se-open-dot’, 11, ‘triangle-sw’, 111, ‘triangle-sw-open’, 211, ‘triangle-sw-dot’, 311, ‘triangle-sw-open-dot’, 12, ‘triangle-nw’, 112, ‘triangle-nw-open’, 212, ‘triangle-nw-dot’, 312, ‘triangle-nw-open-dot’, 13, ‘pentagon’, 113, ‘pentagon-open’, 213, ‘pentagon-dot’, 313, ‘pentagon-open-dot’, 14, ‘hexagon’, 114, ‘hexagon-open’, 214, ‘hexagon-dot’, 314, ‘hexagon-open-dot’, 15, ‘hexagon2’, 115, ‘hexagon2-open’, 215, ‘hexagon2-dot’, 315, ‘hexagon2-open-dot’, 16, ‘octagon’, 116, ‘octagon-open’, 216, ‘octagon-dot’, 316, ‘octagon-open-dot’, 17, ‘star’, 117, ‘star-open’, 217, ‘star-dot’, 317, ‘star-open-dot’, 18, ‘hexagram’, 118, ‘hexagram-open’, 218, ‘hexagram-dot’, 318, ‘hexagram-open-dot’, 19, ‘star-triangle-up’, 119, ‘star-triangle-up-open’, 219, ‘star-triangle-up-dot’, 319, ‘star-triangle-up-open-dot’, 20, ‘star-triangle-down’, 120, ‘star-triangle-down-open’, 220, ‘star-triangle-down-dot’, 320, ‘star-triangle-down-open-dot’, 21, ‘star-square’, 121, ‘star-square-open’, 221, ‘star-square-dot’, 321, ‘star-square-open-dot’, 22, ‘star-diamond’, 122, ‘star-diamond-open’, 222, ‘star-diamond-dot’, 322, ‘star-diamond-open-dot’, 23, ‘diamond-tall’, 123, ‘diamond-tall-open’, 223, ‘diamond-tall-dot’, 323, ‘diamond-tall-open-dot’, 24, ‘diamond-wide’, 124, ‘diamond-wide-open’, 224, ‘diamond-wide-dot’, 324, ‘diamond-wide-open-dot’, 25, ‘hourglass’, 125, ‘hourglass-open’, 26, ‘bowtie’, 126, ‘bowtie-open’, 27, ‘circle-cross’, 127, ‘circle-cross-open’, 28, ‘circle-x’, 128, ‘circle-x-open’, 29, ‘square-cross’, 129, ‘square-cross-open’, 30, ‘square-x’, 130, ‘square-x-open’, 31, ‘diamond-cross’, 131, ‘diamond-cross-open’, 32, ‘diamond-x’, 132, ‘diamond-x-open’, 33, ‘cross-thin’, 133, ‘cross-thin-open’, 34, ‘x-thin’, 134, ‘x-thin-open’, 35, ‘asterisk’, 135, ‘asterisk-open’, 36, ‘hash’, 136, ‘hash-open’, 236, ‘hash-dot’, 336, ‘hash-open-dot’, 37, ‘y-up’, 137, ‘y-up-open’, 38, ‘y-down’, 138, ‘y-down-open’, 39, ‘y-left’, 139, ‘y-left-open’, 40, ‘y-right’, 140, ‘y-right-open’, 41, ‘line-ew’, 141, ‘line-ew-open’, 42, ‘line-ns’, 142, ‘line-ns-open’, 43, ‘line-ne’, 143, ‘line-ne-open’, 44, ‘line-nw’, 144, ‘line-nw-open’]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

Any|numpy.ndarray

property symbolsrc

Sets the source reference on Chart Studio Cloud for symbol .

The ‘symbolsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.scatter.Selected(arg=None, marker=None, textfont=None, **kwargs)
property marker

The ‘marker’ property is an instance of Marker that may be specified as:

  • An instance of plotly.graph_objects.scatter.selected.Marker

  • A dict of string/value properties that will be passed to the Marker constructor

    Supported dict properties:

    color

    Sets the marker color of selected points.

    opacity

    Sets the marker opacity of selected points.

    size

    Sets the marker size of selected points.

Returns

Return type

plotly.graph_objects.scatter.selected.Marker

property textfont

The ‘textfont’ property is an instance of Textfont that may be specified as:

Returns

Return type

plotly.graph_objects.scatter.selected.Textfont

class plotly.graph_objects.scatter.Stream(arg=None, maxpoints=None, token=None, **kwargs)
property 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.

The ‘maxpoints’ property is a number and may be specified as:

  • An int or float in the interval [0, 10000]

Returns

Return type

int|float

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

The ‘token’ property is a string and must be specified as:

  • A non-empty string

Returns

Return type

str

class plotly.graph_objects.scatter.Textfont(arg=None, color=None, colorsrc=None, family=None, familysrc=None, size=None, sizesrc=None, **kwargs)
property color
The ‘color’ property is a color and may be specified as:

  • A hex string (e.g. ‘#ff0000’)

  • An rgb/rgba string (e.g. ‘rgb(255,0,0)’)

  • An hsl/hsla string (e.g. ‘hsl(0,100%,50%)’)

  • An hsv/hsva string (e.g. ‘hsv(0,100%,100%)’)

  • A named CSS color:

    aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond, blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue, cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgrey, darkgreen, darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon, darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet, deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen, fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew, hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon, lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgrey, lightgreen, lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey, lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine, mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen, mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite, navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen, paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple, red, rosybrown, royalblue, rebeccapurple, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna, silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal, thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen

  • A list or array of any of the above

Returns

Return type

str|numpy.ndarray

property colorsrc

Sets the source reference on Chart Studio Cloud for color .

The ‘colorsrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property 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”.

The ‘family’ property is a string and must be specified as:

  • A non-empty string

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

str|numpy.ndarray

property familysrc

Sets the source reference on Chart Studio Cloud for family .

The ‘familysrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

property size
The ‘size’ property is a number and may be specified as:

  • An int or float in the interval [1, inf]

  • A tuple, list, or one-dimensional numpy array of the above

Returns

Return type

int|float|numpy.ndarray

property sizesrc

Sets the source reference on Chart Studio Cloud for size .

The ‘sizesrc’ property must be specified as a string or as a plotly.grid_objs.Column object

Returns

Return type

str

class plotly.graph_objects.scatter.Unselected(arg=None, marker=None, textfont=None, **kwargs)
property marker

The ‘marker’ property is an instance of Marker that may be specified as:

  • An instance of plotly.graph_objects.scatter.unselected.Marker

  • A dict of string/value properties that will be passed to the Marker constructor

    Supported dict properties:

    color

    Sets the marker color of unselected points, applied only when a selection exists.

    opacity

    Sets the marker opacity of unselected points, applied only when a selection exists.

    size

    Sets the marker size of unselected points, applied only when a selection exists.

Returns

Return type

plotly.graph_objects.scatter.unselected.Marker

property textfont

The ‘textfont’ property is an instance of Textfont that may be specified as:

  • An instance of plotly.graph_objects.scatter.unselected.Textfont

  • A dict of string/value properties that will be passed to the Textfont constructor

    Supported dict properties:

    color

    Sets the text font color of unselected points, applied only when a selection exists.

Returns

Return type

plotly.graph_objects.scatter.unselected.Textfont