Struct plotly::traces::scatter_mapbox::ScatterMapbox

pub struct ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,{ /* private fields */ }

Implementations

impl<Lat, Lon> ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,

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>) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_name(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_visible(values: Vec<Visible>) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_show_legend(values: Vec<bool>) -> RestyleScatterMapbox<Lat, Lon>

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_rank(self, value: usize) -> Box<Self>

Sets the legend rank for this trace. Items and groups with smaller ranks are presented on top/left side while with "reversed" legend.trace_order` they are on bottom/right side. The default legendrank is 1000, so that you can use ranks less than 1000 to place certain items before all unranked items, and ranks greater than 1000 to go after all unranked items.

pub fn modify_all_legend_rank(value: usize) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_legend_rank(values: Vec<usize>) -> RestyleScatterMapbox<Lat, Lon>

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 show/hide at the same time when toggling legend items.

pub fn modify_all_legend_group(
    value: impl AsRef<str>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_legend_group(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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>

Set and style the title to appear for the legend group.

pub fn modify_all_legend_group_title(
    value: LegendGroupTitle
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_legend_group_title(
    values: Vec<LegendGroupTitle>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_opacity(values: Vec<f64>) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_mode(values: Vec<Mode>) -> RestyleScatterMapbox<Lat, Lon>

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>>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_ids(
    values: Vec<Vec<impl AsRef<str>>>
) -> RestyleScatterMapbox<Lat, Lon>

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 lat(self, value: Vec<Lat>) -> Box<Self>

pub fn modify_all_lat(value: Vec<Lat>) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_lat(values: Vec<Vec<Lat>>) -> RestyleScatterMapbox<Lat, Lon>

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 lon(self, value: Vec<Lon>) -> Box<Self>

pub fn modify_all_lon(value: Vec<Lon>) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_lon(values: Vec<Vec<Lon>>) -> RestyleScatterMapbox<Lat, Lon>

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. If the 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>) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_text(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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 strings, the items are mapped in order to the this trace’s (x,y) coordinates. If the 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
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_text_position(
    values: Vec<Position>
) -> RestyleScatterMapbox<Lat, Lon>

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>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_text_template(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_hover_text(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_hover_info(
    values: Vec<HoverInfo>
) -> RestyleScatterMapbox<Lat, Lon>

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>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_hover_template(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_meta(
    values: Vec<impl Into<NumOrString>>
) -> RestyleScatterMapbox<Lat, Lon>

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>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_custom_data(
    values: Vec<Vec<impl Into<NumOrString> + Clone>>
) -> RestyleScatterMapbox<Lat, Lon>

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 mapbox subplot. If “mapbox” (the default value), the data refer to layout.mapbox. If “mapbox2”, the data refer to layout.mapbox2, and so on.

pub fn modify_all_subplot(
    value: impl AsRef<str>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_subplot(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_marker(values: Vec<Marker>) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_line(values: Vec<Line>) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_text_font(values: Vec<Font>) -> RestyleScatterMapbox<Lat, Lon>

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<usize>) -> Box<Self>

Vector containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty vector means an empty selection where the unselected are turned on for all points.

pub fn modify_all_selected_points(
    value: Vec<usize>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_selected_points(
    values: Vec<Vec<usize>>
) -> RestyleScatterMapbox<Lat, Lon>

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(self, value: Selection) -> Box<Self>

Sets the style of selected points.

pub fn modify_all_selected(value: Selection) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_selected(values: Vec<Selection>) -> RestyleScatterMapbox<Lat, Lon>

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 unselected(self, value: Selection) -> Box<Self>

Sets the style of unselected points.

pub fn modify_all_unselected(value: Selection) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_unselected(
    values: Vec<Selection>
) -> RestyleScatterMapbox<Lat, Lon>

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 below(self, value: impl AsRef<str>) -> Box<Self>

Determines if this scattermapbox trace’s layers are to be inserted before the layer with the specified ID. By default, scattermapbox layers are inserted above all the base layers. To place the scattermapbox layers above every other layer, set below to “‘’”.

pub fn modify_all_below(
    value: impl AsRef<str>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_below(
    values: Vec<impl AsRef<str>>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_connect_gaps(values: Vec<bool>) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_fill(values: Vec<Fill>) -> RestyleScatterMapbox<Lat, Lon>

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
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_fill_color(
    values: Vec<impl Color>
) -> RestyleScatterMapbox<Lat, Lon>

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) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_hover_label(values: Vec<Label>) -> RestyleScatterMapbox<Lat, Lon>

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 ui_revision(self, value: impl Into<NumOrString>) -> Box<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 modify_all_ui_revision(
    value: impl Into<NumOrString>
) -> RestyleScatterMapbox<Lat, Lon>

Apply the same restyling to all the traces

pub fn modify_ui_revision(
    values: Vec<impl Into<NumOrString>>
) -> RestyleScatterMapbox<Lat, Lon>

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<Lat, Lon> ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone + Default,
    Lon: Serialize + Clone + Default,

pub fn new(lat: Vec<Lat>, lon: Vec<Lon>) -> Box<Self>

Trait Implementations

impl<Lat: Clone, Lon: Clone> Clone for ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,

fn clone(&self) -> ScatterMapbox<Lat, Lon>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Lat: Debug, Lon: Debug> Debug for ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,

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

Formats the value using the given formatter.

impl<Lat, Lon> Default for ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<Lat, Lon> Serialize for ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,
    Lat: Serialize,
    Lon: Serialize,

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

Serialize this value into the given Serde serializer.

impl<Lat, Lon> Trace for ScatterMapbox<Lat, Lon>where
    Lat: Serialize + Clone,
    Lon: Serialize + Clone,

fn to_json(&self) -> String