plotly.graph_objects.Mesh3d

class plotly.graph_objects.Mesh3d(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)
__init__(arg=None, alphahull=None, autocolorscale=None, cauto=None, cmax=None, cmid=None, cmin=None, color=None, coloraxis=None, colorbar=None, colorscale=None, contour=None, customdata=None, customdatasrc=None, delaunayaxis=None, facecolor=None, facecolorsrc=None, flatshading=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatefallback=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, i=None, ids=None, idssrc=None, intensity=None, intensitymode=None, intensitysrc=None, isrc=None, j=None, jsrc=None, k=None, ksrc=None, legend=None, legendgroup=None, legendgrouptitle=None, legendrank=None, legendwidth=None, lighting=None, lightposition=None, meta=None, metasrc=None, name=None, opacity=None, reversescale=None, scene=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, vertexcolor=None, vertexcolorsrc=None, visible=None, x=None, xcalendar=None, xhoverformat=None, xsrc=None, y=None, ycalendar=None, yhoverformat=None, ysrc=None, z=None, zcalendar=None, zhoverformat=None, zsrc=None, **kwargs)

Construct a new Mesh3d object

Draws sets of triangles with coordinates given by three 1-dimensional arrays in x, y, z and (1) a sets of i, j, k indices (2) Delaunay triangulation or (3) the Alpha- shape algorithm or (4) the Convex-hull algorithm

Parameters

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

  • alphahull – Determines how the mesh surface triangles are derived from the set of vertices (points) represented by the x, y and z arrays, if the i, j, k arrays are not supplied. For general use of mesh3d it is preferred that i, j, k are supplied. If “-1”, Delaunay triangulation is used, which is mainly suitable if the mesh is a single, more or less layer surface that is perpendicular to delaunayaxis. In case the delaunayaxis intersects the mesh surface at more than one point it will result triangles that are very long in the dimension of delaunayaxis. If “>0”, the alpha-shape algorithm is used. In this case, the positive alphahull value signals the use of the alpha-shape algorithm, _and_ its value acts as the parameter for the mesh fitting. If 0, the convex-hull algorithm is used. It is suitable for convex bodies or if the intention is to enclose the x, y and z point set into a convex hull.

  • autocolorscale – Determines whether the colorscale is a default palette (autocolorscale: true) or the palette determined by colorscale. 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 intensity) or the bounds set in cmin and cmax Defaults to false when cmin and cmax are set by the user.

  • cmax – Sets the upper bound of the color domain. Value should have the same units as intensity and if set, cmin must be set as well.

  • cmid – Sets the mid-point of the color domain by scaling cmin and/or cmax to be equidistant to this point. Value should have the same units as intensity. Has no effect when cauto is false.

  • cmin – Sets the lower bound of the color domain. Value should have the same units as intensity and if set, cmax must be set as well.

  • color – Sets the color of the whole mesh

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

  • colorbar – plotly.graph_objects.mesh3d.ColorBar instance or dict with compatible properties

  • colorscale – Sets the colorscale. 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 cmin and cmax. Alternatively, colorscale may be a palette name string of the following list: Blackbody,Bluered,Blues,C ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

  • contour – plotly.graph_objects.mesh3d.Contour instance or dict with compatible properties

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

  • delaunayaxis – Sets the Delaunay axis, which is the axis that is perpendicular to the surface of the Delaunay triangulation. It has an effect if i, j, k are not provided and alphahull is set to indicate Delaunay triangulation.

  • facecolor – Sets the color of each face Overrides “color” and “vertexcolor”.

  • facecolorsrc – Sets the source reference on Chart Studio Cloud for facecolor.

  • flatshading – Determines whether or not normal smoothing is applied to the meshes, creating meshes with an angular, low- poly look via flat reflections.

  • 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.mesh3d.Hoverlabel instance or dict with compatible properties

  • 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}” 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 in hovertemplate are 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 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>.

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

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

  • i – A vector of vertex indices, i.e. integer values between 0 and the length of the vertex vectors, representing the “first” vertex of a triangle. For example, {i[m], j[m], k[m]} together represent face m (triangle m) in the mesh, where i[m] = n points to the triplet {x[n], y[n],