@jdultra/ultra-globe

---

@jdultra/ultra-globe / EpanetLayer

Class: EpanetLayer

Defined in: layers/vector/EpanetLayer.d.ts:1

Constructors

Constructor

new EpanetLayer(properties): EpanetLayer

Defined in: layers/vector/EpanetLayer.d.ts:37

Decodes and renders an EPANET/SWMM-style input file (.inp) in a worker.

Spatial entities are mapped as follows:

• junctions / outfalls / dividers -> points
• pipes / conduits / weirs / orifices / outlets -> polylines
• tanks / storage -> extruded polygons
• reservoirs -> draped polygons by default, or extruded polygons through properties.reservoirMode
• subcatchments / drainage areas -> draped polygons
• pumps / valves -> draped points placed on the link midpoint

Heights are converted from EGM96/mean-sea-level to WGS84 ellipsoid heights by default so the output matches VectorLayer.

Parameters

properties

Object

Returns

EpanetLayer

Overrides

VectorLayer.constructor

Properties

arrayRenderTarget

arrayRenderTarget: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:31

Inherited from

VectorLayer.arrayRenderTarget

---

attribution

attribution: string | null

Defined in: layers/Layer.d.ts:29

Inherited from

VectorLayer.attribution

---

bounds

bounds: any

Defined in: layers/Layer.d.ts:26

Inherited from

VectorLayer.bounds

---

bundle

bundle: any

Defined in: layers/vector/VectorLayer.d.ts:51

Inherited from

VectorLayer.bundle

---

catchmentColor

catchmentColor: any

Defined in: layers/vector/EpanetLayer.d.ts:93

---

catchmentOpacity

catchmentOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:94

---

conectivityGraph

conectivityGraph: ConnectedGraph | null

Defined in: layers/vector/EpanetLayer.d.ts:97

---

connectivityGraph

connectivityGraph: ConnectedGraph | null

Defined in: layers/vector/EpanetLayer.d.ts:96

---

convertElevationsToEllipsoid

convertElevationsToEllipsoid: boolean

Defined in: layers/vector/EpanetLayer.d.ts:63

---

decodedMetadata

decodedMetadata: any

Defined in: layers/vector/EpanetLayer.d.ts:95

---

defaultNodeAreaRadius

defaultNodeAreaRadius: number

Defined in: layers/vector/EpanetLayer.d.ts:69

---

drapedBundle

drapedBundle: any

Defined in: layers/vector/VectorLayer.d.ts:52

Inherited from

VectorLayer.drapedBundle

---

drapedCenterHighUniform

drapedCenterHighUniform: any

Defined in: layers/vector/VectorLayer.d.ts:57

Inherited from

VectorLayer.drapedCenterHighUniform

---

drapedCenterLowUniform

drapedCenterLowUniform: any

Defined in: layers/vector/VectorLayer.d.ts:58

Inherited from

VectorLayer.drapedCenterLowUniform

---

drapedLines

drapedLines: DrapedPolylinesHandler

Defined in: layers/vector/VectorLayer.d.ts:80

Inherited from

VectorLayer.drapedLines

---

drapedPoints

drapedPoints: DrapedPointsHandler

Defined in: layers/vector/VectorLayer.d.ts:78

Inherited from

VectorLayer.drapedPoints

---

drapedPolygonOutlines

drapedPolygonOutlines: DrapedPolylinesHandler

Defined in: layers/vector/VectorLayer.d.ts:87

Inherited from

VectorLayer.drapedPolygonOutlines

---

drapedPolygons

drapedPolygons: DrapedPolygonsHandler

Defined in: layers/vector/VectorLayer.d.ts:86

Inherited from

VectorLayer.drapedPolygons

---

drapedScene

drapedScene: any

Defined in: layers/vector/VectorLayer.d.ts:98

Inherited from

VectorLayer.drapedScene

---

drapedShiftUniform

drapedShiftUniform: any

Defined in: layers/vector/VectorLayer.d.ts:59

Inherited from

VectorLayer.drapedShiftUniform

---

drapeOnMesh

drapeOnMesh: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:11

Inherited from

VectorLayer.drapeOnMesh

---

drapeOnSplats

drapeOnSplats: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:12

Inherited from

VectorLayer.drapeOnSplats

---

drapeOnTerrain

drapeOnTerrain: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:13

Inherited from

VectorLayer.drapeOnTerrain

---

extrudedPolygons

extrudedPolygons: ExtrudedPolygonsHandler

Defined in: layers/vector/VectorLayer.d.ts:83

Inherited from

VectorLayer.extrudedPolygons

---

floatingOffsetUniform

floatingOffsetUniform: any

Defined in: layers/vector/VectorLayer.d.ts:64

Inherited from

VectorLayer.floatingOffsetUniform

---

handlers

handlers: (PointsHandler | DrapedPointsHandler | PolylinesHandler | DrapedPolylinesHandler | RibbonsHandler | PolygonsHandler | ExtrudedPolygonsHandler | TerrainExtrudedPolygonsHandler | DrapedPolygonsHandler)[]

Defined in: layers/vector/VectorLayer.d.ts:105

Inherited from

VectorLayer.handlers

---

id

id: string | number

Defined in: layers/Layer.d.ts:24

