Class: STACLayer

Methods

addLayerForLink(link){Promise.<(Array.<module:ol/layer/STAC~Layer>|undefined)>}

layer/STAC.js, line 548

Adds a layer for a link that implements the web-map-links extension. Supports: PMTiles, TileJSON, WMS, WMTS, XYZ

Name	Type	Description
link	Link	A web map link

See:

• https://github.com/stac-extensions/web-map-links

Returns:

Resolves with a list of layers or undefined when complete.

getAssets(){Array.<Asset>}

layer/STAC.js, line 1144

Get the STAC assets shown.

Returns:

The STAC assets.

getAttributions(){Array.<string>}

layer/STAC.js, line 1190

Get the attributions of the STAC entity assigned to this layer.

Returns:

Attributions for this layer.

getBoundsLayer(){VectorLayer | null}

layer/STAC.js, line 338

Returns the vector layer that visualizes the bounds / footprint.

Returns:

The vector layer for the bounds

getChildren(){Array.<STAC>}

layer/STAC.js, line 1134

Get the children STAC entities.

Returns:

The STAC child entities.

getData(){STAC | Asset}

layer/STAC.js, line 1124

Get the STAC object.

Returns:

The STAC object.

getExtent(){Extent | undefined}

layer/STAC.js, line 1157

Get the extent of the layer. If displayFootprint is set to false, the extent is always returned in EPSG:4326 instead of the map projection. Make sure to transform it with the ol.proj.transformExtent function if needed.

Returns:

The layer extent.

getWebMapLinks(){Array<Link>}

layer/STAC.js, line 1022

Returns all potential web map links based on the given value for displayWebMapLink.

Returns:

An array of links.

hasOnlyBounds(){boolean}

layer/STAC.js, line 1009

Indicates whether the LayerGroup shows only the bounds layer (i.e. no imagery/tile layers).

Returns:

true if only the bounds layer is shown, false otherwise.

isEmpty(){boolean}

layer/STAC.js, line 350

Returns true if the layer shows nothing.

This method should be called after the layersready event only.

Returns:

Is the layer empty?

setAssets(assets){Promise}

layer/STAC.js, line 1063

Update the assets to be rendered.

Name	Type	Description
assets	Array.<(string|Asset)> | null	The assets to show.

Returns:

Resolves when all assets are rendered.

setChildren(childs, options){Promise}

layer/STAC.js, line 1091

Updates the children STAC entities to be rendered.

If an object is passed, it must be a GeoJSON FeatureCollection.

Name	Type	Description
childs	ItemCollection | Object | Array.<(STAC|Object)> | null	The children to show.
options	STACLayer options for the children. Only applies if children are given. Name Type Description url string | undefined The STAC URL. Any of url and data must be provided. Can also be used as url for data, if it is absolute and doesn't contain a self link. data STAC | Asset | Object | undefined The STAC metadata. Any of url and data must be provided. data take precedence over url. children ItemCollection | Object | Array.<(STAC|Object)> | null (defaults to null) For STAC Catalogs and Collections, any child entites to show. Can be STAC ItemCollections (as ItemCollection or GeoJSON FeatureCollection) or a list of STAC entities. childrenOptions Options (defaults to {}) The the given children, apply the given options. assets Array.<(string|Asset)> | null (defaults to null) The selector for the assets to be rendered, only for STAC Items and Collections. This can be an array of strings corresponding to asset keys or Asset objects. null shows the default asset, an empty array shows no asset. bands Array.<number> | undefined The (one-based) bands to show. getSourceOptions function | undefined Optional function that can be used to configure the underlying sources. The function can do any additional work and return the completed options or a promise for the same. The function will be called with the current source options and the STAC Asset or Link. This can be useful for adding auth information such as an API token, either via query parameter or HTTP headers. Please be aware that sending HTTP headers may not be supported by all sources. displayFootprint boolean (defaults to true) Allows to hide the footprints (bounding box/geometry) of the STAC object by default. displayGeoTiffByDefault boolean (defaults to false) Allow to choose non-cloud-optimized GeoTiffs as default image to show, which might not work well for larger files or larger amounts of files. displayPreview boolean (defaults to false) Allow to display preview images that a browser can display (e.g. PNG, JPEG), i.e. assets with any of the roles thumbnail, overview, or a link with relation type preview. The previews are usually not covering the full extents and as such may be placed incorrectly on the map. For performance reasons, it is recommended to enable this option if you pass in STAC API Items instead of displayOverview. displayOverview boolean (defaults to true) Allow to display COGs and, if displayGeoTiffByDefault is enabled, GeoTiffs, usually an asset with role overview or visual. displayWebMapLink string | boolean | Array.<(module:ol/layer/STAC~Link|string)> (defaults to false) Allow to display a layer based on the information provided through the web map links extension. If an array of links or link ids (property id in a Link Object) is provided, all corresponding layers will be shown. If set to true or to a specific type of web map link (pmtiles, tilejson, wms, wmts, xyz), it lets this library choose a web map link to show, but only if no other data is shown. To disable the functionality set this to false. boundsStyle Style | undefined The style for the overall bounds / footprint. collectionStyle Style | undefined The style for individual children in a list of STAC Items or Collections. crossOrigin null | string | undefined For thumbnails: The crossOrigin attribute for loaded images / tiles. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. buildTileUrlTemplate function (defaults to null) A function that generates a URL template for a tile server (XYZ), which will be used instead of the client-side GeoTIFF rendering (except if useTileLayerAsFallback is true). The function provided can return a promise (i.e. be async) or a string. useTileLayerAsFallback boolean (defaults to false) Uses the given URL template only when the client-side GeoTIFF rendering fails. opacity number (defaults to 1) Opacity (0, 1). visible boolean (defaults to true) Visibility. extent Extent | undefined The bounding extent for layer rendering. The layer will not be rendered outside of this extent. zIndex number | undefined The z-index for layer rendering. At rendering time, the layers will be ordered, first by Z-index and then by position. When undefined, a zIndex of 0 is assumed for layers that are added to the map's layers collection, or Infinity when the layer's setMap() method was used. minResolution number | undefined The minimum resolution (inclusive) at which this layer will be visible. maxResolution number | undefined The maximum resolution (exclusive) below which this layer will be visible. minZoom number | undefined The minimum view zoom level (exclusive) above which this layer will be visible. maxZoom number | undefined The maximum view zoom level (inclusive) at which this layer will be visible. properties Object.<string, *> | undefined Arbitrary observable properties. Can be accessed with #get() and #set(). stac and bounds are reserved and may be overridden. disableMigration boolean (defaults to false) Disable the migration of the STAC object to the latest version. Only enable this if you are sure that the STAC object is already in the latest version. httpRequestFn function (defaults to null) Sets a custom function to make HTTP requests with. The first parameter is the URL to request and the output is a promise that resolves with the response body. The second parameter is the return type, either json (default) or text.

Returns:

Resolves when all items are rendered.