Struct Pie

Source

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

Expand description

A data visualized by the sectors of the pie is set in values. The sector labels are set in labels. The sector colors are set in marker.colors

Implementations§

Source §

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

Sets the sector labels. If labels entries are duplicated, we sum associated values or simply count occurrences if values is not provided. For other array attributes (including color) we use the first non-empty entry among all occurrences of the label.

Source

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

Alternate to labels. Builds a numeric set of labels. Use with dlabel where label0 is the starting label and dlabel the step.

default: 0

Source

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

Sets the label step. See label0 for more info.

default: 1

Source

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

Sets the values of the sectors. If omitted, we count occurrences of each label.

Source

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

Source

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

Sets text elements associated with each sector. If trace textinfo contains a text flag, these elements will be seen on the chart. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

Source

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

Sets hover text elements associated with each sector. If a single string, the same string appears for all data points. If an array of string, the items are mapped in order of this trace’s sectors. To be seen, trace hoverinfo must contain a text flag.

default: ``

Source

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

If there are multiple pie charts that should be sized according to their totals, link them by providing a non-empty group id here shared by every trace in the same group.

default: ``

Source

pub fn textinfo(&mut self) -> &mut Textinfo

Determines which trace information appear on the graph.

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 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. variables label, color, value, percent and text. 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 texttemplate(&mut self, texttemplate: &'a str) -> &mut Self

Template string used for rendering the information text that appear on points. Note that this will override textinfo. 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. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available. variables label, color, value, percent and text.

default: ``

Source

pub fn textposition(&mut self, textposition: Textposition) -> &mut Self

Specifies the location of the textinfo.

default: auto

Source

pub fn textfont(&mut self) -> &mut Textfont<'a>

Sets the font used for textinfo.

Source

pub fn insidetextorientation( &mut self, insidetextorientation: Insidetextorientation, ) -> &mut Self

Controls the orientation of the text inside chart sectors. When set to auto, text may be oriented in any direction in order to be as big as possible in the middle of a sector. The horizontal option orients text to be parallel with the bottom of the chart, and may make text smaller in order to achieve that goal. The radial option orients text along the radius of the sector. The tangential option orients text perpendicular to the radius of the sector.

default: auto

Source

pub fn insidetextfont(&mut self) -> &mut Insidetextfont<'a>

Sets the font used for textinfo lying inside the sector.

Source

pub fn outsidetextfont(&mut self) -> &mut Outsidetextfont<'a>

Sets the font used for textinfo lying outside the sector.

Source

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

Determines whether outside text labels can push the margins.

default: false

Source

pub fn title(&mut self) -> &mut Title<'a>

Source

pub fn domain(&mut self) -> &mut Domain<'a>

Source

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

Sets the fraction of the radius to cut out of the pie. Use this to make a donut chart.

default: 0

Source

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

Determines whether or not the sectors are reordered from largest to smallest.

default: true

Source

pub fn direction(&mut self, direction: Direction) -> &mut Self

Specifies the direction at which succeeding sectors follow one another.

default: counterclockwise

Source

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

Instead of the first slice starting at 12 o’clock, rotate to some other angle.

default: 0

Source

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

Sets the fraction of larger radius to pull the sectors out from the center. This can be a constant to pull all slices apart from each other equally or an array to highlight one or more slices.

default: 0

Source