Inherited from

VectorLayer.id

---

isClipMapImageryLayer

isClipMapImageryLayer: boolean

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:24

Inherited from

VectorLayer.isClipMapImageryLayer

---

isEpanetLayer

isEpanetLayer: boolean

Defined in: layers/vector/EpanetLayer.d.ts:61

---

isLayer

isLayer: boolean

Defined in: layers/Layer.d.ts:22

Inherited from

VectorLayer.isLayer

---

isOverlay

isOverlay: boolean

Defined in: layers/vector/VectorLayer.d.ts:89

Inherited from

VectorLayer.isOverlay

---

isProjectedImageryLayer

isProjectedImageryLayer: boolean

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:10

Inherited from

VectorLayer.isProjectedImageryLayer

---

isProjectedLayer

isProjectedLayer: boolean

Defined in: layers/ProjectedLayer.d.ts:15

Inherited from

VectorLayer.isProjectedLayer

---

isRasterLayer

isRasterLayer: boolean

Defined in: layers/RasterLayer.d.ts:21

Inherited from

VectorLayer.isRasterLayer

---

isSelectable

isSelectable: boolean

Defined in: layers/Layer.d.ts:23

Inherited from

VectorLayer.isSelectable

---

isVectorLayer

isVectorLayer: boolean

Defined in: layers/vector/VectorLayer.d.ts:88

Inherited from

VectorLayer.isVectorLayer

---

levels

levels: number | undefined

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:45

Inherited from

VectorLayer.levels

---

lineFlow

lineFlow: { enabled: boolean; color: any; pulseFrequency: any; defaultFlowSpeed: any; } | null

Defined in: layers/vector/VectorLayer.d.ts:65

Inherited from

VectorLayer.lineFlow

---

lineFlowColorUniform

lineFlowColorUniform: any

Defined in: layers/vector/VectorLayer.d.ts:72

Inherited from

VectorLayer.lineFlowColorUniform

---

lineFlowDefaultSpeedUniform

lineFlowDefaultSpeedUniform: any

Defined in: layers/vector/VectorLayer.d.ts:75

Inherited from

VectorLayer.lineFlowDefaultSpeedUniform

---

lineFlowEnabledUniform

lineFlowEnabledUniform: any

Defined in: layers/vector/VectorLayer.d.ts:71

Inherited from

VectorLayer.lineFlowEnabledUniform

---

lineFlowPulseFrequencyUniform

lineFlowPulseFrequencyUniform: any

Defined in: layers/vector/VectorLayer.d.ts:73

Inherited from

VectorLayer.lineFlowPulseFrequencyUniform

---

lineFlowTimeUniform

lineFlowTimeUniform: any

Defined in: layers/vector/VectorLayer.d.ts:74

Inherited from

VectorLayer.lineFlowTimeUniform

---

linePlanar

linePlanar: boolean

Defined in: layers/vector/VectorLayer.d.ts:56

Inherited from

VectorLayer.linePlanar

---

lines

lines: PolylinesHandler

Defined in: layers/vector/VectorLayer.d.ts:79

Inherited from

VectorLayer.lines

---

listeners

listeners: Object

Defined in: layers/Layer.d.ts:28

Inherited from

VectorLayer.listeners

---

localBounds

localBounds: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:9

Inherited from

VectorLayer.localBounds

---

lodBounds

lodBounds: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:28

Inherited from

VectorLayer.lodBounds

---

lodRefs

lodRefs: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:30

Inherited from

VectorLayer.lodRefs

---

lodScale

lodScale: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:27

Inherited from

VectorLayer.lodScale

---

map

map: any

Defined in: layers/Layer.d.ts:92

Inherited from

VectorLayer.map

---

material

material: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:43

Inherited from

VectorLayer.material

---

maxResolution

maxResolution: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:26

Inherited from

VectorLayer.maxResolution

---

maxSegmentLength

maxSegmentLength: any

Defined in: layers/vector/VectorLayer.d.ts:60

Inherited from

VectorLayer.maxSegmentLength

---

name

name: string

Defined in: layers/Layer.d.ts:25

Inherited from

VectorLayer.name

---

needsRaycastOnDepth

needsRaycastOnDepth: boolean

Defined in: layers/vector/VectorLayer.d.ts:53

Inherited from

VectorLayer.needsRaycastOnDepth

---

nodeElevationUnit

nodeElevationUnit: "meters" | "feet"

Defined in: layers/vector/EpanetLayer.d.ts:65

---

nodePolygonSegments

nodePolygonSegments: number

Defined in: layers/vector/EpanetLayer.d.ts:73

---

objects

objects: { } | undefined

Defined in: layers/vector/VectorLayer.d.ts:403

Inherited from

VectorLayer.objects

---

origin

origin: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:71

Inherited from

VectorLayer.origin

---

paused

paused: boolean | undefined

Defined in: layers/Layer.d.ts:82

Inherited from

VectorLayer.paused

---

pipeColor

pipeColor: any

Defined in: layers/vector/EpanetLayer.d.ts:82

---

pointColor

pointColor: any

Defined in: layers/vector/EpanetLayer.d.ts:75

---

pointMapUniform

pointMapUniform: any

