Struct Supercluster

pub struct Supercluster {
    pub points: Vec<Feature>,
    /* private fields */
}

A spatial clustering configuration and data structure.

Fields

points: Vec<Feature>

Input data points.

Implementations

impl Supercluster

pub fn new(options: Options) -> Self

Create a new instance of Supercluster with the specified configuration settings.

Arguments

• options: The configuration options for Supercluster.

Returns

A new Supercluster instance with the given configuration.

pub fn load(&mut self, points: Vec<Feature>) -> &mut Self

Load the FeatureCollection Object into the Supercluster instance, performing clustering at various zoom levels.

Arguments

• points: A vector of GeoJSON features representing input points to be clustered.

Returns

A mutable reference to the updated Supercluster instance.

pub fn get_clusters(&self, bbox: [f64; 4], zoom: u8) -> Vec<Feature>

Retrieve clustered features within the specified bounding box and zoom level.

Arguments

• bbox: The bounding box as an array of four coordinates [min_lng, min_lat, max_lng, max_lat].
• zoom: The zoom level at which to retrieve clusters.

Returns

A vector of GeoJSON features representing the clusters within the specified bounding box and zoom level.

pub fn get_children( &self, cluster_id: usize, ) -> Result<Vec<Feature>, &'static str>

Retrieve the cluster features for a specified cluster ID.

Arguments

• cluster_id: The unique identifier of the cluster.

Returns

A Result containing a vector of GeoJSON features representing the children of the specified cluster if successful, or an error message if the cluster is not found.

pub fn get_leaves( &self, cluster_id: usize, limit: usize, offset: usize, ) -> Vec<Feature>

Retrieve individual leaf features within a cluster.

Arguments

• cluster_id: The unique identifier of the cluster.
• limit: The maximum number of leaf features to retrieve.
• offset: The offset to start retrieving leaf features.

Returns

A vector of GeoJSON features representing the individual leaf features within the cluster.

pub fn get_tile(&self, z: u8, x: f64, y: f64) -> Option<FeatureCollection>

Retrieve a vector of features within a tile at the given zoom level and tile coordinates.

Arguments

• z: The zoom level of the tile.
• x: The X coordinate of the tile.
• y: The Y coordinate of the tile.

Returns

An optional Tile containing a vector of GeoJSON features within the specified tile, or None if there are no features.

pub fn get_cluster_expansion_zoom(&self, cluster_id: usize) -> usize

Determine the zoom level at which a specific cluster expands.

Arguments

• cluster_id: The unique identifier of the cluster.

Returns

The zoom level at which the cluster expands.

Trait Implementations

impl Clone for Supercluster

fn clone(&self) -> Supercluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Supercluster

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

Formats the value using the given formatter.