Class: GeoTIFFSource

ol/source/GeoTIFF~GeoTIFFSource


import GeoTIFFSource from 'ol/source/GeoTIFF';

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)

Name Type Description
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.

opaque boolean (defaults to false)

Whether the layer is opaque.

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:

Extends

Methods

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

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

dispatchEvent(event){boolean | undefined} inherited

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.

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

Get the attribution function for the source.

Returns:
Attribution function.

getAttributionsCollapsible(){boolean} inherited

Returns:
Attributions are collapsible.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

getProjection(){Projection | null} inherited

Get the projection of the source.

Returns:
Projection.

getProperties(){Object.<string, *>} inherited

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited

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

Returns:
Revision.

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

Returns:
State.

getTileGrid(){TileGrid | null} inherited

Return the tile grid of the tile source.

Returns:
Tile grid.

getView(){Promise<ViewOptions>}

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

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

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.

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

set(key, value, silent) inherited

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

silent boolean | undefined

Update without triggering an event.

setAttributions(attributions) inherited

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

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 Object.<string, *>

Values.

silent boolean | undefined

Update without triggering an event.

un(type, listener) inherited

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

Unsets a property.

Name Type Description
key string

Key name.

silent boolean | undefined

Unset without triggering an event.