Class DrawBasicShape

Manage "shape" drawing interaction on an OpenLayers map.

Hierarchy (View Summary)

Draw
- DrawBasicShape

Index

Constructors

Methods

destroy getFullUid getInteraction setActive getDefaultCircleOptions getDefaultLineOptions getDefaultPointOptions getDefaultPolygonOptions

Constructors

constructor

new DrawBasicShape(map: Map, options: Options, uid: string): DrawBasicShape
Parameters
- map: Map
- options: Options
- uid: string
Returns DrawBasicShape
Overrides Draw.constructor
- Defined in interaction/drawBasicShape.ts:12

Methods

destroy

destroy(): void
Remove the interaction from the map.

Returns void
Inherited from Draw.destroy
- Defined in interaction/draw.ts:35

getFullUid

getFullUid(uid: string): string
Parameters
- uid: string
Returns string
the uid of the interaction.
Inherited from Draw.getFullUid
- Defined in interaction/draw.ts:42

getInteraction

getInteraction(): Draw
Returns Draw
the interaction.
Inherited from Draw.getInteraction
- Defined in interaction/draw.ts:49

setActive

setActive(active: boolean): void
Activate the interaction (and deactivate other draw interactions), or deactivate it.
Parameters
- active: boolean
Returns void
Inherited from Draw.setActive
- Defined in interaction/draw.ts:57

`Static`getDefaultCircleOptions

getDefaultCircleOptions(source: VectorSource<Feature<Geometry>>): Options
Get defaults configured Drawing options to draw circles.
Parameters
- source: VectorSource<Feature<Geometry>>
Returns Options
Static
- Defined in interaction/drawBasicShape.ts:44

`Static`getDefaultLineOptions

getDefaultLineOptions(source: VectorSource<Feature<Geometry>>): Options
Get defaults configured Drawing options to draw lines.
Parameters
- source: VectorSource<Feature<Geometry>>
Returns Options
Static
- Defined in interaction/drawBasicShape.ts:55

`Static`getDefaultPointOptions

getDefaultPointOptions(source: VectorSource<Feature<Geometry>>): Options
Get defaults configured Drawing options to draw points.
Parameters
- source: VectorSource<Feature<Geometry>>
Returns Options
Static
- Defined in interaction/drawBasicShape.ts:67

`Static`getDefaultPolygonOptions

getDefaultPolygonOptions(source: VectorSource<Feature<Geometry>>): Options
Get defaults configured Drawing options to draw polygons.
Parameters
- source: VectorSource<Feature<Geometry>>
Returns Options
Static
- Defined in interaction/drawBasicShape.ts:32