clusterEach

Description

clusterEach

Parameters

Name	Type	Description
geojson	FeatureCollection	GeoJSON Features
property	string | number	GeoJSON property key/value used to create clusters
callback	clusterEachCallback	a method that takes (cluster, clusterValue, currentIndex)

Returns

void

Examples

var geojson = turf.featureCollection([
  turf.point([0, 0]),
  turf.point([2, 4]),
  turf.point([3, 6]),
  turf.point([5, 1]),
  turf.point([4, 2]),
]);

// Create a cluster using K-Means (adds `cluster` to GeoJSON properties)
var clustered = turf.clustersKmeans(geojson);

// Iterate over each cluster
turf.clusterEach(
  clustered,
  "cluster",
  function (cluster, clusterValue, currentIndex) {
    //= cluster
    //= clusterValue
    //= currentIndex
  },
);

// Calculate the total number of clusters
var total = 0;
turf.clusterEach(clustered, "cluster", function () {
  total++;
});

// Create an Array of all the values retrieved from the 'cluster' property
var values = [];
turf.clusterEach(clustered, "cluster", function (cluster, clusterValue) {
  values.push(clusterValue);
});

Installation

$ npm install @turf/clusters

import { clusterEach } from "@turf/clusters";
const result = clusterEach(...);

$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.clusterEach(...);