Defined in: layers/vector/VectorLayer.d.ts:54

Inherited from

VectorLayer.pointMapUniform

---

pointOpacity

pointOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:77

---

points

points: PointsHandler

Defined in: layers/vector/VectorLayer.d.ts:77

Inherited from

VectorLayer.points

---

pointsAnchor

pointsAnchor: any

Defined in: layers/vector/VectorLayer.d.ts:63

Inherited from

VectorLayer.pointsAnchor

---

pointShape

pointShape: "sprite" | "circle" | "sphere" | undefined

Defined in: layers/vector/VectorLayer.d.ts:61

Inherited from

VectorLayer.pointShape

---

pointSize

pointSize: any

Defined in: layers/vector/EpanetLayer.d.ts:76

---

pointsTexture

pointsTexture: any

Defined in: layers/vector/VectorLayer.d.ts:62

Inherited from

VectorLayer.pointsTexture

---

polygonColor

polygonColor: any

Defined in: layers/vector/VectorLayer.d.ts:91

Inherited from

VectorLayer.polygonColor

---

polygonLineType

polygonLineType: any

Defined in: layers/vector/EpanetLayer.d.ts:88

---

polygonOpacity

polygonOpacity: any

Defined in: layers/vector/VectorLayer.d.ts:90

Inherited from

VectorLayer.polygonOpacity

---

polygonOutlineColor

polygonOutlineColor: any

Defined in: layers/vector/EpanetLayer.d.ts:85

---

polygonOutlineOpacity

polygonOutlineOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:87

---

polygonOutlines

polygonOutlines: PolylinesHandler

Defined in: layers/vector/VectorLayer.d.ts:85

Inherited from

VectorLayer.polygonOutlines

---

polygonOutlineWidth

polygonOutlineWidth: any

Defined in: layers/vector/EpanetLayer.d.ts:86

---

polygons

polygons: PolygonsHandler

Defined in: layers/vector/VectorLayer.d.ts:82

Inherited from

VectorLayer.polygons

---

polylineColor

polylineColor: any

Defined in: layers/vector/EpanetLayer.d.ts:81

---

polylineOpacity

polylineOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:84

---

polylineWidth

polylineWidth: any

Defined in: layers/vector/EpanetLayer.d.ts:83

---

pumpValvePointColor

pumpValvePointColor: any

Defined in: layers/vector/EpanetLayer.d.ts:78

---

pumpValvePointOpacity

pumpValvePointOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:80

---

pumpValvePointSize

pumpValvePointSize: any

Defined in: layers/vector/EpanetLayer.d.ts:79

---

reference

reference: number

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:15

Inherited from

VectorLayer.reference

---

reservoirColor

reservoirColor: any

Defined in: layers/vector/EpanetLayer.d.ts:91

---

reservoirMode

reservoirMode: "draped" | "extruded" | "auto"

Defined in: layers/vector/EpanetLayer.d.ts:68

---

reservoirOpacity

reservoirOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:92

---

reservoirRadius

reservoirRadius: number

Defined in: layers/vector/EpanetLayer.d.ts:70

---

reservoirWallHeight

reservoirWallHeight: number

Defined in: layers/vector/EpanetLayer.d.ts:74

---

ribbons

ribbons: RibbonsHandler

Defined in: layers/vector/VectorLayer.d.ts:81

Inherited from

VectorLayer.ribbons

---

scene

scene: any

Defined in: layers/vector/VectorLayer.d.ts:402

Inherited from

VectorLayer.scene

---

screenSizeUniform

screenSizeUniform: any

Defined in: layers/vector/VectorLayer.d.ts:55

Inherited from

VectorLayer.screenSizeUniform

---

sourceCrs

sourceCrs: string

Defined in: layers/vector/EpanetLayer.d.ts:62

---

storageRadius

storageRadius: number

Defined in: layers/vector/EpanetLayer.d.ts:71

---

tankColor

tankColor: any

Defined in: layers/vector/EpanetLayer.d.ts:89

---

tankLevels

tankLevels: "meters" | "feet"

Defined in: layers/vector/EpanetLayer.d.ts:66

---

tankOpacity

tankOpacity: any

Defined in: layers/vector/EpanetLayer.d.ts:90

---

tankRadius

tankRadius: number

Defined in: layers/vector/EpanetLayer.d.ts:72

---

tentativeLODBounds

tentativeLODBounds: any[]

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:29

Inherited from

VectorLayer.tentativeLODBounds

---

terrainExtrudedPolygons

terrainExtrudedPolygons: TerrainExtrudedPolygonsHandler

Defined in: layers/vector/VectorLayer.d.ts:84

Inherited from

VectorLayer.terrainExtrudedPolygons

---

textureSize

textureSize: number

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:25

Inherited from

VectorLayer.textureSize

---

transform

transform: Converter | undefined

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:8

Inherited from

VectorLayer.transform

---

transparency

transparency: any

Defined in: layers/imagery/ProjectedImageryLayer.d.ts:14

Inherited from

VectorLayer.transparency

---

uCameraPos

uCameraPos: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:50

Inherited from

VectorLayer.uCameraPos

---

uCameraThreshold

uCameraThreshold: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:51

Inherited from

VectorLayer.uCameraThreshold

