worldwind-ui API / react-worldwind / DrawToolProps

Interface: DrawToolProps

Defined in: react/src/ui/DrawTool.tsx:8

Extends

• DrawToolOptions

Properties

className?

optional className?: string

Defined in: react/src/ui/DrawTool.tsx:17

---

downloadName?

optional downloadName?: string

Defined in: react/src/ui/DrawTool.tsx:16

File name for the download.

---

editable?

optional editable?: boolean

Defined in: kit/src/draw.ts:63

Let features be selected, dragged and deleted. Default true.

Inherited from

DrawToolOptions.editable

---

finishOnDoubleClick?

optional finishOnDoubleClick?: boolean

Defined in: kit/src/draw.ts:65

Finish a line or polygon on double-click. Default true.

Inherited from

DrawToolOptions.finishOnDoubleClick

---

handleImage?

optional handleImage?: string | null

Defined in: kit/src/draw.ts:60

Image for vertex handles. Defaults to WorldWind's white dot.

Inherited from

DrawToolOptions.handleImage

---

handleScale?

optional handleScale?: number

Defined in: kit/src/draw.ts:61

Inherited from

DrawToolOptions.handleScale

---

heading?

optional heading?: string | null

Defined in: react/src/ui/DrawTool.tsx:10

---

idPrefix?

optional idPrefix?: string

Defined in: kit/src/draw.ts:69

Prefix of generated feature ids. Default feature-.

Inherited from

DrawToolOptions.idPrefix

---

keyboard?

optional keyboard?: boolean

Defined in: kit/src/draw.ts:67

On the focused canvas: Escape cancels, Enter finishes, Delete and Backspace remove. Default true.

Inherited from

DrawToolOptions.keyboard

---

layerName?

optional layerName?: string

Defined in: kit/src/draw.ts:48

Inherited from

DrawToolOptions.layerName

---

line?

optional line?: ShapeStyle

Defined in: kit/src/draw.ts:54

Style of lines. Defaults to an orange 3 px line.

Inherited from

DrawToolOptions.line

---

onChange?

optional onChange?: (features) => void

Defined in: react/src/ui/DrawTool.tsx:12

Called with the features whenever they change.

Parameters

features

readonly DrawFeature[]

Returns

void

---

pathType?

optional pathType?: PathType

Defined in: kit/src/draw.ts:49

Inherited from

DrawToolOptions.pathType

---

pointImage?

optional pointImage?: string | null

Defined in: kit/src/draw.ts:51

Image for point features. Defaults to a red pushpin.

Inherited from

DrawToolOptions.pointImage

---

pointScale?

optional pointScale?: number

Defined in: kit/src/draw.ts:52

Inherited from

DrawToolOptions.pointScale

---

polygon?

optional polygon?: ShapeStyle

Defined in: kit/src/draw.ts:56

Style of polygons. Defaults to a translucent orange fill.

Inherited from

DrawToolOptions.polygon

---

position?

optional position?: PanelPosition

Defined in: react/src/ui/DrawTool.tsx:9

---

selected?

optional selected?: ShapeStyle

Defined in: kit/src/draw.ts:58

Applied on top of the line or polygon style while a feature is selected.

Inherited from

DrawToolOptions.selected

---

showDownload?

optional showDownload?: boolean

Defined in: react/src/ui/DrawTool.tsx:14

Add a button that downloads the drawings as GeoJSON. Default false.