Module: ol/source/GeoTIFF

ol/source/GeoTIFF


Classes

GeoTIFFSource

Type Definitions

GDALMetadata{Object}

Properties:
Name Type Description
STATISTICS_MINIMUM string

The minimum value (as a string).
STATISTICS_MAXIMUM string

The maximum value (as a string).

GeoKeys{Object}

Properties:
Name Type Description
GTModelTypeGeoKey number

Model type.
GTRasterTypeGeoKey number

Raster type.
GeogAngularUnitsGeoKey number

Angular units.
GeogInvFlatteningGeoKey number

Inverse flattening.
GeogSemiMajorAxisGeoKey number

Semi-major axis.
GeographicTypeGeoKey number

Geographic coordinate system code.
ProjLinearUnitsGeoKey number

Projected linear unit code.
ProjectedCSTypeGeoKey number

Projected coordinate system code.

GeoTIFF{Object}

Properties:
Name Type Description
getImageCount function

Get the number of internal subfile images.
getImage function

Get the image at the specified index.

GeoTIFFImage{Object}

Properties:
Name Type Description
fileDirectory Object

The file directory.
geoKeys module:ol/source/GeoTIFF~GeoKeys

The parsed geo-keys.
littleEndian boolean

Uses little endian byte order.
tiles Object

The tile cache.
isTiled boolean

The image is tiled.
getBoundingBox function

Get the image bounding box.
getOrigin function

Get the image origin.
getResolution function

Get the image resolution.
getWidth function

Get the pixel width of the image.
getHeight function

Get the pixel height of the image.
getTileWidth function

Get the pixel width of image tiles.
getTileHeight function

Get the pixel height of image tiles.
getGDALNoData function

Get the nodata value (or null if none).
getGDALMetadata function

Get the raster stats (or null if none).
getSamplesPerPixel function

Get the number of samples per pixel.

MultiGeoTIFF{Object}

Properties:
Name Type Description
getImageCount function

Get the number of internal subfile images.
getImage function

Get the image at the specified index.

Options{Object}

Properties:
Name Type Argument Default Description
sources Array.<module:ol/source/GeoTIFF~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.
convertToRGB boolean <optional>
 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.
normalize boolean <optional>
 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 <optional>
 false

Whether the layer is opaque.
transition number <optional>
 250

Duration of the opacity transition for rendering. To disable the opacity transition, pass transition: 0.
wrapX boolean <optional>
 false

Render tiles beyond the tile grid extent.
interpolate boolean <optional>
 true

Use interpolated values when resampling. By default, the linear interpolation is used to resample the data. If false, nearest neighbor is used.

SourceInfo{Object}

Properties:
Name Type Argument Default Description
url string

URL for the source GeoTIFF.
overviews Array.<string> <optional>

List of any overview URLs.
min number <optional>
 0

The minimum source data value. Rendered values are scaled from 0 to 1 based on the configured min and max. If not provided and raster statistics are available, those will be used instead. If neither are available, the minimum for the data type will be used. To disable this behavior, set the normalize option to false in the constructor.
max number <optional>

The maximum source data value. Rendered values are scaled from 0 to 1 based on the configured min and max. If not provided and raster statistics are available, those will be used instead. If neither are available, the maximum for the data type will be used. To disable this behavior, set the normalize option to false in the constructor.
nodata number <optional>

Values to discard (overriding any nodata values in the metadata). When provided, an additional alpha band will be added to the data. Often the GeoTIFF metadata will include information about nodata values, so you should only need to set this property if you find that it is not already extracted from the metadata.
bands Array.<number> <optional>

Band numbers to be read from (where the first band is 1). If not provided, all bands will be read. For example, if a GeoTIFF has blue (1), green (2), red (3), and near-infrared (4) bands, and you only need the near-infrared band, configure bands: [4].