plotly.graph_objects.Scatter3d — 6.6.0 documentation
arg – dict of properties compatible with this constructor or an instance of
plotly.graph_objects.Scatter3dconnectgaps – 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.error_x –
plotly.graph_objects.scatter3d.ErrorXinstance or dict with compatible propertieserror_y –
plotly.graph_objects.scatter3d.ErrorYinstance or dict with compatible propertieserror_z –
plotly.graph_objects.scatter3d.ErrorZinstance or dict with compatible propertieshoverinfo – Determines which trace information appear on hover. If
noneorskipare set, no information is displayed upon hovering. But, ifnoneis set, click and hover events are still fired.hoverinfosrc – Sets the source reference on Chart Studio Cloud for
hoverinfo.hoverlabel –
plotly.graph_objects.scatter3d.Hoverlabelinstance or dict with compatible propertieshovertemplate – 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. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. The variables available inhovertemplateare the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event- data. Additionally, all attributes that can be specified per-point (the ones that arearrayOk: 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>.hovertemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.
hovertemplatesrc – Sets the source reference on Chart Studio Cloud for
hovertemplate.hovertext – Sets text elements associated with each (x,y,z) triplet. 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,z) coordinates. To be seen, trace
hoverinfomust 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.legend – Sets the reference to a legend to show this trace in. References to these legends are “legend”, “legend2”, “legend3”, etc. Settings for these legends are set in the layout, under
layout.legend,layout.legend2, etc.legendgroup – Sets the legend group for this trace. Traces and shapes part of the same legend group hide/show at the same time when toggling legend items.
legendgrouptitle – :class:`plotly.graph_objects.scatter3d.Legendgrouptitle ` instance or dict with compatible properties
legendrank – Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with “reversed”
legend.traceorderthey 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. When having unranked or equal rank items shapes would be displayed after traces i.e. according to their order in data and layout.legendwidth – Sets the width (in px or fraction) of the legend for this trace.
line –
plotly.graph_objects.scatter3d.Lineinstance or dict with compatible propertiesmarker –
plotly.graph_objects.scatter3d.Markerinstance or dict with compatible propertiesmeta – Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace
name, graph, axis and colorbartitle.text, annotationtextrangeselector,updatemenuesandsliderslabeltext all supportmeta. To access the tracemetavalues in an attribute in the same trace, simply use%{meta[i]}whereiis the index or key of themetaitem in question. To access tracemetain layout attributes, use%{data[n[.meta[i]}whereiis the index or key of themetaandnis 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
modeincludes “text” then thetextelements appear at the coordinates. Otherwise, thetextelements 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 appears as the legend item and on hover.
opacity – Sets the opacity of the trace.
projection –
plotly.graph_objects.scatter3d.Projectioninstance or dict with compatible propertiesscene – Sets a reference between this trace’s 3D coordinate system and a 3D scene. If “scene” (the default value), the (x,y,z) coordinates refer to
layout.scene. If “scene2”, the (x,y,z) coordinates refer tolayout.scene2, and so on.showlegend – Determines whether or not an item corresponding to this trace is shown in the legend.
stream –
plotly.graph_objects.scatter3d.Streaminstance or dict with compatible propertiessurfaceaxis – If “-1”, the scatter points are not fill with a surface If 0, 1, 2, the scatter points are filled with a Delaunay surface about the x, y, z respectively.
surfacecolor – Sets the surface fill color.
text – Sets text elements associated with each (x,y,z) triplet. 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,z) coordinates. If trace
hoverinfocontains 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
textelements 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 appears 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. Variables that can’t be found will be replaced with the specifier. For example, a template of “data: %{x}, %{y}” will result in a value of “data: 1, %{y}” if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that arearrayOk: true) are available.texttemplatefallback – Fallback string that’s displayed when a variable referenced in a template is missing. If the boolean value ‘false’ is passed in, the specifier with the missing variable will be displayed.
texttemplatesrc – Sets the source reference on Chart Studio Cloud for
texttemplate.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:
constraintrangeinparcoordstraces, as well as someeditable: truemodifications such asnameandcolorbar.title. Defaults tolayout.uirevision. Note that other user-driven trace attribute changes are controlled bylayoutattributes:trace.visibleis controlled bylayout.legend.uirevision,selectedpointsis controlled bylayout.selectionrevision, andcolorbar.(x|y)(accessible withconfig: {editable: true}) is controlled bylayout.editrevision. Trace changes are tracked byuid, which only falls back on trace index if nouidis provided. So if your app can add/remove traces before the end of thedataarray, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace auidthat stays with it as it moves.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.
xcalendar – Sets the calendar system to use with
xdate data.xhoverformat – Sets the hover text formatting rulefor
xusing d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{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*By default the values are formatted usingxaxis.hoverformat.xsrc – Sets the source reference on Chart Studio Cloud for
x.y – Sets the y coordinates.
ycalendar – Sets the calendar system to use with
ydate data.yhoverformat – Sets the hover text formatting rulefor
yusing d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{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*By default the values are formatted usingyaxis.hoverformat.ysrc – Sets the source reference on Chart Studio Cloud for
y.z – Sets the z coordinates.
zcalendar – Sets the calendar system to use with
zdate data.zhoverformat – Sets the hover text formatting rulefor
zusing d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time- format/tree/v2.2.3#locale_format. We add two items to d3’s date formatter: “%h” for half of the year as a decimal number as well as “%{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*By default the values are formatted usingzaxis.hoverformat.zsrc – Sets the source reference on Chart Studio Cloud for
z.