@seasketch/geoprocessing
Version:
Geoprocessing and reporting framework for SeaSketch 2.0
122 lines (121 loc) • 6.78 kB
TypeScript
import { Sketch, SketchCollection, Feature, Polygon, MultiPolygon, LineString, Point, SketchMap, FeatureMap, SketchGeometryTypes } from "../../src/types/index.js";
/**
* Reads all files from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExampleSketchAll(partialName?: string): Promise<Array<Sketch | SketchCollection>>;
/**
* Reads all Polygon sketch and sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePolygonSketchAll(partialName?: string): Promise<Array<Sketch<Polygon> | SketchCollection<Polygon>>>;
/**
* Reads all MultiPolygon sketch and sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExampleMultiPolygonSketchAll(partialName?: string): Promise<Array<Sketch<MultiPolygon> | SketchCollection<MultiPolygon>>>;
/**
* Reads all polygon type (Polygon or MultiPolygon) sketch and sketch
* collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePolygonAllSketchAll(partialName?: string): Promise<Array<Sketch<Polygon | MultiPolygon> | SketchCollection<Polygon | MultiPolygon>>>;
/**
* Reads all LineString sketch and sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExampleLineStringSketchAll(partialName?: string): Promise<Array<Sketch<LineString> | SketchCollection<LineString>>>;
/**
* Reads all Point sketch and sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePointSketchAll(partialName?: string): Promise<Array<Sketch<Point> | SketchCollection<Point>>>;
/**
* Reads all sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExampleSketches(partialName?: string): Promise<Array<Sketch>>;
/**
* Reads all Polygon sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePolygonSketches(partialName?: string): Promise<Array<Sketch<Polygon>>>;
/**
* Reads all MultiPolygon sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExampleMultiPolygonSketches(partialName?: string): Promise<Array<Sketch<MultiPolygon>>>;
/**
* Reads all Polygon or MultiPolygon sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePolygonAllSketches(partialName?: string): Promise<Array<Sketch<Polygon | MultiPolygon>>>;
/**
* Reads all Linestring sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExampleLineStringSketches(partialName?: string): Promise<Array<Sketch<LineString>>>;
/**
* Reads all Point sketches from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePointSketches(partialName?: string): Promise<Array<Sketch<Point>>>;
/**
* Reads all sketche collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExampleSketchCollections(partialName?: string): Promise<Array<SketchCollection>>;
/**
* Reads all Polygon sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePolygonSketchCollections(partialName?: string): Promise<Array<SketchCollection<Polygon>>>;
/**
* Reads all Linestring sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExampleLineStringSketchCollections(partialName?: string): Promise<Array<SketchCollection<LineString>>>;
/**
* Reads all Point sketch collections from examples/sketches for testing. Run from project root
* Optionally filters out those that don't match partialName
* TODO: remove cast if possible
*/
export declare function getExamplePointSketchCollections(partialName?: string): Promise<Array<SketchCollection<Point>>>;
/**
* Convenience function returns object with sketches keyed by name
* Optionally filters out those that don't match partialName
* @deprecated use partialName support in getExample*Sketches(partialName) functions
*/
export declare function getExampleSketchesByName(partialName?: string): Promise<SketchMap>;
/**
* Reads features and featurecollections from examples/features for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExampleFeaturesAll(partialName?: string): Promise<Feature<SketchGeometryTypes, import("geojson").GeoJsonProperties>[]>;
/**
* Reads features of all types from examples/features for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExampleFeatures(partialName?: string): Promise<Feature<import("geojson").Geometry, import("geojson").GeoJsonProperties>[]>;
/**
* Reads features of all types from examples/features for testing. Run from project root
* Optionally filters out those that don't match partialName
*/
export declare function getExamplePolygonFeatures(partialName?: string): Promise<Feature<Polygon, import("geojson").GeoJsonProperties>[]>;
/**
* Convenience function returns object with features keyed by their filename. Features without a name will not be included
* Optionally filters out those that don't match partialName
*/
export declare function getExampleFeaturesByName(partialName?: string): Promise<FeatureMap>;