---

uDrapeOnMesh

uDrapeOnMesh: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:54

Inherited from

VectorLayer.uDrapeOnMesh

---

uDrapeOnSplats

uDrapeOnSplats: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:56

Inherited from

VectorLayer.uDrapeOnSplats

---

uDrapeOnTerrain

uDrapeOnTerrain: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:55

Inherited from

VectorLayer.uDrapeOnTerrain

---

uLodBoundsArray

uLodBoundsArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:57

Inherited from

VectorLayer.uLodBoundsArray

---

uNumLevels

uNumLevels: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:52

Inherited from

VectorLayer.uNumLevels

---

uOffset

uOffset: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:49

Inherited from

VectorLayer.uOffset

---

uOpacity

uOpacity: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:47

Inherited from

VectorLayer.uOpacity

---

uRefEArray

uRefEArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:62

Inherited from

VectorLayer.uRefEArray

---

uReference

uReference: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:48

Inherited from

VectorLayer.uReference

---

uRefKxArray

uRefKxArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:60

Inherited from

VectorLayer.uRefKxArray

---

uRefKyArray

uRefKyArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:61

Inherited from

VectorLayer.uRefKyArray

---

uRefLocalUvMaxArray

uRefLocalUvMaxArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:67

Inherited from

VectorLayer.uRefLocalUvMaxArray

---

uRefLocalUvMinArray

uRefLocalUvMinArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:66

Inherited from

VectorLayer.uRefLocalUvMinArray

---

uRefMinLocalArray

uRefMinLocalArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:64

Inherited from

VectorLayer.uRefMinLocalArray

---

uRefNArray

uRefNArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:63

Inherited from

VectorLayer.uRefNArray

---

uRefOriginDeg

uRefOriginDeg: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:53

Inherited from

VectorLayer.uRefOriginDeg

---

uRefSLatArray

uRefSLatArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:59

Inherited from

VectorLayer.uRefSLatArray

---

uRefSLonArray

uRefSLonArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:58

Inherited from

VectorLayer.uRefSLonArray

---

uRefSpanLocalArray

uRefSpanLocalArray: any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:65

Inherited from

VectorLayer.uRefSpanLocalArray

---

verticalDatum

verticalDatum: "ellipsoid" | "egm96"

Defined in: layers/vector/EpanetLayer.d.ts:64

---

verticalDatumInterpretation

verticalDatumInterpretation: "ellipsoid" | "geoid"

Defined in: layers/vector/EpanetLayer.d.ts:67

---

visible

visible: boolean

Defined in: layers/Layer.d.ts:27

Inherited from

VectorLayer.visible

Accessors

hasDrapedContent

Get Signature

get hasDrapedContent(): boolean

Defined in: layers/vector/VectorLayer.d.ts:116

Returns

boolean

Inherited from

VectorLayer.hasDrapedContent

Methods

addDrapedPoints()

