Struct Violin

Source

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

Expand description

In vertical (horizontal) violin plots, statistics are computed using y (x) values. By supplying an x (y) array, one violin per distinct x (y) value is drawn If no x (y) {array} is provided, a single violin is drawn. That violin position is then positioned with with name or with x0 (y0) if provided.

Implementations§

Source §

impl<'a> Violin<'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 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 selectedpoints(&mut self, selectedpoints: Any) -> &mut Self

Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the unselected are turned on for all points, whereas, any other non-array values means no selection all where the selected and unselected styles have no effect.

Source

pub fn hoverinfo(&mut self) -> &mut 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.

default: all

Source

pub fn hoverlabel(&mut self) -> &mut Hoverlabel<'a>

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 y(&mut self, y: &'a [f64]) -> &mut Self

Sets the y sample data or coordinates. See overview for more info.

Source

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

Sets the x sample data or coordinates. See overview for more info.

Source

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

Sets the x coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

Source

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

Sets the y coordinate for single-box traces or the starting coordinate for multi-box traces set using q1/median/q3. See overview for more info.

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. For violin traces, the name will also be used for the position coordinate, if x and x0 (y and y0 if horizontal) are missing and the position axis is categorical. Note that the trace name is also used as a default value for attribute scalegroup (please see its description for details).

Source

pub fn orientation(&mut self, orientation: Orientation) -> &mut Self

Sets the orientation of the violin(s). If v (h), the distribution is visualized along the vertical (horizontal).

Source

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

Sets the bandwidth used to compute the kernel density estimate. By default, the bandwidth is determined by Silverman’s rule of thumb.

Source

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

If there are multiple violins that should be sized according to to some metric (see scalemode), link them by providing a non-empty group id here shared by every trace in the same group. If a violin’s width is undefined, scalegroup will default to the trace’s name. In this case, violins with the same names will be linked together

default: ``

Source

pub fn scalemode(&mut self, scalemode: Scalemode) -> &mut Self

Sets the metric by which the width of each violin is determined.width means each violin has the same (max) widthcount means the violins are scaled by the number of sample points makingup each violin.

default: width

Source

pub fn spanmode(&mut self, spanmode: Spanmode) -> &mut Self

Sets the method by which the span in data space where the density function will be computed. soft means the span goes from the sample’s minimum value minus two bandwidths to the sample’s maximum value plus two bandwidths. hard means the span goes from the sample’s minimum to its maximum value. For custom span settings, use mode manual and fill in the span attribute.

default: soft

Source

pub fn span(&mut self, span: &'a InfoArray) -> &mut Self

Sets the span in data space for which the density function will be computed. Has an effect only when spanmode is set to manual.

Source

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

Source

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

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

Source

pub fn points(&mut self, points: Points) -> &mut Self

If outliers, only the sample points lying outside the whiskers are shown If suspectedoutliers, the outlier points are shown and points either less than 4Q1-3Q3 or greater than 4Q3-3Q1 are highlighted (see outliercolor) If all, all sample points are shown If false, only the violins are shown with no sample points. Defaults to suspectedoutliers when marker.outliercolor or marker.line.outliercolor is set, otherwise defaults to outliers.

Source

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

Sets the amount of jitter in the sample points drawn. If 0, the sample points align along the distribution axis. If 1, the sample points are drawn in a random jitter of width equal to the width of the violins.

Source

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

Sets the position of the sample points in relation to the violins. If 0, the sample points are places over the center of the violins. Positive (negative) values correspond to positions to the right (left) for vertical violins and above (below) for horizontal violins.

Source

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

Sets the width of the violin in data coordinates. If 0 (default value) the width is automatically selected based on the positions of other violin traces in the same subplot.

default: 0

Source

pub fn marker(&mut self) -> &mut Marker<'a>

Source

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

Sets the text elements associated with each sample value. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace’s (x,y) coordinates. To be seen, trace hoverinfo must contain a text flag.

default: ``

Source

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

Same as text.

default: ``

Source

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

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

default: ``

Source

pub fn meanline(&mut self) -> &mut Meanline<'a>

Source

pub fn side(&mut self, side: Side) -> &mut Self

Determines on which side of the position value the density function making up one half of a violin is plotted. Useful when comparing two violin traces under overlay mode, where one trace has side set to positive and the other to negative.

default: both

Source

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

Set several traces linked to the same position axis or matching axes to the same offsetgroup where bars of the same position coordinate will line up.

default: ``

Source

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

Set several traces linked to the same position axis or matching axes to the same alignmentgroup. This controls whether bars compute their positional range dependently or independently.

default: ``

Source

pub fn selected(&mut self) -> &mut Selected<'a>

Source

pub fn unselected(&mut self) -> &mut Unselected<'a>

Source

pub fn hoveron(&mut self) -> &mut Hoveron

Do the hover effects highlight individual violins or sample points or the kernel density estimate or any combination of them?

default: violins+points+kde

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