[−][src]Struct plotly_types::traces::surface::Surface
The data the describes the coordinates of the surface is set in z
. Data in z
should be a {2D array}. Coordinates in x
and y
can either be 1D {arrays} or {2D arrays} (e.g. to graph parametric surfaces). If not provided in x
and y
, the x and y coordinates are assumed to be linear starting at 0 with a unit step. The color scale corresponds to the z
values by default. For custom color scales, use surfacecolor
which should be a {2D array}, where its bounds can be controlled using cmin
and cmax
.
Implementations
impl<'a> Surface<'a>
[src]
pub fn visible(&mut self, visible: Visible) -> &mut Self
[src]
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).
default: true
pub fn legendgroup(&mut self, legendgroup: &'a str) -> &mut Self
[src]
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
default: ``
pub fn name(&mut self, name: &'a str) -> &mut Self
[src]
Sets the trace name. The trace name appear as the legend item and on hover.
pub fn uid(&mut self, uid: &'a str) -> &mut Self
[src]
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
pub fn ids(&mut self, ids: &'a [&'a str]) -> &mut Self
[src]
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.
pub fn meta(&mut self, meta: Any) -> &mut Self
[src]
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.
pub fn hoverlabel(&mut self) -> &mut Hoverlabel<'a>
[src]
pub fn stream(&mut self) -> &mut Stream<'a>
[src]
pub fn uirevision(&mut self, uirevision: Any) -> &mut Self
[src]
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.
pub fn z(&mut self, z: &'a [f64]) -> &mut Self
[src]
Sets the z coordinates.
pub fn x(&mut self, x: &'a [f64]) -> &mut Self
[src]
Sets the x coordinates.
pub fn y(&mut self, y: &'a [f64]) -> &mut Self
[src]
Sets the y coordinates.
pub fn text(&mut self, text: &'a str) -> &mut Self
[src]
Sets the text elements associated with each z value. If trace hoverinfo
contains a text flag and hovertext is not set, these elements will be seen in the hover labels.
default: ``
pub fn hovertext(&mut self, hovertext: &'a str) -> &mut Self
[src]
Same as text
.
default: ``
pub fn hovertemplate(&mut self, hovertemplate: &'a str) -> &mut Self
[src]
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></extra>
.
default: ``
pub fn connectgaps(&mut self, connectgaps: bool) -> &mut Self
[src]
Determines whether or not gaps (i.e. {nan} or missing values) in the z
data are filled in.
default: false
pub fn surfacecolor(&mut self, surfacecolor: &'a [f64]) -> &mut Self
[src]
Sets the surface color values, used for setting a color scale independent of z
.
pub fn cauto(&mut self, cauto: bool) -> &mut Self
[src]
Determines whether or not the color domain is computed with respect to the input data (here z or surfacecolor) or the bounds set in cmin
and cmax
Defaults to false
when cmin
and cmax
are set by the user.
default: true
pub fn cmin(&mut self, cmin: f64) -> &mut Self
[src]
Sets the lower bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmax
must be set as well.
default: null
pub fn cmax(&mut self, cmax: f64) -> &mut Self
[src]
Sets the upper bound of the color domain. Value should have the same units as z or surfacecolor and if set, cmin
must be set as well.
default: null
pub fn cmid(&mut self, cmid: f64) -> &mut Self
[src]
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 z or surfacecolor. Has no effect when cauto
is false
.
default: null
pub fn colorscale(&mut self, colorscale: ColorScale<'a>) -> &mut Self
[src]
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, usecmin
and cmax
. Alternatively, colorscale
may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
default: null
pub fn autocolorscale(&mut self, autocolorscale: bool) -> &mut Self
[src]
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.
default: false
pub fn reversescale(&mut self, reversescale: bool) -> &mut Self
[src]
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.
default: false
pub fn showscale(&mut self, showscale: bool) -> &mut Self
[src]
Determines whether or not a colorbar is displayed for this trace.
default: true
pub fn colorbar(&mut self) -> &mut Colorbar<'a>
[src]
pub fn coloraxis(&mut self, coloraxis: &'a str) -> &mut Self
[src]
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.
default: null
pub fn contours(&mut self) -> &mut Contours<'a>
[src]
pub fn hidesurface(&mut self, hidesurface: bool) -> &mut Self
[src]
Determines whether or not a surface is drawn. For example, set hidesurface
to false contours.x.show
to true and contours.y.show
to true to draw a wire frame plot.
default: false
pub fn lightposition(&mut self) -> &mut Lightposition
[src]
pub fn lighting(&mut self) -> &mut Lighting
[src]
pub fn opacity(&mut self, opacity: f64) -> &mut Self
[src]
Sets the opacity of the surface. Please note that in the case of using high opacity
values for example a value greater than or equal to 0.5 on two surfaces (and 0.25 with four surfaces), an overlay of multiple transparent surfaces may not perfectly be sorted in depth by the webgl API. This behavior may be improved in the near future and is subject to change.
default: 1
pub fn opacityscale(&mut self, opacityscale: Any) -> &mut Self
[src]
Sets the opacityscale. The opacityscale must be an array containing arrays mapping a normalized value to an opacity value. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, [[0, 1], [0.5, 0.2], [1, 1]]
means that higher/lower values would have higher opacity values and those in the middle would be more transparent Alternatively, opacityscale
may be a palette name string of the following list: 'min', 'max', 'extremes' and 'uniform'. The default is 'uniform'.
pub fn hoverinfo(&mut self) -> &mut Hoverinfo
[src]
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.
default: all
pub fn showlegend(&mut self, showlegend: bool) -> &mut Self
[src]
Determines whether or not an item corresponding to this trace is shown in the legend.
default: false
pub fn xcalendar(&mut self, xcalendar: Xcalendar) -> &mut Self
[src]
Sets the calendar system to use with x
date data.
default: gregorian
pub fn ycalendar(&mut self, ycalendar: Ycalendar) -> &mut Self
[src]
Sets the calendar system to use with y
date data.
default: gregorian
pub fn zcalendar(&mut self, zcalendar: Zcalendar) -> &mut Self
[src]
Sets the calendar system to use with z
date data.
default: gregorian
pub fn scene(&mut self, scene: &'a str) -> &mut Self
[src]
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.
default: scene
pub fn idssrc(&mut self, idssrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for ids .
pub fn customdatasrc(&mut self, customdatasrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for customdata .
pub fn metasrc(&mut self, metasrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for meta .
pub fn zsrc(&mut self, zsrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for z .
pub fn xsrc(&mut self, xsrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for x .
pub fn ysrc(&mut self, ysrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for y .
pub fn textsrc(&mut self, textsrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for text .
pub fn hovertextsrc(&mut self, hovertextsrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for hovertext .
pub fn hovertemplatesrc(&mut self, hovertemplatesrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for hovertemplate .
pub fn surfacecolorsrc(&mut self, surfacecolorsrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for surfacecolor .
pub fn hoverinfosrc(&mut self, hoverinfosrc: &'a str) -> &mut Self
[src]
Sets the source reference on Chart Studio Cloud for hoverinfo .
Trait Implementations
Auto Trait Implementations
impl<'a> RefUnwindSafe for Surface<'a>
impl<'a> Send for Surface<'a>
impl<'a> Sync for Surface<'a>
impl<'a> Unpin for Surface<'a>
impl<'a> UnwindSafe for Surface<'a>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,