Module: ol/layer/STAC

Classes

STACLayer

Type Definitions

APICollection{module:stac-js~APICollection}

Extent{Extent}

GetHeadersFn{GetHeadersFn}

Layer{js}

LayerOptions{LayerOptions}

Link{module:stac-js~Link}

LoadFunction()

layer/STAC.js, line 90

Map{js}

OnErrorFn{OnErrorFn}

Options{Object}

Properties:

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. Don't use this is you pass in a stac-js object as data, set the url manually through setAbsoluteUrl on the stac-js object before passing it in.
data	STAC | Asset | Object | undefined	The STAC metadata. Any of url and data must be provided. data take precedence over url.
children	APICollection | Object | Array.<(module:ol/layer/STAC~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|string)> | undefined	The bands to show. One-based index of the band, or the name of the band.
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 advanced per-source customization such as signed URLs. To add credentials via query parameters, use the getRequestUrl option instead; to send credentials via HTTP headers, use the getRequestHeaders option instead.
getLayerOptions	function | undefined	Optional function that can be used to configure the individual layers that are created for the assets and links. The function can do any additional (asynchronous) work and return the completed options or a promise for the same. The function will be called with the layer type, the current layer options and the STAC Asset or Link. This can be useful to customize the layers, e.g. to apply a style to a GeoTIFF or GeoZarr layer that is loaded from the STAC metadata.
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, Zarr and, if displayGeoTiffByDefault is enabled, GeoTiffs, usually an asset with role overview or visual. Zarr assets other than Web-Optimized Zarr are only displayed if the STAC metadata declares what to render (see the datacube extension) and the store is within the maxDisplayPixels limit.
maxDisplayPixels	number (defaults to 16777216)	The maximum number of pixels the coarsest resolution level of a GeoTIFF or Zarr asset may have to be displayed client-side, as displaying the full extent of an asset loads every tile of that level. Files without (sufficient) overviews can easily exceed this limit. Larger assets are not chosen for the default visualization, and selecting one explicitly through assets reports an error through the error event (or renders through the tile server if buildTileUrlTemplate and useTileLayerAsFallback are set). Set to Infinity to display assets of any size.
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.
style	Style | null (defaults to null)	The style for GeoTIFF and GeoZarr layers (WebGLTileLayer style).
defaultColormap	Array.<(module:ol/color.js~Color|string)> | null (defaults to null)	The colors of the colormap that is used for continuous single-band data when neither the STAC metadata nor the style option define a coloring. The colors are evenly distributed over the value range of the data (e.g. from the STAC statistics). If not set, the data is stretched to grayscale.
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. The function can return null to not pass the given asset or link to the tile server, e.g. to filter by media type or protocol. In this case client-side rendering is used instead.
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. The STAC Asset or Link the request is made for is passed as third parameter, if available.
getRequestHeaders	Object.<string, string> | function (defaults to null)	The HTTP headers (e.g. for authentication) to send with the requests made by this layer, either as a plain object or as a function that returns the headers (or null for none) and is called with the STAC Asset or Link that is shown (if available) and the URL that is requested. Use a function to restrict the headers to specific hosts, as tile server URLs and asset URLs may point to hosts that should not receive the credentials. The headers are attached to requests made by the default httpRequestFn, to GeoTIFF, GeoZarr and PMTiles requests, and via image/tile load functions (through the Fetch API and object URLs) to preview images and XYZ, TileJSON, WMS and WMTS tiles.
getRequestUrl	function (defaults to null)	Rewrites a URL before a request is made or a source is created, e.g. to append query parameters for authentication (signed URLs, API keys). The function is called with the STAC Asset or Link that is shown (if available), the URL, and whether the URL is a tile URL template. It returns the new URL or null to keep the URL unchanged. The rewrite is applied to the initial source URL before getSourceOptions is called; templates discovered in fetched documents (TileJSON manifests, WMTS capabilities) are rewritten afterwards and are not passed to getSourceOptions. For tiled sources the tile URL template is rewritten, not the individual tile URLs. URL templates originate from XYZ web map links, TileJSON manifests, WMTS links (uriTemplate) and capabilities, and buildTileUrlTemplate. The returned URL must keep the template placeholders such as {z} unchanged, i.e. they must not be percent-encoded (e.g. through URL normalization).

STAC{module:stac-js~STAC}

STACObject{module:stac-js~STACObject}

SourceOptions{SourceOptions}

Style{js}