Skip to content

XyzLayer (Standard XYZ Pyramid Layer)

Tile layer that can load COG XYZ imagery.

Constructor

ts
new ge3d.object.XyzLayer(options?: any): XyzLayer

Parameters

ParameterTypeDefaultDescription
urlCesium.Resource/String-Tile URL template
formatString'image/jpeg'MIME type of tile image to be retrieved from server
enablePickFeaturesBooleanfalseWhether to request and interpret vector object features
pickFeaturesUrlCesium.Resource/String-Corresponding WMS service URL for clicking to view vector object features
highlightObject-Vector data and its style highlighted by mouse click

COG Parameters

ParameterTypeDescription
bidxstringDataset band index (e.g., bidx=1, bidx=1&bidx=2&bidx=3)
expressionstringRio tiler band math expression (e.g., expression=b1/b2)
nodatastringOverride internal nodata value
unscalestringApply dataset internal scale/offset
resamplingstringRasterIO resampling algorithm, default is nearest value
reprojectstringWarpKernel resampling algorithm (only used when reprojecting), default is nearest
rescalestringComma-separated min, max range
color_formulastringRio color formula
colormapstringJSON-encoded custom color map
colormap_namestringRio tiler color map name
return_maskstringAdd mask to output data, default value is True
bufferstringBuffer on both sides of given tile, must be multiple of 0.5
paddingstringPadding applied to each tile edge, default is 0
algorithmstringCustom algorithm name (e.g., hillshade)
algorithm_paramsstringJSON-encoded algorithm parameters

Properties

PropertyTypeDescription
idanyObject id identifier
nameanyName identifier
showanyShow/hide state
opacityanyOpacity, range 0.0-1.0
brightnessanyBrightness, range 0.0-1.0
contrastanyContrast
gammaanyGamma correction value
hueanyHue
saturationanySaturation

Methods

setOpacity

Set opacity

ts
setOpacity(value: any): void

toJSON

Convert to JSON

ts
toJSON(): object