Struct plotly::traces::mesh3d::Mesh3D

source ·
pub struct Mesh3D<X, Y, Z>where
    X: Serialize + Clone,
    Y: Serialize + Clone,
    Z: Serialize + Clone,
{ /* private fields */ }

Implementations

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Determines whether or not this trace is visible. If Visible::LegendOnly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Set and style the title to appear for the legend group

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the opacity of the trace.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the intensity values for vertices or cells as defined by IntensityMode. It can be used for plotting fields on meshes.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Determines the source of intensity values.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the color of each vertex Overrides “color”. While Red, green and blue colors are in the range of 0 and 255; in the case of having vertex color data in RGBA format, the alpha color should be normalized to be between 0 and 1.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. If the trace HoverInfo contains a “text” flag and hover_text is not set, these elements will be seen in the hover labels.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. If the trace HoverInfo contains a “text” flag and hover_text is not set, these elements will be seen in the hover labels.

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace HoverInfo must contain a “Text” flag.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace HoverInfo must contain a “Text” flag.

Determines which trace information appear on hover. If HoverInfo::None or HoverInfo::Skip are set, no information is displayed upon hovering. But, if HoverInfo::None is set, click and hover events are still fired.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 “{fullData.name}”. To hide the secondary box completely, use an empty tag <extra></extra>.

Sets the hover text formatting rulefor x using 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 using xaxis.hoverformat.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the hover text formatting rulefor y using 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 using yaxis.hoverformat.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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 to layout.scene2, and so on.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the color of the whole mesh.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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,Cividis,Earth,Electric,Greens,Greys,Hot,Jet, Picnic, Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Determines whether or not a colorbar is displayed for this trace.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Reverses the color mapping if True. If True, cmin will correspond to the last color in the array and cmax will correspond to the first color.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the hover text formatting rulefor z using 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 using zaxis.hoverformat.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Properties of label displayed on mouse hover.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the calendar system to use with x date data.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the calendar system to use with y date data.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Sets the calendar system to use with z date data.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

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.

Apply the same restyling to all the traces

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.