Interface Options

interface Options {
    band?: number;
    clamp?: [number, number];
    ellipsoid?: Ellipsoid;
    getStats?: boolean;
    maxZoom?: number;
    noData?: number;
    tileSize?: number;
}

Properties

band? clamp? ellipsoid? getStats? maxZoom? noData? tileSize?

Properties

Optionalband

band?: number

Select the band number to read; 0-based index

Default Value

0

Optional Experimentalclamp

clamp?: [number, number]

[low, high] bounds to clamp elevation values to

Default Value

[0, Infinity]

Optionalellipsoid

ellipsoid?: Ellipsoid

Ellipsoid for Cesium operations

Default Value

Cesium.Ellipsoid.WGS84

Optional ExperimentalgetStats

getStats?: boolean

Use geotiff-stats to read GDAL metadata or calculate stats to auto-set clamp

Remarks

If GDAL metadata is not found for the given COG, the stats calculation can have a significant impact on performance. Use at your own discretion.

Default Value

false

OptionalmaxZoom

maxZoom?: number

Force a maxium zoom; Normally set automatically based on projection & resolution

OptionalnoData

noData?: number

Elevation value in TIFF to be reinterpreted as 0 in MARTINI

Default Value

image.getGDALNoData() ?? 0

OptionaltileSize

tileSize?: number

Sets the resampled tile grid size. Must match the parent MartiniTerrainProvider.tileSize

Default Value

257

Settings

Member Visibility

On This Page

Properties