Skip to content

gi-nx


gi-nx / getLayerContents

ts
function getLayerContents(
   layerNameOrId: string, 
   applyLensFilter?: boolean, 
   bounds?: FeatureCollection, 
   zoomIn?: number, 
   tilesIn?: {
  properties: {
     bbox: [number, number, number, number];
     tile: [number, number];
     zoom: number;
  };
}[]): Promise<FeatureCollection<Geometry, {
[name: string]: any;
}>>;

Get the layer contents filtered by lens and extent of the provided bounds. All {z}/{x}/{y} tiles at zoomIn that intersect with bounds are used.

Parameters

ParameterTypeDescription
layerNameOrIdstringThe layer name or layer ID
applyLensFilterbooleanWhether to apply the lens filter
bounds?FeatureCollectionOptional bounds to filter by
zoomIn?numberOptional zoom level
tilesIn?{ properties: { bbox: [number, number, number, number]; tile: [number, number]; zoom: number; }; }[]Optional tiles to use

Returns

Promise<FeatureCollection<Geometry, { [name: string]: any; }>>