Class Draw

Class used for drawing features on a map

Draw

Exports

Hierarchy (View Summary)

Interaction
- Draw

Index

Constructors

Properties

Methods

offDrawAbort offDrawEnd offDrawStart onDrawAbort onDrawEnd onDrawStart startInteraction stopInteraction

Constructors

constructor

new Draw(options: DrawOptions): Draw
Initializes a Draw component.
Parameters
- options: DrawOptions
  Object to configure the initialization of the Draw interaction.
Returns Draw
Overrides Interaction.constructor
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:53

Properties

mapViewer

mapViewer: MapViewer

Reference the MapViewer associated with this interaction

Methods

offDrawAbort

offDrawAbort(callback: DrawDelegate): void
Unregisters a callback handler for the drawabort event.
Parameters
- callback: DrawDelegate
  The callback to stop being called whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:189

offDrawEnd

offDrawEnd(callback: DrawDelegate): void
Unregisters a callback handler for the drawend event.
Parameters
- callback: DrawDelegate
  The callback to stop being called whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:161

offDrawStart

offDrawStart(callback: DrawDelegate): void
Unregisters a callback handler for the drawstart event.
Parameters
- callback: DrawDelegate
  The callback to stop being called whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:133

onDrawAbort

onDrawAbort(callback: DrawDelegate): void
Registers a callback handler for the drawabort event.
Parameters
- callback: DrawDelegate
  The callback to be executed whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:180

onDrawEnd

onDrawEnd(callback: DrawDelegate): void
Registers a callback handler for the drawend event.
Parameters
- callback: DrawDelegate
  The callback to be executed whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:152

onDrawStart

onDrawStart(callback: DrawDelegate): void
Registers a callback handler for the drawstart event.
Parameters
- callback: DrawDelegate
  The callback to be executed whenever the event is emitted.
Returns void
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:124

startInteraction

startInteraction(): void
Starts the interaction on the map

Returns void
Overrides Interaction.startInteraction
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:93

stopInteraction

stopInteraction(): void
Stops the interaction on the map

Returns void
Overrides Interaction.stopInteraction
- Defined in packages/geoview-core/src/geo/interaction/draw.ts:102