@seasketch/geoprocessing/dist/src/toolbox/area.d.ts

Geoprocessing and reporting framework for SeaSketch 2.0

import { Sketch, SketchCollection, Polygon, Metric } from "../types/index.js";
/**
 * Calculates the area of each sketch and collection.
 */
export declare function area(
/** single sketch or collection. */
sketch: Sketch<Polygon> | SketchCollection<Polygon>, options?: {
    /** Optional metric identifier, defaults to 'area' */
    metricId?: string;
    /** If sketch collection, will include its child sketch metrics in addition to collection metrics, defaults to true */
    includeChildMetrics?: boolean;
    /** If collection, includes metrics with percent of total area for each sketch , in addition to raw area value metrics, defaults to false */
    includePercMetric?: boolean;
}): Promise<Metric[]>;