Struct plotly_types::traces::histogram2d::Histogram2D

pub struct Histogram2D<'a> { /* fields omitted */ }

The sample data from which statistics are computed is set in x and y (where x and y represent marginal distributions, binning is set in xbins and ybins in this case) or z (where z represent the 2D distribution and binning set, binning is set by x and y in this case). The resulting distribution is visualized as a heatmap.

Implementations

impl<'a> Histogram2D<'a>

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

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

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

Sets the opacity of the trace.

default: 1

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.

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.

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.

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.

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

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

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

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.

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

Sets the sample data to be binned on the x axis.

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

Sets the sample data to be binned on the y axis.

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

Sets the aggregation data.

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

pub fn histnorm(&mut self, histnorm: Histnorm) -> &mut Self

Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If percent / probability, the span of each bar corresponds to the percentage / fraction of occurrences with respect to the total number of sample points (here, the sum of all bin HEIGHTS equals 100% / 1). If density, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin AREAS equals the total number of sample points). If probability density, the area of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin AREAS equals 1).

default: ``

pub fn histfunc(&mut self, histfunc: Histfunc) -> &mut Self

Specifies the binning function used for this histogram trace. If count, the histogram values are computed by counting the number of values lying inside each bin. If sum, avg, min, max, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

default: count

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

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if xbins.size is provided.

default: 0

pub fn xbins(&mut self) -> &mut Xbins

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

Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data. Ignored if ybins.size is provided.

default: 0

pub fn ybins(&mut self) -> &mut Ybins

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

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobinx is not needed. However, we accept autobinx: true or false and will update xbins accordingly before deleting autobinx from the trace.

default: null

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

Obsolete: since v1.42 each bin attribute is auto-determined separately and autobiny is not needed. However, we accept autobiny: true or false and will update ybins accordingly before deleting autobiny from the trace.

default: null

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

Set the xbingroup and ybingroup default prefix For example, setting a bingroup of 1 on two histogram2d traces will make them their x-bins and y-bins match separately.

default: ``

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

Set a group of histogram traces which will have compatible x-bin settings. Using xbingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible x-bin settings. Note that the same xbingroup value can be used to set (1D) histogram bingroup

default: ``

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

Set a group of histogram traces which will have compatible y-bin settings. Using ybingroup, histogram2d and histogram2dcontour traces (on axes of the same axis type) can have compatible y-bin settings. Note that the same ybingroup value can be used to set (1D) histogram bingroup

default: ``

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

Sets the horizontal gap (in pixels) between bricks.

default: 0

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

Sets the vertical gap (in pixels) between bricks.

default: 0

pub fn zsmooth(&mut self, zsmooth: Zsmooth) -> &mut Self

Picks a smoothing algorithm use to smooth z data.

default: false

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

Sets the hover text formatting rule using d3 formatting mini-languages which are very similar to those in Python. See: https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format

default: ``

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. variable z 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: ``

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

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

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

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

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

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

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

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

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

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

default: true

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

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

pub fn xcalendar(&mut self, xcalendar: Xcalendar) -> &mut Self

Sets the calendar system to use with x date data.

default: gregorian

pub fn ycalendar(&mut self, ycalendar: Ycalendar) -> &mut Self

Sets the calendar system to use with y date data.

default: gregorian

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

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

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

Sets the source reference on Chart Studio Cloud for ids .

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

Sets the source reference on Chart Studio Cloud for customdata .

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

Sets the source reference on Chart Studio Cloud for meta .

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

Sets the source reference on Chart Studio Cloud for hoverinfo .

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

Sets the source reference on Chart Studio Cloud for x .

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

Sets the source reference on Chart Studio Cloud for y .

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

Sets the source reference on Chart Studio Cloud for z .

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

Sets the source reference on Chart Studio Cloud for hovertemplate .

Trait Implementations

impl<'a> Default for Histogram2D<'a>

fn default() -> Histogram2D<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Histogram2D<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.