Struct Contourcarpet

Source

pub struct Contourcarpet<'a> { /* private fields */ }

Expand description

Plots contours on either the first carpet axis or the carpet axis with a matching carpet attribute. Data z is interpreted as matching that of the corresponding carpet axis.

Implementations§

Source §

impl<'a> Contourcarpet<'a>

Source

pub fn visible(&mut self, visible: Visible) -> &mut Self

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

Source

pub fn showlegend(&mut self, showlegend: bool) -> &mut Self

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

default: true

Source

pub fn legendgroup(&mut self, legendgroup: &'a str) -> &mut Self

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: ``

Source

pub fn opacity(&mut self, opacity: f64) -> &mut Self

Sets the opacity of the trace.

default: 1

Source

pub fn name(&mut self, name: &'a str) -> &mut Self

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

Source

pub fn uid(&mut self, uid: &'a str) -> &mut Self

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

Source

pub fn ids(&mut self, ids: &'a [&'a str]) -> &mut Self

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.

Source

pub fn meta(&mut self, meta: Any) -> &mut Self

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.

Source

pub fn stream(&mut self) -> &mut Stream<'a>

Source

pub fn uirevision(&mut self, uirevision: Any) -> &mut Self

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.

Source

pub fn carpet(&mut self, carpet: &'a str) -> &mut Self

The carpet of the carpet axes on which this contour trace lies

Source

pub fn z(&mut self, z: &'a [f64]) -> &mut Self

Sets the z data.

Source

pub fn a(&mut self, a: &'a [f64]) -> &mut Self

Sets the x coordinates.

Source

pub fn a_0(&mut self, a_0: Any) -> &mut Self

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

default: 0

Source

pub fn da(&mut self, da: f64) -> &mut Self

Sets the x coordinate step. See x0 for more info.

default: 1

Source

pub fn b(&mut self, b: &'a [f64]) -> &mut Self

Sets the y coordinates.

Source

pub fn b_0(&mut self, b_0: Any) -> &mut Self

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

default: 0

Source

pub fn db(&mut self, db: f64) -> &mut Self

Sets the y coordinate step. See y0 for more info.

default: 1

Source

pub fn text(&mut self, text: &'a [f64]) -> &mut Self

Sets the text elements associated with each z value.

Source

pub fn hovertext(&mut self, hovertext: &'a [f64]) -> &mut Self

Same as text.

Source

pub fn transpose(&mut self, transpose: bool) -> &mut Self

Transposes the z data.

default: false

Source

pub fn atype(&mut self, atype: Atype) -> &mut Self

If array, the heatmap’s x coordinates are given by x (the default behavior when x is provided). If scaled, the heatmap’s x coordinates are given by x0 and dx (the default behavior when x is not provided).

Source

pub fn btype(&mut self, btype: Btype) -> &mut Self

If array, the heatmap’s y coordinates are given by y (the default behavior when y is provided) If scaled, the heatmap’s y coordinates are given by y0 and dy (the default behavior when y is not provided)

Source

pub fn fillcolor(&mut self, fillcolor: &'a str) -> &mut Self

Sets the fill color if contours.type is constraint. Defaults to a half-transparent variant of the line color, marker color, or marker line color, whichever is available.

Source

pub fn autocontour(&mut self, autocontour: bool) -> &mut Self

Determines whether or not the contour level attributes are picked by an algorithm. If true, the number of contour levels can be set in ncontours. If false, set the contour level attributes in contours.

default: true

Source

pub fn ncontours(&mut self, ncontours: u64) -> &mut Self

Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of ncontours. Has an effect only if autocontour is true or if contours.size is missing.

default: 15

Source

pub fn contours(&mut self) -> &mut Contours<'a>

Source

pub fn line(&mut self) -> &mut Line<'a>

Source

pub fn zauto(&mut self, zauto: bool) -> &mut Self

Determines whether or not the color domain is computed with respect to the input data (here in z) or the bounds set in zmin and zmax Defaults to false when zmin and zmax are set by the user.

default: true

Source

pub fn zmin(&mut self, zmin: f64) -> &mut Self

Sets the lower bound of the color domain. Value should have the same units as in z and if set, zmax must be set as well.

default: null

Source

pub fn zmax(&mut self, zmax: f64) -> &mut Self

Sets the upper bound of the color domain. Value should have the same units as in z and if set, zmin must be set as well.

default: null

Source

pub fn zmid(&mut self, zmid: f64) -> &mut Self

Sets the mid-point of the color domain by scaling zmin and/or zmax to be equidistant to this point. Value should have the same units as in z. Has no effect when zauto is false.

default: null

Source

pub fn colorscale(&mut self, colorscale: ColorScale<'a>) -> &mut Self

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, usezmin and zmax. 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

Source

pub fn autocolorscale(&mut self, autocolorscale: bool) -> &mut Self

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

Source

pub fn reversescale(&mut self, reversescale: bool) -> &mut Self

Reverses the color mapping if true. If true, zmin will correspond to the last color in the array and zmax will correspond to the first color.

default: false

Source

pub fn showscale(&mut self, showscale: bool) -> &mut Self

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

default: true

Source

pub fn colorbar(&mut self) -> &mut Colorbar<'a>

Source

pub fn coloraxis(&mut self, coloraxis: &'a str) -> &mut Self

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

Source

pub fn xaxis(&mut self, xaxis: &'a str) -> &mut Self

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.

default: x

Source

pub fn yaxis(&mut self, yaxis: &'a str) -> &mut Self

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.

default: y

Source