Skip to content

worldwind-ui API / react-worldwind / UseDrawToolResult

Interface: UseDrawToolResult ​

Defined in: react/src/hooks.ts:323

Properties ​

add ​

add: (feature) => void

Defined in: react/src/hooks.ts:336

Parameters ​

feature ​

DrawFeatureInput

Returns ​

void


cancel ​

cancel: () => void

Defined in: react/src/hooks.ts:330

Returns ​

void


clear ​

clear: () => void

Defined in: react/src/hooks.ts:332

Returns ​

void


finish ​

finish: () => void

Defined in: react/src/hooks.ts:329

Returns ​

void


load ​

load: (collection, options?) => void

Defined in: react/src/hooks.ts:338

Parameters ​

collection ​

DrawFeatureCollection

options? ​
replace? ​

boolean

Returns ​

void


remove ​

remove: (id) => void

Defined in: react/src/hooks.ts:334

Parameters ​

id ​

string

Returns ​

void


removeSelected ​

removeSelected: () => void

Defined in: react/src/hooks.ts:335

Returns ​

void


select ​

select: (id, vertex?) => void

Defined in: react/src/hooks.ts:333

Parameters ​

id ​

string | null

vertex? ​

number | null

Returns ​

void


start ​

start: (mode) => void

Defined in: react/src/hooks.ts:327

Parameters ​

mode ​

DrawMode

Returns ​

void


state ​

state: DrawState

Defined in: react/src/hooks.ts:324


stop ​

stop: () => void

Defined in: react/src/hooks.ts:328

Returns ​

void


toGeoJson ​

toGeoJson: () => DrawFeatureCollection

Defined in: react/src/hooks.ts:337

Returns ​

DrawFeatureCollection


tool ​

tool: DrawTool | null

Defined in: react/src/hooks.ts:326

The tool, or null until the globe effect has created it.


undo ​

undo: () => void

Defined in: react/src/hooks.ts:331

Returns ​

void

MIT licensed. Not affiliated with NASA; WorldWind is NASA's open-source virtual globe.