@jdultra/ultra-globe

---

@jdultra/ultra-globe / AreaController

Class: AreaController

Defined in: controls/AreaController.d.ts:11

AreaController

• Interactive area tool using a draped polyline / polygon.
• Left click appends a polygon vertex.
• A hover point is kept under the cursor to extend the preview polyline boundary.
• Polygon geometry and area measurements are only computed on click to maintain high performance.
• Escape/Delete/terminate() remove the temporary layer and deactivate the tool.
• The controller intentionally does not consume pointer events so navigation controllers such as pan/rotate can remain active while measuring.

Extends

• Controller

Constructors

Constructor

new AreaController(camera, domElement, map): AreaController

Defined in: controls/AreaController.d.ts:12

Parameters

camera

any

domElement

any

map

any

Returns

AreaController

Overrides

Controller.constructor

Properties

active

active: boolean

Defined in: controls/AreaController.d.ts:14

---

areaSquareKilometers

areaSquareKilometers: number

Defined in: controls/AreaController.d.ts:31

---

camera

camera: Camera

Defined in: controls/Controller.d.ts:13

Inherited from

Controller.camera

---

confirmedPoints

confirmedPoints: any[]

Defined in: controls/AreaController.d.ts:21

---

displayAreaSquareKilometers

displayAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:32

---

displayPerimeterKilometers

displayPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:30

---

dom

dom: HTMLDocument

Defined in: controls/Controller.d.ts:10

Inherited from

Controller.dom

---

elevatedAreaSquareKilometers

elevatedAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:39

---

elevatedDisplayAreaSquareKilometers

elevatedDisplayAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:40

---

elevatedDisplayPerimeterKilometers

elevatedDisplayPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:38

---

elevatedPerimeterKilometers

elevatedPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:37

---

ellipsoidAreaSquareKilometers

ellipsoidAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:35

---

ellipsoidDisplayAreaSquareKilometers

ellipsoidDisplayAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:36

---

ellipsoidDisplayPerimeterKilometers

ellipsoidDisplayPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:34

---

ellipsoidPerimeterKilometers

ellipsoidPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:33

---

fillColor

fillColor: any

Defined in: controls/AreaController.d.ts:19

---

finalized

finalized: boolean

Defined in: controls/AreaController.d.ts:25

---

hoverPoint

hoverPoint: any[] | null

Defined in: controls/AreaController.d.ts:22

---

isAreaController

isAreaController: boolean

Defined in: controls/AreaController.d.ts:13

---

labelStyle

labelStyle: Object

Defined in: controls/AreaController.d.ts:78

---

lineColor

lineColor: any

Defined in: controls/AreaController.d.ts:18

---

lineWidth

lineWidth: number

Defined in: controls/AreaController.d.ts:17

---

map

map: Map<any, any>

Defined in: controls/Controller.d.ts:12

Inherited from

Controller.map

---

measurementMode

measurementMode: string

Defined in: controls/AreaController.d.ts:98

---

mouseLatest

mouseLatest: { x: any; y: any; } | null

Defined in: controls/AreaController.d.ts:47

---

next

next: any

Defined in: controls/Controller.d.ts:9

Inherited from

Controller.next

---

onElevationAreaSquareKilometers

onElevationAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:43

---

onElevationDisplayAreaSquareKilometers

onElevationDisplayAreaSquareKilometers: number

Defined in: controls/AreaController.d.ts:44

---

onElevationDisplayPerimeterKilometers

onElevationDisplayPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:42

---

onElevationMaxSegmentsLength

onElevationMaxSegmentsLength: number | undefined

Defined in: controls/AreaController.d.ts:46

---

onElevationPending

onElevationPending: boolean

Defined in: controls/AreaController.d.ts:45

---

onElevationPerimeterKilometers

onElevationPerimeterKilometers: number

Defined in: controls/AreaController.d.ts:41

---

perimeterKilometers

perimeterKilometers: number

Defined in: controls/AreaController.d.ts:28

---

planet

planet: any

Defined in: controls/Controller.d.ts:11

Inherited from

Controller.planet

---

polygonOpacity

polygonOpacity: number

Defined in: controls/AreaController.d.ts:20

---

polygonUUID

polygonUUID: any

Defined in: controls/AreaController.d.ts:24

---

polylineUUID

polylineUUID: any

Defined in: controls/AreaController.d.ts:23

---

previewSegmentLengthKilometers

previewSegmentLengthKilometers: number

Defined in: controls/AreaController.d.ts:29

---

segmentLengthsKilometers

segmentLengthsKilometers: any[]

Defined in: controls/AreaController.d.ts:27

---

tempLabelsLayer

tempLabelsLayer: LabelsLayer | null

Defined in: controls/AreaController.d.ts:16

---

tempLayer

tempLayer: VectorLayer | null

Defined in: controls/AreaController.d.ts:15

---

vectorLayerStyle

vectorLayerStyle: Object

Defined in: controls/AreaController.d.ts:77

Methods

activate()

activate(style?): this

Defined in: controls/AreaController.d.ts:99

Parameters

style?

Object

Returns

this

---

append()

append(aController): void

Defined in: controls/Controller.d.ts:18

Parameters

aController

any

Returns

void

Inherited from

Controller.append

---

clear()

clear(): void

Defined in: controls/Controller.d.ts:20

Returns

void

Inherited from

Controller.clear

---

deactivate()

deactivate(): void

Defined in: controls/AreaController.d.ts:100

Returns

void

---

event()

event(eventName, e): void

Defined in: controls/Controller.d.ts:14

Parameters

eventName

any

e

any

Returns

void

Inherited from

Controller.event

---

getMeasurements()

getMeasurements(): Object

Defined in: controls/AreaController.d.ts:102

Returns

Object

---

terminate()

terminate(): void

Defined in: controls/AreaController.d.ts:101

Returns

void

---

update()

update(): void

Defined in: controls/Controller.d.ts:16

Returns

void

Inherited from

Controller.update