GeoTIFF~GeoTIFFSource

import GeoTIFFSource from 'ol/source/GeoTIFF.js';

A source for working with GeoTIFF data. Note for users of the full build: The GeoTIFF source requires the geotiff.js library to be loaded as well.

new GeoTIFFSource(options) source/GeoTIFF.js, line 456

Name	Type	Description
`attributions`	AttributionLike \| undefined	Attributions.
`sources`	Array<SourceInfo>	List of information about GeoTIFF sources. Multiple sources can be combined when their resolution sets are equal after applying a scale. The list of sources defines a mapping between input bands as they are read from each GeoTIFF and the output bands that are provided by data tiles. To control which bands to read from each GeoTIFF, use the `bands` property. If, for example, you specify two sources, one with 3 bands and `nodata` configured, and another with 1 band, the resulting data tiles will have 5 bands: 3 from the first source, 1 alpha band from the first source, and 1 band from the second source.
`sourceOptions`	GeoTIFFSourceOptions \| undefined	Additional options to be passed to geotiff.js's `fromUrl` or `fromUrls` methods.
`convertToRGB`	true \| false \| 'auto' (defaults to false)	By default, bands from the sources are read as-is. When reading GeoTIFFs with the purpose of displaying them as RGB images, setting this to `true` will convert other color spaces (YCbCr, CMYK) to RGB. Setting the option to `'auto'` will make it so CMYK, YCbCr, CIELab, and ICCLab images will automatically be converted to RGB.
`normalize`	boolean (defaults to true)	By default, the source data is normalized to values between 0 and 1 with scaling factors based on the raster statistics or `min` and `max` properties of each source. If instead you want to work with the raw values in a style expression, set this to `false`. Setting this option to `false` will make it so any `min` and `max` properties on sources are ignored.
`projection`	ProjectionLike \| undefined	Source projection. If not provided, the GeoTIFF metadata will be read for projection information.
`loadMissingProjection`	boolean (defaults to false)	Whether to attempt to load missing projection definitions. Uses the pre-configured projection lookup function, which can be customized with `setProjectionCodeLookup`.
`transition`	number (defaults to 250)	Duration of the opacity transition for rendering. To disable the opacity transition, pass `transition: 0`.
`wrapX`	boolean (defaults to false)	Render tiles beyond the tile grid extent.
`interpolate`	boolean (defaults to true)	Use interpolated values when resampling. By default, the linear interpolation is used to resample the data. If false, nearest neighbor is used.

Fires:

change (BaseEvent) - Generic change event. Triggered when the revision counter is increased.
error (BaseEvent) - Generic error event. Triggered when an error occurs.
propertychange (ObjectEvent) - Triggered when a property is changed.
tileloadend (TileSourceEvent) - Triggered when a tile finishes loading, either when its data is loaded, or when loading was aborted because the tile is no longer needed.
tileloaderror (TileSourceEvent) - Triggered if tile loading results in an error. Note that this is not the right place to re-fetch tiles. See load for details.
tileloadstart (TileSourceEvent) - Triggered when a tile starts loading.

Extends

DataTileSource

Methods

changed() inherited Observable.js, line 68

Increases the revision counter and dispatches a 'change' event.

clear() inherited source/Tile.js, line 258

Remove all cached reprojected tiles from the source. The next render cycle will create new tiles.

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.

Name	Type	Description
`event`	BaseEvent \| string	Event object.

Returns:

false if anyone called preventDefault on the event object or if any of the listeners returned false.

get(key){*} inherited Object.js, line 136

Gets a value.

Name	Type	Description
`key`	string	Key name.

Returns:

Value.

getAttributions(){Attribution} inherited source/Source.js, line 129

Get the attribution function for the source.

Returns:

Attribution function.

getAttributionsCollapsible(){boolean} inherited source/Source.js, line 137

Returns:

Attributions are collapsible.

getKeys(){Array.<string>} inherited Object.js, line 149

Get a list of object property names.

Returns:

List of property names.

getProjection(){Projection | null} inherited source/Source.js, line 146

Get the projection of the source.

Returns:

Projection.

getProperties(){NoInfer.<Properties>} inherited Object.js, line 158

Get an object of all property names and values.

Returns:

Object.

getRevision(){number} inherited Observable.js, line 79

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:

Revision.

getState(){State} inherited source/Source.js, line 201

Get the state of the source, see State for possible states.

Returns:

State.

getTileGrid(){TileGrid | null} inherited source/Tile.js, line 190

Return the tile grid of the tile source.

Returns:

Tile grid.

getView(){Promise<ViewOptions>} source/GeoTIFF.js, line 1188

Get a promise for view properties based on the source. Use the result of this function as the view option in a map constructor.

const source = new GeoTIFF(options);

const map = new Map({
  target: 'map',
  layers: [
    new TileLayer({
      source: source,
    }),
  ],
  view: source.getView(),
});

Returns:

A promise for view-related properties.

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

Listen for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

Listen once for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

Returns:

Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.

refresh() inherited source/Source.js, line 223

Refreshes the source. The source will be cleared, and data from the server will be reloaded.

set(key, value, silent) inherited Object.js, line 218

Sets a value.

Name	Type	Description
`key`	string	Key name.
`value`	*	Value.
`silent`	boolean \| undefined	Update without triggering an event.

setAttributions(attributions) inherited source/Source.js, line 234

Set the attributions of the source.

Name	Type	Description
`attributions`	AttributionLike \| undefined	Attributions. Can be passed as `string`, `Array<string>`, `Attribution`, or `undefined`.

setProperties(values, silent) inherited Object.js, line 238

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name	Type	Description
`values`	Partial.<NoInfer.<Properties>>	Values.
`silent`	boolean \| undefined	Update without triggering an event.

setTileGridForProjection(projection, tilegrid) inherited source/DataTile.js, line 484

Sets the tile grid to use when reprojecting the tiles to the given projection instead of the default tile grid for the projection.

This can be useful when the default tile grid cannot be created (e.g. projection has no extent defined) or for optimization reasons (custom tile size, resolutions, ...).

Name	Type	Description
`projection`	ProjectionLike	Projection.
`tilegrid`	TileGrid	Tile grid to use for the projection.

un(type, listener) inherited Observable.js, line 173

Unlisten for a certain type of event.

Name	Type	Description
`type`	string \| Array.<string>	The event type or array of event types.
`listener`	function	The listener function.

unset(key, silent) inherited Object.js, line 262

Unsets a property.

Name	Type	Description
`key`	string	Key name.
`silent`	boolean \| undefined	Unset without triggering an event.