addDrapedPoints(coordinates, size, color, opacity?, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:377

Parameters

coordinates

any

size

any

color

any

opacity?

number

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addDrapedPoints

---

addDrapedPolygon()

addDrapedPolygon(coordinates, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:394

Parameters

coordinates

any

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addDrapedPolygon

---

addDrapedPolygons()

addDrapedPolygons(coordinates, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:401

Parameters

coordinates

any

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addDrapedPolygons

---

addDrapedPolylines()

addDrapedPolylines(coordinates, width, color, opacity?, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:379

Parameters

coordinates

any

width

any

color

any

opacity?

number

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addDrapedPolylines

---

addExtrudedPolygon()

addExtrudedPolygon(coordinates, minHeight, maxHeight, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:395

Parameters

coordinates

any

minHeight

number | undefined

maxHeight

number | undefined

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addExtrudedPolygon

---

addExtrudedPolygons()

addExtrudedPolygons(coordinates, minHeight, maxHeight, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:397

Parameters

coordinates

any

minHeight

number | undefined

maxHeight

number | undefined

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

Returns

Promise<any>

Inherited from

VectorLayer.addExtrudedPolygons

---

addFeatureChangeListener()

addFeatureChangeListener(callback): void

Defined in: layers/vector/VectorLayer.d.ts:121

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.addFeatureChangeListener

---

addListener()

addListener(key, listener): void

Defined in: layers/Layer.d.ts:74

Adds a listener for layer events

Parameters

key

any

can be anything but should be unique

listener

Function

a function : (layer, eventType)=>{}

Returns

void

Inherited from

VectorLayer.addListener

---

addPoints()

addPoints(coordinates, size, color, opacity?, properties?, draped?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:376

Adds points to the layer The point heights will use the z component of the coordinates and default to 0. Points can also be draped on terrain by setting the draped parameter to true

Parameters

coordinates

any[]

an array of lon lat (height) points (height defaults to 0). e.g.: [[42.1,5.0,25.0], [85.8,32.1]]

size

any

number or Vector2 like (x and y property)

color

Color

a color

opacity?

number

properties?

Object

any js object

draped?

boolean

dismisses the z component of the coordinates and drapes the vectors on terrain

Returns

Promise<any>

a promise for the uuid of the added feature

Inherited from

VectorLayer.addPoints

---

addPolygons()

addPolygons(coordinates, height, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?, draped?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:393

Parameters

coordinates

any

height

number | undefined

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

draped?

boolean

Returns

Promise<any>

Inherited from

VectorLayer.addPolygons

---

addPolylines()

addPolylines(coordinates, width, color, opacity?, properties?, draped?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:378

Parameters

coordinates

any

width

any

color

any

opacity?

number

properties?

Object

draped?

boolean

Returns

Promise<any>

Inherited from

VectorLayer.addPolylines

---

addRibbons()

addRibbons(coordinates, width, color, opacity?, properties?, draped?, radialSegments?): Promise<any> | undefined

Defined in: layers/vector/VectorLayer.d.ts:392

Similar to polylines, "ribbons" represent lines. By default, they are flat ribbons relative to the ellipsoid but can also be 3D tubes by setting the radialSegments attribute to a value higher than 2. Ribbons are heavier on memory than polylines but produce less artefacts

Parameters

coordinates

any

width

any

color

any

opacity?

number

properties?

any

draped?

any

radialSegments?

any

Returns

Promise<any> | undefined

Inherited from

VectorLayer.addRibbons

---

addSelectionListener()

addSelectionListener(callback): void

Defined in: layers/vector/VectorLayer.d.ts:134

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.addSelectionListener

---

addTerrainExtrudedPolygon()

addTerrainExtrudedPolygon(coordinates, minHeight, maxHeight, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?, elevationLayer?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:396

Parameters

coordinates

any

minHeight

number | undefined

maxHeight

number | undefined

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

elevationLayer?

null

Returns

Promise<any>

Inherited from

VectorLayer.addTerrainExtrudedPolygon

---

addTerrainExtrudedPolygons()

addTerrainExtrudedPolygons(coordinates, minHeight, maxHeight, color, fillOpacity, lineType, outlineColor, outlineOpacity, outlineWidth, properties?, elevationLayer?): Promise<any>

Defined in: layers/vector/VectorLayer.d.ts:398

Parameters

coordinates

any

minHeight

number | undefined

maxHeight

number | undefined

color

any

fillOpacity

number | undefined

lineType

number | undefined

outlineColor

any

outlineOpacity

number | undefined

outlineWidth

any

properties?

Object

elevationLayer?

null

Returns

Promise<any>

Inherited from

VectorLayer.addTerrainExtrudedPolygons

---

addUpdateCallback()

addUpdateCallback(callback): void

Defined in: layers/vector/VectorLayer.d.ts:119

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.addUpdateCallback

---

containsFeature2D()

containsFeature2D(source, target): boolean

Defined in: layers/vector/VectorLayer.d.ts:248

Checks if the 2D bounding boxes and geometries of the source feature completely contain the target feature. Evaluates in 2D space (ignoring Z/height).

Parameters

source

The containing feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

target

The feature or reference to check for containment.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

Returns

boolean

True if the source fully contains the target in 2D space.

Inherited from

VectorLayer.containsFeature2D

---

containsFeature3D()

containsFeature3D(source, target): boolean

Defined in: layers/vector/VectorLayer.d.ts:267

Checks if the 3D bounding boxes and geometries of the source feature completely contain the target feature. Evaluates in true 3D space (incorporating Z/height).

Parameters

source

The containing feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

target

The feature or reference to check for containment.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

Returns

boolean

True if the source fully contains the target in 3D space.

Inherited from

VectorLayer.containsFeature3D

---

delete()

delete(uuid): void

Defined in: layers/vector/VectorLayer.d.ts:441

Completely remove a previously-added shape (or shapes) identified by its application uuid. This will remove geometry/instances/batches where possible and clear internal registries.

Parameters

uuid

uuid of the feature to remove or an array of uuids.

string | any[]

Returns

void

Inherited from

VectorLayer.delete

---

dispose()

dispose(): void

Defined in: layers/Layer.d.ts:87

disposes of any resources used by this layer

Returns

void

Inherited from

VectorLayer.dispose

---

distanceToFeature2D()

distanceToFeature2D(source, target): number

Defined in: layers/vector/VectorLayer.d.ts:285

Calculates the shortest 2D distance between two features along the terrain/map plane.

Parameters

source

The first feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

target

The second feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

Returns

number

The 2D distance in meters/units.

Inherited from

VectorLayer.distanceToFeature2D

---

distanceToFeature3D()

distanceToFeature3D(source, target): number

Defined in: layers/vector/VectorLayer.d.ts:305

Calculates the shortest 3D distance between two features, taking height and volume into account. Note: 3D distance calculation is only supported between non-draped features.

Parameters

source

The first feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

target

The second feature or reference.

string | Object | { layer: VectorLayer; uuid: string; } | { uuid: string; }

Returns

number

The true 3D distance in meters/units.

Throws

If either feature is draped on the terrain.

Inherited from

VectorLayer.distanceToFeature3D

---

forEachFeature()

forEachFeature(callback): void

Defined in: layers/vector/VectorLayer.d.ts:239

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.forEachFeature

---

getAnchors()

getAnchors(uuid): any[] | null

Defined in: layers/vector/VectorLayer.d.ts:334

Return anchors array for a given UUID by consulting each handler's uuidToAnchors registry. Stops at the first handler that contains an entry for the UUID (uuids are unique across handlers).

Parameters

uuid

string

Returns

any[] | null

anchors array or null if not found

Inherited from

VectorLayer.getAnchors

---

getBBox()

getBBox(uuid): number[] | null

Defined in: layers/vector/VectorLayer.d.ts:165

Retrieve the canonical stored bbox tuple for a UUID. Outline companion handlers are intentionally skipped so shared polygon UUIDs resolve to the externally-visible feature bbox.

Parameters

uuid

string

Returns

number[] | null

Inherited from

VectorLayer.getBBox

---

getBounds()

getBounds(): void

Defined in: layers/vector/VectorLayer.d.ts:520

Recompute lon/lat bounds [minLon, minLat, maxLon, maxLat] from current shapes in the layer. Stores result in this.bounds as a THREE.Box2. If no shapes present sets bounds to [0,0,0,0].

Returns

void

Inherited from

VectorLayer.getBounds

---

getCenter()

getCenter(sfct): Vector3

Defined in: layers/Layer.d.ts:37

Moves a given point to this layer's center in degree longitude/latitude

Parameters

sfct

Vector3

a point to move

Returns

Vector3

the input point

Inherited from

VectorLayer.getCenter

---

getFeatureCameraMetadata()

getFeatureCameraMetadata(uuid): { isDraped: boolean; isPointFeature: boolean; sampleCoordinate: any; pointWorldSized: boolean; pointSize: { x: number; y: number; } | null; pointShape: any; constructor: Function; toString: string; toLocaleString: string; valueOf: Object; hasOwnProperty: boolean; isPrototypeOf: boolean; propertyIsEnumerable: boolean; } | null

Defined in: layers/vector/VectorLayer.d.ts:213

Parameters

uuid

any

Returns

{ isDraped: boolean; isPointFeature: boolean; sampleCoordinate: any; pointWorldSized: boolean; pointSize: { x: number; y: number; } | null; pointShape: any; constructor: Function; toString: string; toLocaleString: string; valueOf: Object; hasOwnProperty: boolean; isPrototypeOf: boolean; propertyIsEnumerable: boolean; } | null

Inherited from

VectorLayer.getFeatureCameraMetadata

---

getFeatureRecord()

getFeatureRecord(uuid): Object | null

Defined in: layers/vector/VectorLayer.d.ts:212

Parameters

uuid

string

Returns

Object | null

Inherited from

VectorLayer.getFeatureRecord

---

getFeatureRecords()

getFeatureRecords(): Object[]

Defined in: layers/vector/VectorLayer.d.ts:234

Returns

Object[]

Inherited from

VectorLayer.getFeatureRecords

---

getFeatureRef()

getFeatureRef(uuid): { layer: VectorLayer; uuid: string; } | null

Defined in: layers/vector/VectorLayer.d.ts:204

A flexible reference to a spatial feature.

Parameters

uuid

string

Returns

{ layer: VectorLayer; uuid: string; } | null

Inherited from

VectorLayer.getFeatureRef

---

getID()

getID(): string | number

Defined in: layers/Layer.d.ts:42

Returns

string | number

layer id

Inherited from

VectorLayer.getID

---

getName()

getName(): string

Defined in: layers/Layer.d.ts:47

Returns

string

layer name

Inherited from

VectorLayer.getName

---

getPointAnchor()

getPointAnchor(): Vector2

Defined in: layers/vector/VectorLayer.d.ts:466

Gets the point anchor (vec2) used for point billboards.

Returns

Vector2

Inherited from

VectorLayer.getPointAnchor

---

getPointShape()

getPointShape(): "sprite" | "circle" | "sphere"

Defined in: layers/vector/VectorLayer.d.ts:471

Gets the configured point shape.

Returns

"sprite" | "circle" | "sphere"

Inherited from

VectorLayer.getPointShape

---

getPointTexture()

getPointTexture(): any

Defined in: layers/vector/VectorLayer.d.ts:456

Gets the current point texture (map).

Returns

any

Inherited from

VectorLayer.getPointTexture

---

getProperties()

getProperties(uuid): Object | Object[] | null

Defined in: layers/vector/VectorLayer.d.ts:156

Retrieve properties for one or more UUIDs from the underlying handlers.

High level behavior:

• If uuid is a single value: query each handler in order and return the first non-null/defined properties object found. Handlers are expected to return a single properties object or null for single-UUID requests.
• If uuid is an array: query every handler and accumulate all properties objects returned by handlers (handlers return arrays for multi-UUID requests). Missing UUIDs are omitted from the returned array.

Parameters

uuid

single UUID or array of UUIDs

string | string[]

Returns

Object | Object[] | null

single properties object, null (not found), or array of properties for array input

Inherited from

VectorLayer.getProperties

---

getSelectedUUIDs()

getSelectedUUIDs(): any[]

Defined in: layers/vector/VectorLayer.d.ts:138

Returns

any[]

Inherited from

VectorLayer.getSelectedUUIDs

---

getTarget()

getTarget(needsDepthBuffer?): any

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:84

Parameters

needsDepthBuffer?

boolean

Returns

any

Inherited from

VectorLayer.getTarget

---

invalidate()

invalidate(bounds): void

Defined in: layers/vector/VectorLayer.d.ts:423

invalidates draped tiles for the current bounds, forcing them to be re-drawn.

Parameters

bounds

Box2

Returns

void

Inherited from

VectorLayer.invalidate

---

loadLODTexture()

loadLODTexture(lodIndex, bounds): Promise<any>

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:82

Parameters

lodIndex

any

bounds

any

Returns

Promise<any>

Inherited from

VectorLayer.loadLODTexture

---

queryContains2D()

queryContains2D(target, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:316

Parameters

target

any

options?

Object

Returns

Object[]

Inherited from

VectorLayer.queryContains2D

---

queryContains3D()

queryContains3D(target, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:317

Parameters

target

any

options?

Object

Returns

Object[]

Inherited from

VectorLayer.queryContains3D

---

queryDistance2D()

queryDistance2D(target, options?): object[]

Defined in: layers/vector/VectorLayer.d.ts:320

Parameters

target

any

options?

Object

Returns

object[]

Inherited from

VectorLayer.queryDistance2D

---

queryDistance3D()

queryDistance3D(target, options?): object[]

Defined in: layers/vector/VectorLayer.d.ts:324

Parameters

target

any

options?

Object

Returns

object[]

Inherited from

VectorLayer.queryDistance3D

---

queryFeatures()

queryFeatures(): Object[]

Defined in: layers/vector/VectorLayer.d.ts:238

Returns

Object[]

Inherited from

VectorLayer.queryFeatures

---

queryIntersectCandidates2D()

queryIntersectCandidates2D(target, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:318

Parameters

target

any

options?

Object

Returns

Object[]

Inherited from

VectorLayer.queryIntersectCandidates2D

---

queryIntersectCandidates3D()

queryIntersectCandidates3D(target, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:319

Parameters

target

any

options?

Object

Returns

Object[]

Inherited from

VectorLayer.queryIntersectCandidates3D

---

raycast()

raycast(mapRaycaster, raycastOnDepthLLH, raycastOnDepthCartesian, raycastOnDepthDistance, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:433

raycasts through objects from this layer if the layer is selectable and if the objects are raycastable

Parameters

mapRaycaster

any

raycastOnDepthLLH

any

raycastOnDepthCartesian

any

raycastOnDepthDistance

any

options?

undefined

Returns

Object[]

an array of selected objects

Inherited from

VectorLayer.raycast

---

raycastEditing()

raycastEditing(raycasters, raycastOnDepthLLH, raycastOnDepthCartesian, raycastOnDepthDistance, options?): Object[]

Defined in: layers/vector/VectorLayer.d.ts:432

Parameters

raycasters

any

raycastOnDepthLLH

any

raycastOnDepthCartesian

any

raycastOnDepthDistance

any

options?

undefined

Returns

Object[]

Inherited from

VectorLayer.raycastEditing

---

removeFeatureChangeListener()

removeFeatureChangeListener(callback): void

Defined in: layers/vector/VectorLayer.d.ts:122

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.removeFeatureChangeListener

---

removeListener()

removeListener(key): void

Defined in: layers/Layer.d.ts:68

Removes the listener associated to the given key

Parameters

key

any

can be anything but should be unique

Returns

void

Inherited from

VectorLayer.removeListener

---

removeSelected()

removeSelected(): void

Defined in: layers/vector/VectorLayer.d.ts:446

Remove all currently-selected objects for this layer.

Returns

void

Inherited from

VectorLayer.removeSelected

---

removeSelectionListener()

removeSelectionListener(callback): void

Defined in: layers/vector/VectorLayer.d.ts:135

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.removeSelectionListener

---

removeUpdateCallback()

removeUpdateCallback(callback): void

Defined in: layers/vector/VectorLayer.d.ts:120

Parameters

callback

any

Returns

void

Inherited from

VectorLayer.removeUpdateCallback

---

render()

render(colorTexture, normalTexture, emissiveTexture, metalnessRoughnessTexture, positionTexture, renderTarget): boolean

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:100

Render imagery into a render target using the provided position texture. Subclasses must implement this method.

Parameters

colorTexture

any

normalTexture

any

emissiveTexture

any

metalnessRoughnessTexture

any

positionTexture

any

renderTarget

any

Returns

boolean

Inherited from

VectorLayer.render

---

selectByCondition()

selectByCondition(propertyName, condition): void

Defined in: layers/vector/VectorLayer.d.ts:409

calls the "condition" function with the specified property of every object and selects if the condition function returns true

Parameters

propertyName

string

condition

Function

Returns

void

Inherited from

VectorLayer.selectByCondition

---

setDrapedPointsAnchor()

setDrapedPointsAnchor(anchor): void

Defined in: layers/vector/VectorLayer.d.ts:485

Sets the anchor used for point billboards and updates point material uniforms. Note: anchor is also passed by reference into the material uniforms at creation so external modifications to the same Vector2 may also affect rendering.

Parameters

anchor

Vector2

Returns

void

Inherited from

VectorLayer.setDrapedPointsAnchor

---

setFeatureColor()

setFeatureColor(uuid, color): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:504

Parameters

uuid

any

color

any

Returns

Promise<void>

Inherited from

VectorLayer.setFeatureColor

---

setFeatureOpacity()

setFeatureOpacity(uuid, opacity, part?): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:514

Set opacity for one or more features. Part may be 'fill', 'outline', or 'both'. For non-polygon handlers routes to handler.setOpacity via _routeGranularUpdate. For polygon/extruded/draped polygons calls setFillOpacity/setOutlineOpacity on handlers.

Parameters

uuid

any

opacity

any

part?

string

Returns

Promise<void>

Inherited from

VectorLayer.setFeatureOpacity

---

setFeatureOutlineWidth()

setFeatureOutlineWidth(uuid, width): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:507

Parameters

uuid

any

width

any

Returns

Promise<void>

Inherited from

VectorLayer.setFeatureOutlineWidth

---

setFeatureSize()

setFeatureSize(uuid, size): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:505

Parameters

uuid

any

size

any

Returns

Promise<void>

Inherited from

VectorLayer.setFeatureSize

---

setFeatureWidth()

setFeatureWidth(uuid, width): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:506

Parameters

uuid

any

width

any

Returns

Promise<void>

Inherited from

VectorLayer.setFeatureWidth

---

setLinesWorldSized()

setLinesWorldSized(worldSized): void

Defined in: layers/vector/VectorLayer.d.ts:515

Parameters

worldSized

any

Returns

void

Inherited from

VectorLayer.setLinesWorldSized

---

setLODBounds()

setLODBounds(lodIndex, bounds): void

Defined in: layers/imagery/ClipMapImageryLayer.d.ts:85

Parameters

lodIndex

any

bounds

any

Returns

void

Inherited from

VectorLayer.setLODBounds

---

setName()

setName(name): void

Defined in: layers/Layer.d.ts:52

change the layer name

Parameters

name

string

Returns

void

Inherited from

VectorLayer.setName

---

setPointsAnchor()

setPointsAnchor(anchor): void

Defined in: layers/vector/VectorLayer.d.ts:478

Sets the anchor used for point billboards and updates point material uniforms. Note: anchor is also passed by reference into the material uniforms at creation so external modifications to the same Vector2 may also affect rendering.

Parameters

anchor

Vector2

Returns

void

Inherited from

VectorLayer.setPointsAnchor

---

setPointShape()

setPointShape(pointShape): void

Defined in: layers/vector/VectorLayer.d.ts:491

Sets the point shape used for point billboards. Draped points fall back from sphere to circle.

Parameters

pointShape

"sprite" | "circle" | "sphere"

Returns

void

Inherited from

VectorLayer.setPointShape

---

setPointTexture()

setPointTexture(texture): void

Defined in: layers/vector/VectorLayer.d.ts:461

Sets the texture used for points and updates both draped and non-draped point materials.

Parameters

texture

any

Returns

void

Inherited from

VectorLayer.setPointTexture

---

setPointWorldSized()

setPointWorldSized(worldSized): void

Defined in: layers/vector/VectorLayer.d.ts:496

Sets whether non-draped points are interpreted as world-sized or pixel-sized and updates materials & raycasters.

Parameters

worldSized

boolean

Returns

void

Inherited from

VectorLayer.setPointWorldSized

---

setVisible()

setVisible(visibility): void

Defined in: layers/vector/VectorLayer.d.ts:434

Modifies the layer visibility

Parameters

visibility

any

Returns

void

Inherited from

VectorLayer.setVisible

---

unselectByCondition()

unselectByCondition(propertyName, condition): void

Defined in: layers/vector/VectorLayer.d.ts:415

calls the "condition" function with the specified property of every object and un-selects if the condition function returns true

Parameters

propertyName

string

condition

Function

Returns

void

Inherited from

VectorLayer.unselectByCondition

---

update()

update(uuid, coordinates, height?, lineType?): Promise<any[]> | undefined

Defined in: layers/vector/VectorLayer.d.ts:451

Generic entry point for updates. It groups UUIDs and routes them only to the handlers that own them.

Parameters

uuid

any

coordinates

any

height?

undefined

lineType?

number

Returns

Promise<any[]> | undefined

Inherited from

VectorLayer.update

---

updateExtrudedPolygon()

updateExtrudedPolygon(uuid, coordinates, minHeight?, maxHeight?, lineType?): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:399

Parameters

uuid

any

coordinates

any

minHeight?

undefined

maxHeight?

undefined

lineType?

undefined

Returns

Promise<void>

Inherited from

VectorLayer.updateExtrudedPolygon

---

updateFeatureProperties()

updateFeatureProperties(uuid, properties): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:508

Parameters

uuid

any

properties

any

Returns

Promise<void>

Inherited from

VectorLayer.updateFeatureProperties

---

updateTerrainExtrudedPolygon()

updateTerrainExtrudedPolygon(uuid, coordinates, minHeight?, maxHeight?, lineType?, elevationLayer?): Promise<void>

Defined in: layers/vector/VectorLayer.d.ts:400

Parameters

uuid

any

coordinates

any

minHeight?

undefined

maxHeight?

undefined

lineType?

undefined

elevationLayer?

undefined

Returns

Promise<void>

Inherited from

VectorLayer.updateTerrainExtrudedPolygon