Struct plotly_types::traces::histogram::Histogram

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

The sample data from which statistics are computed is set in x for vertically spanning histograms and in y for horizontally spanning histograms. Binning options are set xbins and ybins respectively if no aggregation data is provided.

Implementations

impl<'a> Histogram<'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 showlegend(&mut self, showlegend: bool) -> &mut Self

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

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

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 text(&mut self, text: &'a str) -> &mut Self

Sets hover text elements associated with each bar. If a single string, the same string appears over all bars. If an array of string, the items are mapped in order to the this trace's coordinates.

default: ``

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

Same as text.

default: ``

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

Sets the orientation of the bars. With v (h), the value of the each bar spans along the vertical (horizontal).

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 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 cumulative(&mut self) -> &mut Cumulative

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 a group of histogram traces which will have compatible bin settings. Note that traces on the same subplot and with the same orientation under barmode stack, relative and group are forced into the same bingroup, Using bingroup, traces under barmode overlay and on different axes (of the same axis type) can have compatible bin settings. Note that histogram and histogram2d* trace can share the same bingroup

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 binNumber 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 marker(&mut self) -> &mut Marker<'a>

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

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

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

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

pub fn error_x(&mut self) -> &mut ErrorX<'a>

pub fn error_y(&mut self) -> &mut ErrorY<'a>

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 textsrc(&mut self, textsrc: &'a str) -> &mut Self

Sets the source reference on Chart Studio Cloud for text .

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

Sets the source reference on Chart Studio Cloud for hovertext .

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 Histogram<'a>

fn default() -> Histogram<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Histogram<'a>

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

Serialize this value into the given Serde serializer.