Struct Barpolar

Source

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

Expand description

The data visualized by the radial span of the bars is set in r

Implementations§

Source §

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

Sets the radial coordinates

Source

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

Sets the angular coordinates

Source

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

Alternate to r. Builds a linear space of r coordinates. Use with dr where r0 is the starting coordinate and dr the step.

default: 0

Source

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

Sets the r coordinate step.

default: 1

Source

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

Alternate to theta. Builds a linear space of theta coordinates. Use with dtheta where theta0 is the starting coordinate and dtheta the step.

default: 0

Source

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

Sets the theta coordinate step. By default, the dtheta step equals the subplot’s period divided by the length of the r coordinates.

Source

pub fn thetaunit(&mut self, thetaunit: Thetaunit) -> &mut Self

Sets the unit of input theta values. Has an effect only when on linear angular axes.

default: degrees

Source

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

Sets where the bar base is drawn (in radial axis units). In stack barmode, traces that set base will be excluded and drawn in overlay mode instead.

default: null

Source

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

Shifts the angular position where the bar is drawn (in thetatunit units).

default: null

Source

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

Sets the bar angular width (in thetaunit units).

default: null

Source

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

Source

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

Same as text.

default: ``

Source

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

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. 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 selected(&mut self) -> &mut Selected<'a>

Source

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

Source

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

Sets a reference between this trace’s data coordinates and a polar subplot. If polar (the default value), the data refer to layout.polar. If polar2, the data refer to layout.polar2, and so on.

default: polar

Source