DataOperations interface
Interface representing a Data operations.
Properties
| crop |
Create image from a geojson feature (without format in path). |
| crop |
Create image from a geojson feature with format. |
| crop |
Create image from a geojson feature with dimensions. |
| crop |
Create image from a geojson feature (without format in path). |
| crop |
Create image from a geojson feature with format. |
| crop |
Create image from a geojson feature with dimensions. |
| crop |
Create image from a geojson feature (without format in path). |
| crop |
Create image from a geojson feature with format. |
| crop |
Create image from a geojson feature with dimensions. |
| get |
Generate values and color swatches mapping for a given classmap. |
| get |
Return a list of assets which overlap a given bounding box for a STAC collection. |
| get |
Return a list of assets which overlap a given tile for a STAC collection (with TileMatrixSetId). |
| get |
Return a list of assets which overlap a given tile for a STAC collection (without TileMatrixSetId). |
| get |
Create an image from part of a STAC collection dataset (bounding box crop). |
| get |
Create an image from part of a STAC collection dataset (bounding box crop with dimensions). |
| get |
Return search query info from a STAC collection identifier. |
| get |
Get Point value for a collection dataset. |
| get |
Return a list of assets for a given point in a collection. |
| get |
Create map tile for a STAC collection (with TileMatrixSetId, without scale or format). |
| get |
Create map tile for a STAC collection (with TileMatrixSetId and format, without scale). |
| get |
Create map tile for a STAC collection (with TileMatrixSetId and scale, without format). |
| get |
Create map tile for a STAC collection (with TileMatrixSetId, scale, and format in path). |
| get |
Return TileJSON document for a STAC collection. |
| get |
Return TileJSON document for a STAC collection with TileMatrixSetId as path. |
| get |
Create map tile for a STAC collection (without TileMatrixSetId, scale, or format). |
| get |
Create map tile for a STAC collection (with format, without TileMatrixSetId or scale). |
| get |
Create map tile for a STAC collection (with scale, without TileMatrixSetId or format). |
| get |
Create map tile for a STAC collection (without TileMatrixSetId, with scale and format). |
| get |
Return metadata for a specific tileset of a STAC collection. |
| get |
Return a list of available tilesets for a STAC collection. |
| get |
OGC WMTS endpoint for a STAC collection. |
| get |
OGC WMTS endpoint for a STAC collection with TileMatrixSetId as path. |
| get |
Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow. |
| get |
Per asset statistics for a STAC item. |
| get |
Return a list of supported assets for a STAC item. |
| get |
Create an image from part of a STAC item dataset (bounding box crop). |
| get |
Create an image from part of a STAC item dataset (bounding box crop with dimensions). |
| get |
Return the bounds for a STAC item. |
| get |
Get statistics from a GeoJSON feature for a STAC item. |
| get |
Return dataset's basic info for a STAC item. |
| get |
Return info as GeoJSON for a STAC item. |
| get |
Get point value for a STAC item dataset. |
| get |
Create preview of a STAC item dataset. |
| get |
Create preview of a STAC item dataset with format. |
| get |
Merged assets statistics for a STAC item. |
| get |
Return TileJSON document for a STAC item. |
| get |
Return TileJSON document for a STAC item with TileMatrixSetId as path. |
| get |
OGC WMTS endpoint for a STAC item. |
| get |
OGC WMTS endpoint for a STAC item with TileMatrixSetId as path. |
| get |
Generate a legend image for a given colormap. If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim. |
| get |
Return a list of assets which overlap a given tile. |
| get |
Return a list of assets which overlap a given tile for a mosaic search. |
| get |
Return a list of assets which overlap a given bounding box for a search. |
| get |
Create an image from part of a dataset (bounding box crop). |
| get |
Create an image from part of a dataset (bounding box crop with dimensions). |
| get |
Get Search query metadata. |
| get |
Get Point value for a search dataset. |
| get |
Return a list of assets for a given point in a search. |
| get |
Create map tile (with TileMatrixSetId, without scale or format). |
| get |
Create map tile (with TileMatrixSetId and format, without scale). |
| get |
Create map tile (with TileMatrixSetId and scale, without format). |
| get |
Create map tile (with TileMatrixSetId, scale, and format in path). |
| get |
Return TileJSON document for a search. |
| get |
Return TileJSON document for a search with TileMatrixSetId as path. |
| get |
Create a map tile for a mosaic search. |
| get |
Create a map tile for a mosaic search with specified format. |
| get |
Create a map tile for a mosaic search with specified scale. |
| get |
Create a map tile for a mosaic search with specified scale and format. |
| get |
Return metadata for a specific tileset of a mosaic search. |
| get |
Return a list of available tilesets for a mosaic search. |
| get |
OGC WMTS endpoint. |
| get |
OGC WMTS endpoint with TileMatrixSetId as path. |
| get |
Create map tile from a dataset (without scale or format in path). |
| get |
Create map tile from a dataset (with format in path, without scale). |
| get |
Create map tile from a dataset (with scale in path, without format). |
| get |
Create map tile from a dataset (with TileMatrixSetId, scale, and format in path). |
| get |
Return Matrix List |
| get |
Return Matrix Definition |
| get |
Create map tile from a dataset (without TileMatrixSetId, scale or format in path). |
| get |
Create map tile from a dataset (with format in path, without TileMatrixSetId or scale). |
| get |
Create map tile from a dataset (with scale in path, without TileMatrixSetId or format). |
| get |
Create map tile from a dataset (with scale and format in path, without TileMatrixSetId). |
| get |
Return metadata for a specific tileset of a STAC item. |
| get |
Return a list of available tilesets for a STAC item. |
| register |
Register a Search query |
Property Details
cropCollectionFeature
Create image from a geojson feature (without format in path).
cropCollectionFeature: (collectionId: string, body: Feature, options?: DataCropCollectionFeatureOptionalParams) => Promise<DataCropCollectionFeatureResponse>Property Value
(collectionId: string, body: Feature, options?: DataCropCollectionFeatureOptionalParams) => Promise<DataCropCollectionFeatureResponse>
cropCollectionFeatureByFormat
Create image from a geojson feature with format.
cropCollectionFeatureByFormat: (collectionId: string, format: string, body: Feature, options?: DataCropCollectionFeatureByFormatOptionalParams) => Promise<DataCropCollectionFeatureByFormatResponse>Property Value
(collectionId: string, format: string, body: Feature, options?: DataCropCollectionFeatureByFormatOptionalParams) => Promise<DataCropCollectionFeatureByFormatResponse>
cropCollectionFeatureWidthByHeight
Create image from a geojson feature with dimensions.
cropCollectionFeatureWidthByHeight: (collectionId: string, width: number, height: number, format: string, body: Feature, options?: DataCropCollectionFeatureWidthByHeightOptionalParams) => Promise<DataCropCollectionFeatureWidthByHeightResponse>Property Value
(collectionId: string, width: number, height: number, format: string, body: Feature, options?: DataCropCollectionFeatureWidthByHeightOptionalParams) => Promise<DataCropCollectionFeatureWidthByHeightResponse>
cropFeature
Create image from a geojson feature (without format in path).
cropFeature: (collectionId: string, itemId: string, body: Feature, options?: DataCropFeatureOptionalParams) => Promise<DataCropFeatureResponse>Property Value
(collectionId: string, itemId: string, body: Feature, options?: DataCropFeatureOptionalParams) => Promise<DataCropFeatureResponse>
cropFeatureByFormat
Create image from a geojson feature with format.
cropFeatureByFormat: (collectionId: string, itemId: string, format: string, body: Feature, options?: DataCropFeatureByFormatOptionalParams) => Promise<DataCropFeatureByFormatResponse>Property Value
(collectionId: string, itemId: string, format: string, body: Feature, options?: DataCropFeatureByFormatOptionalParams) => Promise<DataCropFeatureByFormatResponse>
cropFeatureWidthByHeight
Create image from a geojson feature with dimensions.
cropFeatureWidthByHeight: (collectionId: string, itemId: string, width: number, height: number, format: string, body: Feature, options?: DataCropFeatureWidthByHeightOptionalParams) => Promise<DataCropFeatureWidthByHeightResponse>Property Value
(collectionId: string, itemId: string, width: number, height: number, format: string, body: Feature, options?: DataCropFeatureWidthByHeightOptionalParams) => Promise<DataCropFeatureWidthByHeightResponse>
cropSearchFeature
Create image from a geojson feature (without format in path).
cropSearchFeature: (searchId: string, body: Feature, options?: DataCropSearchFeatureOptionalParams) => Promise<DataCropSearchFeatureResponse>Property Value
(searchId: string, body: Feature, options?: DataCropSearchFeatureOptionalParams) => Promise<DataCropSearchFeatureResponse>
cropSearchFeatureByFormat
Create image from a geojson feature with format.
cropSearchFeatureByFormat: (searchId: string, format: string, body: Feature, options?: DataCropSearchFeatureByFormatOptionalParams) => Promise<DataCropSearchFeatureByFormatResponse>Property Value
(searchId: string, format: string, body: Feature, options?: DataCropSearchFeatureByFormatOptionalParams) => Promise<DataCropSearchFeatureByFormatResponse>
cropSearchFeatureWidthByHeight
Create image from a geojson feature with dimensions.
cropSearchFeatureWidthByHeight: (searchId: string, width: number, height: number, format: string, body: Feature, options?: DataCropSearchFeatureWidthByHeightOptionalParams) => Promise<DataCropSearchFeatureWidthByHeightResponse>Property Value
(searchId: string, width: number, height: number, format: string, body: Feature, options?: DataCropSearchFeatureWidthByHeightOptionalParams) => Promise<DataCropSearchFeatureWidthByHeightResponse>
getClassMapLegend
Generate values and color swatches mapping for a given classmap.
getClassMapLegend: (classmapName: string, options?: DataGetClassMapLegendOptionalParams) => Promise<ClassMapLegendResponse>Property Value
(classmapName: string, options?: DataGetClassMapLegendOptionalParams) => Promise<ClassMapLegendResponse>
getCollectionAssetsForBbox
Return a list of assets which overlap a given bounding box for a STAC collection.
getCollectionAssetsForBbox: (collectionId: string, minx: number, miny: number, maxx: number, maxy: number, options?: DataGetCollectionAssetsForBboxOptionalParams) => Promise<DataGetCollectionAssetsForBboxResponse>Property Value
(collectionId: string, minx: number, miny: number, maxx: number, maxy: number, options?: DataGetCollectionAssetsForBboxOptionalParams) => Promise<DataGetCollectionAssetsForBboxResponse>
getCollectionAssetsForTile
Return a list of assets which overlap a given tile for a STAC collection (with TileMatrixSetId).
getCollectionAssetsForTile: (collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetCollectionAssetsForTileOptionalParams) => Promise<TilerAssetGeoJson[]>Property Value
(collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetCollectionAssetsForTileOptionalParams) => Promise<TilerAssetGeoJson[]>
getCollectionAssetsForTileNoTms
Return a list of assets which overlap a given tile for a STAC collection (without TileMatrixSetId).
getCollectionAssetsForTileNoTms: (collectionId: string, z: number, x: number, y: number, options?: DataGetCollectionAssetsForTileNoTmsOptionalParams) => Promise<DataGetCollectionAssetsForTileNoTmsResponse>Property Value
(collectionId: string, z: number, x: number, y: number, options?: DataGetCollectionAssetsForTileNoTmsOptionalParams) => Promise<DataGetCollectionAssetsForTileNoTmsResponse>
getCollectionBboxCrop
Create an image from part of a STAC collection dataset (bounding box crop).
getCollectionBboxCrop: (collectionId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetCollectionBboxCropOptionalParams) => Promise<DataGetCollectionBboxCropResponse>Property Value
(collectionId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetCollectionBboxCropOptionalParams) => Promise<DataGetCollectionBboxCropResponse>
getCollectionBboxCropWithDimensions
Create an image from part of a STAC collection dataset (bounding box crop with dimensions).
getCollectionBboxCropWithDimensions: (collectionId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetCollectionBboxCropWithDimensionsOptionalParams) => Promise<DataGetCollectionBboxCropWithDimensionsResponse>Property Value
(collectionId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetCollectionBboxCropWithDimensionsOptionalParams) => Promise<DataGetCollectionBboxCropWithDimensionsResponse>
getCollectionInfo
Return search query info from a STAC collection identifier.
getCollectionInfo: (collectionId: string, options?: DataGetCollectionInfoOptionalParams) => Promise<TilerStacSearchRegistration>Property Value
(collectionId: string, options?: DataGetCollectionInfoOptionalParams) => Promise<TilerStacSearchRegistration>
getCollectionPoint
Get Point value for a collection dataset.
getCollectionPoint: (collectionId: string, longitude: number, latitude: number, options?: DataGetCollectionPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>Property Value
(collectionId: string, longitude: number, latitude: number, options?: DataGetCollectionPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>
getCollectionPointAssets
Return a list of assets for a given point in a collection.
getCollectionPointAssets: (collectionId: string, longitude: number, latitude: number, options?: DataGetCollectionPointAssetsOptionalParams) => Promise<StacItemPointAsset[]>Property Value
(collectionId: string, longitude: number, latitude: number, options?: DataGetCollectionPointAssetsOptionalParams) => Promise<StacItemPointAsset[]>
getCollectionTile
Create map tile for a STAC collection (with TileMatrixSetId, without scale or format).
getCollectionTile: (collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetCollectionTileOptionalParams) => Promise<DataGetCollectionTileResponse>Property Value
(collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetCollectionTileOptionalParams) => Promise<DataGetCollectionTileResponse>
getCollectionTileByFormat
Create map tile for a STAC collection (with TileMatrixSetId and format, without scale).
getCollectionTileByFormat: (collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetCollectionTileByFormatOptionalParams) => Promise<DataGetCollectionTileByFormatResponse>Property Value
(collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetCollectionTileByFormatOptionalParams) => Promise<DataGetCollectionTileByFormatResponse>
getCollectionTileByScale
Create map tile for a STAC collection (with TileMatrixSetId and scale, without format).
getCollectionTileByScale: (collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetCollectionTileByScaleOptionalParams) => Promise<DataGetCollectionTileByScaleResponse>Property Value
(collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetCollectionTileByScaleOptionalParams) => Promise<DataGetCollectionTileByScaleResponse>
getCollectionTileByScaleAndFormat
Create map tile for a STAC collection (with TileMatrixSetId, scale, and format in path).
getCollectionTileByScaleAndFormat: (collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetCollectionTileByScaleAndFormatOptionalParams) => Promise<DataGetCollectionTileByScaleAndFormatResponse>Property Value
(collectionId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetCollectionTileByScaleAndFormatOptionalParams) => Promise<DataGetCollectionTileByScaleAndFormatResponse>
getCollectionTileJson
Return TileJSON document for a STAC collection.
getCollectionTileJson: (collectionId: string, options?: DataGetCollectionTileJsonOptionalParams) => Promise<TileJsonMetadata>Property Value
(collectionId: string, options?: DataGetCollectionTileJsonOptionalParams) => Promise<TileJsonMetadata>
getCollectionTileJsonByTms
Return TileJSON document for a STAC collection with TileMatrixSetId as path.
getCollectionTileJsonByTms: (collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>Property Value
(collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>
getCollectionTileNoTms
Create map tile for a STAC collection (without TileMatrixSetId, scale, or format).
getCollectionTileNoTms: (collectionId: string, z: number, x: number, y: number, options?: DataGetCollectionTileNoTmsOptionalParams) => Promise<DataGetCollectionTileNoTmsResponse>Property Value
(collectionId: string, z: number, x: number, y: number, options?: DataGetCollectionTileNoTmsOptionalParams) => Promise<DataGetCollectionTileNoTmsResponse>
getCollectionTileNoTmsByFormat
Create map tile for a STAC collection (with format, without TileMatrixSetId or scale).
getCollectionTileNoTmsByFormat: (collectionId: string, z: number, x: number, y: number, format: string, options?: DataGetCollectionTileNoTmsByFormatOptionalParams) => Promise<DataGetCollectionTileNoTmsByFormatResponse>Property Value
(collectionId: string, z: number, x: number, y: number, format: string, options?: DataGetCollectionTileNoTmsByFormatOptionalParams) => Promise<DataGetCollectionTileNoTmsByFormatResponse>
getCollectionTileNoTmsByScale
Create map tile for a STAC collection (with scale, without TileMatrixSetId or format).
getCollectionTileNoTmsByScale: (collectionId: string, z: number, x: number, y: number, scale: number, options?: DataGetCollectionTileNoTmsByScaleOptionalParams) => Promise<DataGetCollectionTileNoTmsByScaleResponse>Property Value
(collectionId: string, z: number, x: number, y: number, scale: number, options?: DataGetCollectionTileNoTmsByScaleOptionalParams) => Promise<DataGetCollectionTileNoTmsByScaleResponse>
getCollectionTileNoTmsByScaleAndFormat
Create map tile for a STAC collection (without TileMatrixSetId, with scale and format).
getCollectionTileNoTmsByScaleAndFormat: (collectionId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetCollectionTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetCollectionTileNoTmsByScaleAndFormatResponse>Property Value
(collectionId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetCollectionTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetCollectionTileNoTmsByScaleAndFormatResponse>
getCollectionTilesetMetadata
Return metadata for a specific tileset of a STAC collection.
getCollectionTilesetMetadata: (collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionTilesetMetadataOptionalParams) => Promise<TileSetMetadata>Property Value
(collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionTilesetMetadataOptionalParams) => Promise<TileSetMetadata>
getCollectionTilesets
Return a list of available tilesets for a STAC collection.
getCollectionTilesets: (collectionId: string, options?: DataGetCollectionTilesetsOptionalParams) => Promise<TileSetList>Property Value
(collectionId: string, options?: DataGetCollectionTilesetsOptionalParams) => Promise<TileSetList>
getCollectionWmtsCapabilities
OGC WMTS endpoint for a STAC collection.
getCollectionWmtsCapabilities: (collectionId: string, options?: DataGetCollectionWmtsCapabilitiesOptionalParams) => Promise<DataGetCollectionWmtsCapabilitiesResponse>Property Value
(collectionId: string, options?: DataGetCollectionWmtsCapabilitiesOptionalParams) => Promise<DataGetCollectionWmtsCapabilitiesResponse>
getCollectionWmtsCapabilitiesByTms
OGC WMTS endpoint for a STAC collection with TileMatrixSetId as path.
getCollectionWmtsCapabilitiesByTms: (collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetCollectionWmtsCapabilitiesByTmsResponse>Property Value
(collectionId: string, tileMatrixSetId: string, options?: DataGetCollectionWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetCollectionWmtsCapabilitiesByTmsResponse>
getIntervalLegend
Generate values and color swatches mapping for a given interval classmap.
Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval.
The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color.
Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.
getIntervalLegend: (classmapName: string, options?: DataGetIntervalLegendOptionalParams) => Promise<DataGetIntervalLegendResponse>Property Value
(classmapName: string, options?: DataGetIntervalLegendOptionalParams) => Promise<DataGetIntervalLegendResponse>
getItemAssetStatistics
Per asset statistics for a STAC item.
getItemAssetStatistics: (collectionId: string, itemId: string, options?: DataGetItemAssetStatisticsOptionalParams) => Promise<AssetStatisticsResponse>Property Value
(collectionId: string, itemId: string, options?: DataGetItemAssetStatisticsOptionalParams) => Promise<AssetStatisticsResponse>
getItemAvailableAssets
Return a list of supported assets for a STAC item.
getItemAvailableAssets: (collectionId: string, itemId: string, options?: DataGetItemAvailableAssetsOptionalParams) => Promise<DataGetItemAvailableAssetsResponse>Property Value
(collectionId: string, itemId: string, options?: DataGetItemAvailableAssetsOptionalParams) => Promise<DataGetItemAvailableAssetsResponse>
getItemBboxCrop
Create an image from part of a STAC item dataset (bounding box crop).
getItemBboxCrop: (collectionId: string, itemId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetItemBboxCropOptionalParams) => Promise<DataGetItemBboxCropResponse>Property Value
(collectionId: string, itemId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetItemBboxCropOptionalParams) => Promise<DataGetItemBboxCropResponse>
getItemBboxCropWithDimensions
Create an image from part of a STAC item dataset (bounding box crop with dimensions).
getItemBboxCropWithDimensions: (collectionId: string, itemId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetItemBboxCropWithDimensionsOptionalParams) => Promise<DataGetItemBboxCropWithDimensionsResponse>Property Value
(collectionId: string, itemId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetItemBboxCropWithDimensionsOptionalParams) => Promise<DataGetItemBboxCropWithDimensionsResponse>
getItemBounds
Return the bounds for a STAC item.
getItemBounds: (collectionId: string, itemId: string, options?: DataGetItemBoundsOptionalParams) => Promise<StacItemBounds>Property Value
(collectionId: string, itemId: string, options?: DataGetItemBoundsOptionalParams) => Promise<StacItemBounds>
getItemFeatureStatistics
Get statistics from a GeoJSON feature for a STAC item.
getItemFeatureStatistics: (collectionId: string, itemId: string, body: Feature, options?: DataGetItemFeatureStatisticsOptionalParams) => Promise<StacItemStatisticsGeoJson>Property Value
(collectionId: string, itemId: string, body: Feature, options?: DataGetItemFeatureStatisticsOptionalParams) => Promise<StacItemStatisticsGeoJson>
getItemInfo
Return dataset's basic info for a STAC item.
getItemInfo: (collectionId: string, itemId: string, options?: DataGetItemInfoOptionalParams) => Promise<TilerInfoMapResponse>Property Value
(collectionId: string, itemId: string, options?: DataGetItemInfoOptionalParams) => Promise<TilerInfoMapResponse>
getItemInfoGeoJson
Return info as GeoJSON for a STAC item.
getItemInfoGeoJson: (collectionId: string, itemId: string, options?: DataGetItemInfoGeoJsonOptionalParams) => Promise<TilerInfoGeoJsonFeature>Property Value
(collectionId: string, itemId: string, options?: DataGetItemInfoGeoJsonOptionalParams) => Promise<TilerInfoGeoJsonFeature>
getItemPoint
Get point value for a STAC item dataset.
getItemPoint: (collectionId: string, itemId: string, longitude: number, latitude: number, options?: DataGetItemPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>Property Value
(collectionId: string, itemId: string, longitude: number, latitude: number, options?: DataGetItemPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>
getItemPreview
Create preview of a STAC item dataset.
getItemPreview: (collectionId: string, itemId: string, options?: DataGetItemPreviewOptionalParams) => Promise<DataGetItemPreviewResponse>Property Value
(collectionId: string, itemId: string, options?: DataGetItemPreviewOptionalParams) => Promise<DataGetItemPreviewResponse>
getItemPreviewWithFormat
Create preview of a STAC item dataset with format.
getItemPreviewWithFormat: (collectionId: string, itemId: string, format: string, options?: DataGetItemPreviewWithFormatOptionalParams) => Promise<DataGetItemPreviewWithFormatResponse>Property Value
(collectionId: string, itemId: string, format: string, options?: DataGetItemPreviewWithFormatOptionalParams) => Promise<DataGetItemPreviewWithFormatResponse>
getItemStatistics
Merged assets statistics for a STAC item.
getItemStatistics: (collectionId: string, itemId: string, options?: DataGetItemStatisticsOptionalParams) => Promise<TilerStacItemStatistics>Property Value
(collectionId: string, itemId: string, options?: DataGetItemStatisticsOptionalParams) => Promise<TilerStacItemStatistics>
getItemTileJson
Return TileJSON document for a STAC item.
getItemTileJson: (collectionId: string, itemId: string, options?: DataGetItemTileJsonOptionalParams) => Promise<TileJsonMetadata>Property Value
(collectionId: string, itemId: string, options?: DataGetItemTileJsonOptionalParams) => Promise<TileJsonMetadata>
getItemTileJsonByTms
Return TileJSON document for a STAC item with TileMatrixSetId as path.
getItemTileJsonByTms: (collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetItemTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetItemTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>
getItemWmtsCapabilities
OGC WMTS endpoint for a STAC item.
getItemWmtsCapabilities: (collectionId: string, itemId: string, options?: DataGetItemWmtsCapabilitiesOptionalParams) => Promise<DataGetItemWmtsCapabilitiesResponse>Property Value
(collectionId: string, itemId: string, options?: DataGetItemWmtsCapabilitiesOptionalParams) => Promise<DataGetItemWmtsCapabilitiesResponse>
getItemWmtsCapabilitiesByTms
OGC WMTS endpoint for a STAC item with TileMatrixSetId as path.
getItemWmtsCapabilitiesByTms: (collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetItemWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetItemWmtsCapabilitiesByTmsResponse>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetItemWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetItemWmtsCapabilitiesByTmsResponse>
getLegend
Generate a legend image for a given colormap.
If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim.
getLegend: (colorMapName: string, options?: DataGetLegendOptionalParams) => Promise<DataGetLegendResponse>Property Value
(colorMapName: string, options?: DataGetLegendOptionalParams) => Promise<DataGetLegendResponse>
getSearchAssetsForTile
Return a list of assets which overlap a given tile.
getSearchAssetsForTile: (searchId: string, tileMatrixSetId: string, collectionId: string, z: number, x: number, y: number, options?: DataGetSearchAssetsForTileOptionalParams) => Promise<TilerAssetGeoJson[]>Property Value
(searchId: string, tileMatrixSetId: string, collectionId: string, z: number, x: number, y: number, options?: DataGetSearchAssetsForTileOptionalParams) => Promise<TilerAssetGeoJson[]>
getSearchAssetsForTileNoTms
Return a list of assets which overlap a given tile for a mosaic search.
getSearchAssetsForTileNoTms: (searchId: string, z: number, x: number, y: number, options?: DataGetSearchAssetsForTileNoTmsOptionalParams) => Promise<DataGetSearchAssetsForTileNoTmsResponse>Property Value
(searchId: string, z: number, x: number, y: number, options?: DataGetSearchAssetsForTileNoTmsOptionalParams) => Promise<DataGetSearchAssetsForTileNoTmsResponse>
getSearchBboxAssets
Return a list of assets which overlap a given bounding box for a search.
getSearchBboxAssets: (searchId: string, minx: number, miny: number, maxx: number, maxy: number, options?: DataGetSearchBboxAssetsOptionalParams) => Promise<DataGetSearchBboxAssetsResponse>Property Value
(searchId: string, minx: number, miny: number, maxx: number, maxy: number, options?: DataGetSearchBboxAssetsOptionalParams) => Promise<DataGetSearchBboxAssetsResponse>
getSearchBboxCrop
Create an image from part of a dataset (bounding box crop).
getSearchBboxCrop: (searchId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetSearchBboxCropOptionalParams) => Promise<DataGetSearchBboxCropResponse>Property Value
(searchId: string, minx: number, miny: number, maxx: number, maxy: number, format: string, options?: DataGetSearchBboxCropOptionalParams) => Promise<DataGetSearchBboxCropResponse>
getSearchBboxCropWithDimensions
Create an image from part of a dataset (bounding box crop with dimensions).
getSearchBboxCropWithDimensions: (searchId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetSearchBboxCropWithDimensionsOptionalParams) => Promise<DataGetSearchBboxCropWithDimensionsResponse>Property Value
(searchId: string, minx: number, miny: number, maxx: number, maxy: number, width: number, height: number, format: string, options?: DataGetSearchBboxCropWithDimensionsOptionalParams) => Promise<DataGetSearchBboxCropWithDimensionsResponse>
getSearchInfo
Get Search query metadata.
getSearchInfo: (searchId: string, options?: DataGetSearchInfoOptionalParams) => Promise<TilerStacSearchRegistration>Property Value
(searchId: string, options?: DataGetSearchInfoOptionalParams) => Promise<TilerStacSearchRegistration>
getSearchPoint
Get Point value for a search dataset.
getSearchPoint: (searchId: string, longitude: number, latitude: number, options?: DataGetSearchPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>Property Value
(searchId: string, longitude: number, latitude: number, options?: DataGetSearchPointOptionalParams) => Promise<TilerCoreModelsResponsesPoint>
getSearchPointWithAssets
Return a list of assets for a given point in a search.
getSearchPointWithAssets: (searchId: string, longitude: number, latitude: number, options?: DataGetSearchPointWithAssetsOptionalParams) => Promise<StacItemPointAsset[]>Property Value
(searchId: string, longitude: number, latitude: number, options?: DataGetSearchPointWithAssetsOptionalParams) => Promise<StacItemPointAsset[]>
getSearchTile
Create map tile (with TileMatrixSetId, without scale or format).
getSearchTile: (searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetSearchTileOptionalParams) => Promise<DataGetSearchTileResponse>Property Value
(searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetSearchTileOptionalParams) => Promise<DataGetSearchTileResponse>
getSearchTileByFormat
Create map tile (with TileMatrixSetId and format, without scale).
getSearchTileByFormat: (searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetSearchTileByFormatOptionalParams) => Promise<DataGetSearchTileByFormatResponse>Property Value
(searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetSearchTileByFormatOptionalParams) => Promise<DataGetSearchTileByFormatResponse>
getSearchTileByScale
Create map tile (with TileMatrixSetId and scale, without format).
getSearchTileByScale: (searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetSearchTileByScaleOptionalParams) => Promise<DataGetSearchTileByScaleResponse>Property Value
(searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetSearchTileByScaleOptionalParams) => Promise<DataGetSearchTileByScaleResponse>
getSearchTileByScaleAndFormat
Create map tile (with TileMatrixSetId, scale, and format in path).
getSearchTileByScaleAndFormat: (searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetSearchTileByScaleAndFormatOptionalParams) => Promise<DataGetSearchTileByScaleAndFormatResponse>Property Value
(searchId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetSearchTileByScaleAndFormatOptionalParams) => Promise<DataGetSearchTileByScaleAndFormatResponse>
getSearchTileJson
Return TileJSON document for a search.
getSearchTileJson: (searchId: string, options?: DataGetSearchTileJsonOptionalParams) => Promise<TileJsonMetadata>Property Value
(searchId: string, options?: DataGetSearchTileJsonOptionalParams) => Promise<TileJsonMetadata>
getSearchTileJsonByTms
Return TileJSON document for a search with TileMatrixSetId as path.
getSearchTileJsonByTms: (searchId: string, tileMatrixSetId: string, options?: DataGetSearchTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>Property Value
(searchId: string, tileMatrixSetId: string, options?: DataGetSearchTileJsonByTmsOptionalParams) => Promise<TileJsonMetadata>
getSearchTileNoTms
Create a map tile for a mosaic search.
getSearchTileNoTms: (searchId: string, z: number, x: number, y: number, options?: DataGetSearchTileNoTmsOptionalParams) => Promise<DataGetSearchTileNoTmsResponse>Property Value
(searchId: string, z: number, x: number, y: number, options?: DataGetSearchTileNoTmsOptionalParams) => Promise<DataGetSearchTileNoTmsResponse>
getSearchTileNoTmsByFormat
Create a map tile for a mosaic search with specified format.
getSearchTileNoTmsByFormat: (searchId: string, z: number, x: number, y: number, format: string, options?: DataGetSearchTileNoTmsByFormatOptionalParams) => Promise<DataGetSearchTileNoTmsByFormatResponse>Property Value
(searchId: string, z: number, x: number, y: number, format: string, options?: DataGetSearchTileNoTmsByFormatOptionalParams) => Promise<DataGetSearchTileNoTmsByFormatResponse>
getSearchTileNoTmsByScale
Create a map tile for a mosaic search with specified scale.
getSearchTileNoTmsByScale: (searchId: string, z: number, x: number, y: number, scale: number, options?: DataGetSearchTileNoTmsByScaleOptionalParams) => Promise<DataGetSearchTileNoTmsByScaleResponse>Property Value
(searchId: string, z: number, x: number, y: number, scale: number, options?: DataGetSearchTileNoTmsByScaleOptionalParams) => Promise<DataGetSearchTileNoTmsByScaleResponse>
getSearchTileNoTmsByScaleAndFormat
Create a map tile for a mosaic search with specified scale and format.
getSearchTileNoTmsByScaleAndFormat: (searchId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetSearchTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetSearchTileNoTmsByScaleAndFormatResponse>Property Value
(searchId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetSearchTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetSearchTileNoTmsByScaleAndFormatResponse>
getSearchTilesetMetadata
Return metadata for a specific tileset of a mosaic search.
getSearchTilesetMetadata: (searchId: string, tileMatrixSetId: string, options?: DataGetSearchTilesetMetadataOptionalParams) => Promise<TileSetMetadata>Property Value
(searchId: string, tileMatrixSetId: string, options?: DataGetSearchTilesetMetadataOptionalParams) => Promise<TileSetMetadata>
getSearchTilesets
Return a list of available tilesets for a mosaic search.
getSearchTilesets: (searchId: string, options?: DataGetSearchTilesetsOptionalParams) => Promise<TileSetList>Property Value
(searchId: string, options?: DataGetSearchTilesetsOptionalParams) => Promise<TileSetList>
getSearchWmtsCapabilities
OGC WMTS endpoint.
getSearchWmtsCapabilities: (searchId: string, options?: DataGetSearchWmtsCapabilitiesOptionalParams) => Promise<DataGetSearchWmtsCapabilitiesResponse>Property Value
(searchId: string, options?: DataGetSearchWmtsCapabilitiesOptionalParams) => Promise<DataGetSearchWmtsCapabilitiesResponse>
getSearchWmtsCapabilitiesByTms
OGC WMTS endpoint with TileMatrixSetId as path.
getSearchWmtsCapabilitiesByTms: (searchId: string, tileMatrixSetId: string, options?: DataGetSearchWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetSearchWmtsCapabilitiesByTmsResponse>Property Value
(searchId: string, tileMatrixSetId: string, options?: DataGetSearchWmtsCapabilitiesByTmsOptionalParams) => Promise<DataGetSearchWmtsCapabilitiesByTmsResponse>
getTile
Create map tile from a dataset (without scale or format in path).
getTile: (collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetTileOptionalParams) => Promise<DataGetTileResponse>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, options?: DataGetTileOptionalParams) => Promise<DataGetTileResponse>
getTileByFormat
Create map tile from a dataset (with format in path, without scale).
getTileByFormat: (collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetTileByFormatOptionalParams) => Promise<DataGetTileByFormatResponse>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, format: string, options?: DataGetTileByFormatOptionalParams) => Promise<DataGetTileByFormatResponse>
getTileByScale
Create map tile from a dataset (with scale in path, without format).
getTileByScale: (collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetTileByScaleOptionalParams) => Promise<DataGetTileByScaleResponse>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, options?: DataGetTileByScaleOptionalParams) => Promise<DataGetTileByScaleResponse>
getTileByScaleAndFormat
Create map tile from a dataset (with TileMatrixSetId, scale, and format in path).
getTileByScaleAndFormat: (collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetTileByScaleAndFormatOptionalParams) => Promise<DataGetTileByScaleAndFormatResponse>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetTileByScaleAndFormatOptionalParams) => Promise<DataGetTileByScaleAndFormatResponse>
getTileMatrices
Return Matrix List
getTileMatrices: (options?: DataGetTileMatricesOptionalParams) => Promise<DataGetTileMatricesResponse>Property Value
(options?: DataGetTileMatricesOptionalParams) => Promise<DataGetTileMatricesResponse>
getTileMatrixDefinitions
Return Matrix Definition
getTileMatrixDefinitions: (tileMatrixSetId: string, options?: DataGetTileMatrixDefinitionsOptionalParams) => Promise<TileMatrixSet>Property Value
(tileMatrixSetId: string, options?: DataGetTileMatrixDefinitionsOptionalParams) => Promise<TileMatrixSet>
getTileNoTms
Create map tile from a dataset (without TileMatrixSetId, scale or format in path).
getTileNoTms: (collectionId: string, itemId: string, z: number, x: number, y: number, options?: DataGetTileNoTmsOptionalParams) => Promise<DataGetTileNoTmsResponse>Property Value
(collectionId: string, itemId: string, z: number, x: number, y: number, options?: DataGetTileNoTmsOptionalParams) => Promise<DataGetTileNoTmsResponse>
getTileNoTmsByFormat
Create map tile from a dataset (with format in path, without TileMatrixSetId or scale).
getTileNoTmsByFormat: (collectionId: string, itemId: string, z: number, x: number, y: number, format: string, options?: DataGetTileNoTmsByFormatOptionalParams) => Promise<DataGetTileNoTmsByFormatResponse>Property Value
(collectionId: string, itemId: string, z: number, x: number, y: number, format: string, options?: DataGetTileNoTmsByFormatOptionalParams) => Promise<DataGetTileNoTmsByFormatResponse>
getTileNoTmsByScale
Create map tile from a dataset (with scale in path, without TileMatrixSetId or format).
getTileNoTmsByScale: (collectionId: string, itemId: string, z: number, x: number, y: number, scale: number, options?: DataGetTileNoTmsByScaleOptionalParams) => Promise<DataGetTileNoTmsByScaleResponse>Property Value
(collectionId: string, itemId: string, z: number, x: number, y: number, scale: number, options?: DataGetTileNoTmsByScaleOptionalParams) => Promise<DataGetTileNoTmsByScaleResponse>
getTileNoTmsByScaleAndFormat
Create map tile from a dataset (with scale and format in path, without TileMatrixSetId).
getTileNoTmsByScaleAndFormat: (collectionId: string, itemId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetTileNoTmsByScaleAndFormatResponse>Property Value
(collectionId: string, itemId: string, z: number, x: number, y: number, scale: number, format: string, options?: DataGetTileNoTmsByScaleAndFormatOptionalParams) => Promise<DataGetTileNoTmsByScaleAndFormatResponse>
getTilesetMetadata
Return metadata for a specific tileset of a STAC item.
getTilesetMetadata: (collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetTilesetMetadataOptionalParams) => Promise<TileSetMetadata>Property Value
(collectionId: string, itemId: string, tileMatrixSetId: string, options?: DataGetTilesetMetadataOptionalParams) => Promise<TileSetMetadata>
getTilesets
Return a list of available tilesets for a STAC item.
getTilesets: (collectionId: string, itemId: string, options?: DataGetTilesetsOptionalParams) => Promise<TileSetList>Property Value
(collectionId: string, itemId: string, options?: DataGetTilesetsOptionalParams) => Promise<TileSetList>
registerMosaicsSearch
Register a Search query
registerMosaicsSearch: (options?: DataRegisterMosaicsSearchOptionalParams) => Promise<TilerMosaicSearchRegistrationResponse>Property Value
(options?: DataRegisterMosaicsSearchOptionalParams) => Promise<TilerMosaicSearchRegistrationResponse>
