overlapFeaturesGroupMetrics()

function overlapFeaturesGroupMetrics(options): Promise<Metric[]>;

Generate overlap group metrics using overlapFeatures operation

Parameters

Parameter	Type	Description
options	object	-
options.featuresByClass	Record<string, Feature<Polygon, GeoJsonProperties>[]>	features to overlap, keyed by class ID, use empty array if overlapArea operation
options.groupIds	string[]	Group identifiers - will generate group metric for each, even if result in zero value, so pre-filter if want to limit
options.metricId	string	Caller-provided metric ID
options.metrics	object[]	The metrics to group
options.metricToGroup	(sketchMetric) => string	Function that given sketch metric and group name, returns true if sketch is in the group, otherwise false
options.onlyPresentGroups?	boolean	only generate metrics for groups that sketches match to, rather than all
options.sketch	Sketch<Polygon> | SketchCollection<Polygon>	Sketch - single or collection

Returns

Promise<Metric[]>