Struct ScatterMap 

pub struct ScatterMap { /* private fields */ }

A structure representing a scatter plot on a map.

The ScatterMap struct allows for visualizing geographical data points on an interactive map. Each data point is defined by its latitude and longitude, with additional options for grouping, coloring, size, opacity, and map configuration such as zoom level and center coordinates. This struct is ideal for displaying spatial data distributions, such as city locations or geospatial datasets.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• latitude - A string slice specifying the column name containing latitude values.
• longitude - A string slice specifying the column name containing longitude values.
• center - An optional array [f64; 2] specifying the initial center point of the map ([latitude, longitude]).
• zoom - An optional u8 specifying the initial zoom level of the map.
• group - An optional string slice specifying the column name for grouping data points (e.g., by city or category).
• 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 between 0.0 and 1.0 specifying the opacity of the points.
• size - An optional usize specifying the size of the scatter points.
• color - An optional Rgb value specifying the color of the points (if no grouping is applied).
• colors - An optional vector of Rgb values specifying colors for grouped points.
• shape - An optional Shape enum specifying the marker shape for the points.
• shapes - An optional vector of Shape enums specifying shapes for grouped points.
• 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 (e.g., positioning, font, etc.).

Example

Basic Scatter Map Plot

use polars::prelude::*;
use plotlars::{Plot, ScatterMap, Text};

let dataset = LazyCsvReader::new(PlPath::new("data/cities.csv"))
    .finish()
    .unwrap()
    .collect()
    .unwrap();

ScatterMap::builder()
    .data(&dataset)
    .latitude("latitude")
    .longitude("longitude")
    .center([48.856613, 2.352222])
    .zoom(4)
    .group("city")
    .opacity(0.5)
    .size(12)
    .plot_title(
        Text::from("Scatter Map")
            .font("Arial")
            .size(18)
    )
    .legend_title("cities")
    .build()
    .plot();

Implementations

impl ScatterMap

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

Examples found in repository

examples/scattermap.rs (line 12)

fn main() {
    let dataset = LazyCsvReader::new(PlPath::new("data/cities.csv"))
        .finish()
        .unwrap()
        .collect()
        .unwrap();

    ScatterMap::builder()
        .data(&dataset)
        .latitude("latitude")
        .longitude("longitude")
        .center([48.856613, 2.352222])
        .zoom(4)
        .group("city")
        .opacity(0.5)
        .size(12)
        .plot_title(Text::from("Scatter Map").font("Arial").size(18))
        .legend_title("cities")
        .build()
        .plot();
}

Trait Implementations

impl Clone for ScatterMap

fn clone(&self) -> ScatterMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PlotHelper for ScatterMap

fn get_layout(&self) -> &LayoutPlotly

fn get_traces(&self) -> &Vec<Box<dyn Trace + 'static>>

impl Serialize for ScatterMap

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

where __S: Serializer,

Serialize this value into the given Serde serializer.