s2-tools/dist/tools/polylabel.d.ts

A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.

import { Properties, VectorMultiPolygon, VectorPoint, VectorPolygon } from '../geometry';
/** The metadata inserted into the Vector Feature */
export interface PolyLabelMetadata extends Properties {
    distance: number;
}
/**
 * # Polylabels
 *
 * ## Description
 * Find the labels for a collection of vector polygons
 *
 * ## Usage
 * ```ts
 * import { polylabels } from 's2-tools'
 * import type { VectorMultiPolygon } from 's2-tools'
 *
 * const vectorGeometry: VectorMultiPolygon = [];
 * const polylabelHighPrecision = polylabels(vectorGeometry, 1);
 * ```
 * @param polygons - A collection of vector polygons to find the labels for
 * @param precision - the precision of the label
 * @returns - the labels
 */
export declare function polylabels(polygons: VectorMultiPolygon, precision?: number): VectorPoint<PolyLabelMetadata>[];
/**
 * # Polylabel
 *
 * ## Description
 * Find the label for a vector polygon
 *
 * ## Usage
 * ```ts
 * import { polylabel } from 's2-tools'
 * import type { VectorPolygon } from 's2-tools'
 *
 * const vectorGeometry: VectorPolygon = [];
 * const polylabelHighPrecision = polylabel(vectorGeometry, 1);
 * ```
 * @param polygon - the vector polygon to find the label for
 * @param precision - the precision of the label
 * @returns - the label
 */
export declare function polylabel(polygon: VectorPolygon, precision?: number): VectorPoint<PolyLabelMetadata>;
//# sourceMappingURL=polylabel.d.ts.map