Skip to content

WmtsCogByRestLayer (COG-based REST-style WMTS Service Layer)

COG-based REST-style WMTS service layer.

Constructor

ts
new ge3d.object.WmtsCogByRestLayer(options: any): WmtsCogByRestLayer

Parameters

ParameterTypeDefaultDescription
urlCesium.Resource/String-Base URL of WMTS GetTile operation or tile-URL template
formatString'image/jpeg'MIME type of tile image
layerString-Layer name for WMTS request
styleString-Style name for WMTS request
tileMatrixSetIDString-Identifier of TileMatrixSet used for WMTS request
tileMatrixLabelsString[]-List of tile matrix identifiers
clockCesium.Clock-Clock instance for determining time dimension values
timesCesium.TimeIntervalCollection-Object of time dynamic dimensions and their values
enablePickFeaturesBooleanfalseWhether to request vector object features
pickFeaturesUrlCesium.Resource/String-Corresponding WMS service URL for clicking to view vector object features
pickFeaturesFunction-External custom click request processing for corresponding vector data
highlightObject-Mouse click highlight display

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
alphaanyOpacity, same as opacity, from 0.0 to 1.0
brightnessanyBrightness, range 0.0-1.0
contrastanyContrast, 1.0 uses unmodified image colors
gammaanyGamma correction value, 1.0 uses unmodified image colors
hueanyHue, 0.0 for unmodified image colors
saturationanySaturation, 1.0 uses unmodified image colors
idanyObject id identifier
isAddedbooleanWhether added to map
isDestroybooleanWhether destroyed
nameanyName identifier
opacityanyOpacity, range 0.0-1.0
rectangleanyTile data extent
showanyShow/hide state
zIndexanyLayer order, higher numbers on top
hasOpacitybooleanWhether opacity can be adjusted
hasZIndexbooleanWhether layer order can be adjusted

Methods

addEventListener

Bind layer events

ts
addEventListener(types: any, fn: any, context?: any): this

addPosition

Add new coordinate point

ts
addPosition(item: any): void

clear

Clear vector objects

ts
clear(hasDestory?: boolean): void

destroy

Destroy current layer

ts
destroy(noDel: any): void

flyTo

Fly to feature

ts
flyTo(options: any): undefined | GeoJsonLayer

once

Event that is destroyed after being triggered once

ts
once(types: any, fn: any, context?: any): this

removeEventListener

Remove bound events

ts
removeEventListener(types: any, fn: any, context?: any): this

setOpacity

Set opacity

ts
setOpacity(value: any): void

setOptions

Set Options

ts
setOptions(options?: any): this

toJSON

Convert to JSON

ts
toJSON(): object