Struct plotly_types::traces::scattergeo::Scattergeo

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

The data visualized as scatter point or lines on a geographic map is provided either by longitude/latitude pairs in lon and lat respectively or by geographic location IDs or names in locations.

Implementations

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

Sets the longitude coordinates (in degrees East).

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

Sets the latitude coordinates (in degrees North).

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

Sets the coordinates via location IDs or names. Coordinates correspond to the centroid of each location given. See locationmode for more info.

pub fn locationmode(&mut self, locationmode: Locationmode) -> &mut Self

Determines the set of locations used to match entries in locations to regions on the map. Values ISO-3, USA-states, country names correspond to features on the base map and value geojson-id corresponds to features from a custom GeoJSON linked to the geojson attribute.

default: ISO-3

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

Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used when locations is set. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type FeatureCollection or Feature with geometries of type Polygon or MultiPolygon.

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

Sets the key in GeoJSON features which is used as id to match the items included in the locations array. Only has an effect when geojson is set. Support nested property, for example properties.name.

default: id

pub fn mode(&mut self) -> &mut Mode

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 lines+markers. Otherwise, lines.

default: markers

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

Sets text elements associated with each (lon,lat) pair or item in locations. 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 (lon,lat) or locations coordinates. If trace hoverinfo contains a text flag and hovertext is not set, these elements will be seen in the hover labels.

default: ``

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 lat, lon, location and text.

default: ``

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

Sets hover text elements associated with each (lon,lat) pair or item in locations. 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 (lon,lat) or locations coordinates. To be seen, trace hoverinfo must contain a text flag.

default: ``

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

Sets the text font.

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

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

default: middle center

pub fn line(&mut self) -> &mut Line<'a>

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

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

default: false

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

pub fn fill(&mut self, fill: Fill) -> &mut Self

Sets the area to fill with a solid color. Use with fillcolor if not none. toself connects the endpoints of the trace (or each segment of the trace if it has gaps) into a closed shape.

default: none

pub fn fillcolor(&mut self, fillcolor: &'a str) -> &mut 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 selected(&mut self) -> &mut Selected<'a>

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

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

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

Sets a reference between this trace's geospatial coordinates and a geographic map. If geo (the default value), the geospatial coordinates refer to layout.geo. If geo2, the geospatial coordinates refer to layout.geo2, and so on.

default: geo

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

Sets the source reference on Chart Studio Cloud for lon .

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

Sets the source reference on Chart Studio Cloud for lat .

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

Sets the source reference on Chart Studio Cloud for locations .

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

Sets the source reference on Chart Studio Cloud for text .

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

Sets the source reference on Chart Studio Cloud for texttemplate .

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

Sets the source reference on Chart Studio Cloud for hovertext .

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

Sets the source reference on Chart Studio Cloud for textposition .

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

Sets the source reference on Chart Studio Cloud for hoverinfo .

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

fn default() -> Scattergeo<'a>

Returns the "default value" for a type.

impl<'a> Serialize for Scattergeo<'a>

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

Serialize this value into the given Serde serializer.