Struct Carpet

Source

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

Expand description

The data describing carpet axis layout is set in y and (optionally) also x. If only y is present, x the plot is interpreted as a cheater plot and is filled in using the y values. x and y may either be 2D arrays matching with each dimension matching that of a and b, or they may be 1D arrays with total length equal to that of a and b.

Implementations§

Source §

impl<'a> Carpet<'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 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

An identifier for this carpet, so that scattercarpet and contourcarpet traces can specify a carpet plot on which they lie

Source

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

A two dimensional array of x coordinates at each carpet point. If ommitted, the plot is a cheater plot and the xaxis is hidden by default.

Source

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

A two dimensional array of y coordinates at each carpet point.

Source

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

An array containing values of the first parameter value

Source

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

Alternate to a. Builds a linear space of a coordinates. Use with da where a0 is the starting coordinate and da the step.

default: 0

Source

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

Sets the a coordinate step. See a0 for more info.

default: 1

Source

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

A two dimensional array of y coordinates at each carpet point.

Source

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

Alternate to b. Builds a linear space of a coordinates. Use with db where b0 is the starting coordinate and db the step.

default: 0

Source

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

Sets the b coordinate step. See b0 for more info.

default: 1

Source

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

The shift applied to each successive row of data in creating a cheater plot. Only used if x is been ommitted.

default: 1

Source

pub fn aaxis(&mut self) -> &mut Aaxis<'a>

Source

pub fn baxis(&mut self) -> &mut Baxis<'a>

Source

pub fn font(&mut self) -> &mut Font<'a>

The default font used for axis & tick labels on this carpet

Source

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

Sets default for all colors associated with this axis all at once: line, font, tick, and grid colors. Grid color is lightened by blending this with the plot background Individual pieces can override this.

default: #444

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