Struct plotly::ScatterPolar

pub struct ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,{ /* private fields */ }

Construct a polar scatter trace.

Examples

use plotly::ScatterPolar;

let trace = ScatterPolar::new(vec![0, 1, 2], vec![2, 1, 0]);

let expected = serde_json::json!({
    "type": "scatterpolar",
    "theta": [0, 1, 2],
    "r": [2, 1, 0]
});

assert_eq!(serde_json::to_value(trace).unwrap(), expected);

Implementations

impl<Theta, R> ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

pub fn name(self, value: impl AsRef<str>) -> Box<Self>

Sets the trace name. The trace name appear as the legend item and on hover.

pub fn modify_all_name(value: impl AsRef<str>) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_name(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn visible(self, value: Visible) -> Box<Self>

Determines whether or not this trace is visible. If Visible::LegendOnly, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

pub fn modify_all_visible(value: Visible) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_visible(values: Vec<Visible>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn show_legend(self, value: bool) -> Box<Self>

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

pub fn modify_all_show_legend(value: bool) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_show_legend(values: Vec<bool>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn legend_group(self, value: impl AsRef<str>) -> Box<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.

pub fn modify_all_legend_group(
    value: impl AsRef<str>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_legend_group(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn legend_group_title(self, value: LegendGroupTitle) -> Box<Self>

pub fn modify_all_legend_group_title(
    value: LegendGroupTitle
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_legend_group_title(
    values: Vec<LegendGroupTitle>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn opacity(self, value: f64) -> Box<Self>

Sets the opacity of the trace.

pub fn modify_all_opacity(value: f64) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_opacity(values: Vec<f64>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn mode(self, value: Mode) -> Box<Self>

Determines the drawing mode for this scatter trace. If the provided Mode includes “Text” then the text elements appear at the coordinates. Otherwise, the text elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is Mode::LinesMarkers, otherwise it is Mode::Lines.

pub fn modify_all_mode(value: Mode) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_mode(values: Vec<Mode>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn ids(self, value: Vec<impl AsRef<str>>) -> Box<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 modify_all_ids(
    value: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_ids(
    values: Vec<Vec<impl AsRef<str>>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn theta(self, value: Vec<Theta>) -> Box<Self>

Sets the theta coordinate step. See theta0 for more info.

pub fn modify_all_theta(value: Vec<Theta>) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_theta(values: Vec<Vec<Theta>>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn theta0(self, value: impl Into<NumOrString>) -> Box<Self>

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

pub fn modify_all_theta0(
    value: impl Into<NumOrString>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_theta0(
    values: Vec<impl Into<NumOrString>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn dtheta(self, value: f64) -> Box<Self>

pub fn modify_all_dtheta(value: f64) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_dtheta(values: Vec<f64>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn r(self, value: Vec<R>) -> Box<Self>

pub fn modify_all_r(value: Vec<R>) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_r(values: Vec<Vec<R>>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn r0(self, value: impl Into<NumOrString>) -> Box<Self>

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

pub fn modify_all_r0(
    value: impl Into<NumOrString>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_r0(
    values: Vec<impl Into<NumOrString>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn dr(self, value: f64) -> Box<Self>

Sets the r coordinate step. See r0 for more info.

pub fn modify_all_dr(value: f64) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_dr(values: Vec<f64>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn subplot(self, value: impl AsRef<str>) -> Box<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.

pub fn modify_all_subplot(
    value: impl AsRef<str>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_subplot(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text(self, value: impl AsRef<str>) -> Box<Self>

Sets text elements associated with each (x,y) pair. 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. If trace HoverInfo contains a “text” flag and hover_text is not set, these elements will be seen in the hover labels.

pub fn modify_all_text(value: impl AsRef<str>) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_text(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text_array(self, value: Vec<impl AsRef<str>>) -> Box<Self>

Sets text elements associated with each (x,y) pair. 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. If trace HoverInfo contains a “text” flag and hover_text is not set, these elements will be seen in the hover labels.

pub fn text_position(self, value: Position) -> Box<Self>

Sets the positions of the text elements with respects to the (x,y) coordinates.

pub fn modify_all_text_position(
    value: Position
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_text_position(
    values: Vec<Position>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text_position_array(self, value: Vec<Position>) -> Box<Self>

Sets the positions of the text elements with respects to the (x,y) coordinates.

pub fn text_template(self, value: impl AsRef<str>) -> Box<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}”. See 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}”. See format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

pub fn modify_all_text_template(
    value: impl AsRef<str>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_text_template(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text_template_array(self, value: Vec<impl AsRef<str>>) -> Box<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}”. See 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}”. See format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are arrayOk: true) are available.

pub fn hover_text(self, value: impl AsRef<str>) -> Box<Self>

Sets hover text elements associated with each (x,y) pair. 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.

pub fn modify_all_hover_text(
    value: impl AsRef<str>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_hover_text(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_text_array(self, value: Vec<impl AsRef<str>>) -> Box<Self>

Sets hover text elements associated with each (x,y) pair. 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.

pub fn hover_info(self, value: HoverInfo) -> Box<Self>

Determines which trace information appear on hover. If HoverInfo::None or HoverInfo::Skip are set, no information is displayed upon hovering. But, if HoverInfo::None is set, click and hover events are still fired.

pub fn modify_all_hover_info(value: HoverInfo) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_hover_info(
    values: Vec<HoverInfo>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_template(self, value: impl AsRef<str>) -> Box<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>.

pub fn modify_all_hover_template(
    value: impl AsRef<str>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_hover_template(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_template_array(self, value: Vec<impl AsRef<str>>) -> Box<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>.

pub fn meta(self, value: impl Into<NumOrString>) -> Box<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 modify_all_meta(
    value: impl Into<NumOrString>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_meta(
    values: Vec<impl Into<NumOrString>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn custom_data(self, value: Vec<impl Into<NumOrString> + Clone>) -> Box<Self>

Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, “scatter” traces also appends customdata items in the markers DOM elements

pub fn modify_all_custom_data(
    value: Vec<impl Into<NumOrString> + Clone>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_custom_data(
    values: Vec<Vec<impl Into<NumOrString> + Clone>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn selected_points(self, value: Vec<u32>) -> Box<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 modify_all_selected_points(
    value: Vec<u32>
) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_selected_points(
    values: Vec<Vec<u32>>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn marker(self, value: Marker) -> Box<Self>

Determines how points are displayed and joined.

pub fn modify_all_marker(value: Marker) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_marker(values: Vec<Marker>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn line(self, value: Line) -> Box<Self>

Line display properties.

pub fn modify_all_line(value: Line) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_line(values: Vec<Line>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn text_font(self, value: Font) -> Box<Self>

Sets the text font.

pub fn modify_all_text_font(value: Font) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_text_font(values: Vec<Font>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn clip_on_axis(self, value: bool) -> Box<Self>

Determines whether or not markers and text nodes are clipped about the subplot axes. To show markers and text nodes above axis lines and tick labels, make sure to set xaxis.layer and yaxis.layer to “below traces”.

pub fn modify_all_clip_on_axis(value: bool) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_clip_on_axis(values: Vec<bool>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn connect_gaps(self, value: bool) -> Box<Self>

Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

pub fn modify_all_connect_gaps(value: bool) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_connect_gaps(values: Vec<bool>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn fill(self, value: Fill) -> Box<Self>

Sets the area to fill with a solid color. Defaults to “none” unless this trace is stacked, then it gets “tonexty” (“tonextx”) if orientation is “v” (“h”) Use with fillcolor if not “none”. “tozerox” and “tozeroy” fill to x=0 and y=0 respectively. “tonextx” and “tonexty” fill between the endpoints of this trace and the endpoints of the trace before it, connecting those endpoints with straight lines (to make a stacked area graph); if there is no trace before it, they behave like “tozerox” and “tozeroy”. “toself” connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape. “tonext” fills the space between two traces if one completely encloses the other (eg consecutive contour lines), and behaves like “toself” if there is no trace before it. “tonext” should not be used if one trace does not enclose the other. Traces in a stackgroup will only fill to (or be filled to) other traces in the same group. With multiple stackgroups or some traces stacked and some not, if fill-linked traces are not already consecutive, the later ones will be pushed down in the drawing order.

pub fn modify_all_fill(value: Fill) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_fill(values: Vec<Fill>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn fill_color(self, value: impl Color) -> Box<Self>

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

pub fn modify_all_fill_color(value: impl Color) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_fill_color(
    values: Vec<impl Color>
) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_label(self, value: Label) -> Box<Self>

Properties of label displayed on mouse hover.

pub fn modify_all_hover_label(value: Label) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_hover_label(values: Vec<Label>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

pub fn hover_on(self, value: HoverOn) -> Box<Self>

Do the hover effects highlight individual points (markers or line points) or do they highlight filled regions? If the fill is “toself” or “tonext” and there are no markers or text, then the default is “fills”, otherwise it is “points”.

pub fn modify_all_hover_on(value: HoverOn) -> RestyleScatterPolar<Theta, R>

Apply the same restyling to all the traces

pub fn modify_hover_on(values: Vec<HoverOn>) -> RestyleScatterPolar<Theta, R>

Apply the restyling individually to each trace. Caller is responsible to set the length of the vector to be equal to the number of traces

impl<Theta, R> ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

pub fn new(theta: Vec<Theta>, r: Vec<R>) -> Box<Self>

pub fn web_gl_mode(self, on: bool) -> Box<Self>

Enables WebGL.

Trait Implementations

impl<Theta: Clone, R: Clone> Clone for ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

fn clone(&self) -> ScatterPolar<Theta, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Theta: Debug, R: Debug> Debug for ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Theta, R> Default for ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<Theta, R> Serialize for ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,
    Theta: Serialize,
    R: Serialize,

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

Serialize this value into the given Serde serializer.

impl<Theta, R> Trace for ScatterPolar<Theta, R>where
    Theta: Serialize + Clone + 'static,
    R: Serialize + Clone + 'static,

fn to_json(&self) -> String