Struct ScatterGeo 

pub struct ScatterGeo { /* private fields */ }

A structure representing a geographic scatter plot.

The ScatterGeo struct facilitates the creation and customization of geographic scatter plots with various options for data selection, grouping, layout configuration, and aesthetic adjustments. It supports plotting data points on a map using latitude and longitude coordinates, with customization for markers, lines, text labels, and comprehensive layout options.

Backend Support

Backend	Supported
Plotly	Yes
Plotters	–

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• lat - A string slice specifying the column name to be used for latitude coordinates.
• lon - A string slice specifying the column name to be used for longitude coordinates.
• mode - An optional Mode specifying the drawing mode (markers, lines, or both).
• text - An optional string slice specifying the column name to be used for text labels.
• group - An optional string slice specifying the column name to be used for grouping data points.
• sort_groups_by - Optional comparator fn(&str, &str) -> std::cmp::Ordering to control group ordering. Groups are sorted lexically by default.
• opacity - An optional f64 value specifying the opacity of the plot elements (range: 0.0 to 1.0).
• size - An optional usize specifying the size of the markers.
• color - An optional Rgb value specifying the color of the markers. This is used when group is not specified.
• colors - An optional vector of Rgb values specifying the colors for the markers. This is used when group is specified.
• shape - An optional Shape specifying the shape of the markers. This is used when group is not specified.
• shapes - An optional vector of Shape values specifying multiple shapes for the markers when plotting multiple groups.
• line_width - An optional f64 value specifying the width of the lines (when mode includes lines).
• line_color - An optional Rgb value specifying the color of the lines.
• plot_title - An optional Text struct specifying the title of the plot.
• legend_title - An optional Text struct specifying the title of the legend.
• legend - An optional reference to a Legend struct for customizing the legend of the plot.

Example

use plotlars::{Plot, Rgb, ScatterGeo, Shape, Text, Mode};
use polars::prelude::*;

let data = LazyCsvReader::new(PlRefPath::new("data/us_cities_regions.csv"))
    .finish()
    .unwrap()
    .collect()
    .unwrap();

ScatterGeo::builder()
    .data(&data)
    .lat("lat")
    .lon("lon")
    .mode(Mode::Markers)
    .text("city")
    .group("region")
    .size(15)
    .colors(vec![
        Rgb(255, 0, 0),
        Rgb(0, 255, 0),
        Rgb(0, 0, 255),
        Rgb(255, 165, 0),
    ])
    .plot_title(
        Text::from("Scatter Geo Plot")
            .font("Arial")
            .size(24)
            .x(0.5)
    )
    .legend_title(
        Text::from("Region")
            .size(14)
    )
    .build()
    .plot();

Implementations

impl ScatterGeo

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6>() -> ScatterGeoBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6>

impl ScatterGeo

pub fn try_new( data: &DataFrame, lat: &str, lon: &str, mode: Option<Mode>, text: Option<&str>, group: Option<&str>, sort_groups_by: Option<fn(&str, &str) -> Ordering>, opacity: Option<f64>, size: Option<usize>, color: Option<Rgb>, colors: Option<Vec<Rgb>>, shape: Option<Shape>, shapes: Option<Vec<Shape>>, line_width: Option<f64>, line_color: Option<Rgb>, plot_title: Option<Text>, legend_title: Option<Text>, legend: Option<&Legend>, ) -> Result<Self, PlotlarsError>

pub fn try_builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6>() -> ScatterGeoTryBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6>

Trait Implementations

impl Clone for ScatterGeo

fn clone(&self) -> ScatterGeo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Plot for ScatterGeo

fn ir_traces(&self) -> &[TraceIR]

fn ir_layout(&self) -> &LayoutIR