Global

Methods

fromArrayBuffer(arrayBuffer) → {Promise.<GeoTIFF>}

Construct a new GeoTIFF from an ArrayBuffer.

Parameters:
Name Type Description
arrayBuffer ArrayBuffer

The data to read the file from.

Source:
Returns:

The resulting GeoTIFF file.

Type
Promise.<GeoTIFF>

fromBlob(blob) → {Promise.<GeoTIFF>}

Construct a GeoTIFF from an HTML Blob or File object.

Parameters:
Name Type Description
blob Blob | File

The Blob or File object to read from.

Source:
Returns:

The resulting GeoTIFF file.

Type
Promise.<GeoTIFF>

fromFile(path) → {Promise.<GeoTIFF>}

Construct a GeoTIFF from a local file path. This uses the node filesystem API and is not available on browsers.

Parameters:
Name Type Description
path string

The filepath to read from.

Source:
Returns:

The resulting GeoTIFF file.

Type
Promise.<GeoTIFF>

fromUrl(url, optionsopt) → {Promise.<GeoTIFF>}

Creates a new GeoTIFF from a remote URL.

Parameters:
Name Type Attributes Description
url string

The URL to access the image from

options object <optional>

Additional options to pass to the source. See makeRemoteSource for details.

Source:
Returns:

The resulting GeoTIFF file.

Type
Promise.<GeoTIFF>

fromUrls(mainUrl, overviewUrls, optionsopt) → {Promise.<MultiGeoTIFF>}

Construct a MultiGeoTIFF from the given URLs.

Parameters:
Name Type Attributes Description
mainUrl string

The URL for the main file.

overviewUrls Array.<string>

An array of URLs for the overview images.

options object <optional>

Additional options to pass to the source. See makeRemoteSource for details.

Source:
Returns:

The resulting MultiGeoTIFF file.

Type
Promise.<MultiGeoTIFF>

Type Definitions

Block

Type:
  • object
Properties:
Name Type Description
data ArrayBuffer

The actual data of the block.

offset number

The actual offset of the block within the file.

length number

The actual size of the block in bytes.

Source:

(async) requestCallback(offset, length) → {Promise.<Block>}

Callback type for sources to request patches of data.

Parameters:
Name Type Description
offset number

The offset within the file.

length number

The desired length of data to be read.

Source:
Returns:

The block of data.

Type
Promise.<Block>