Class DrawBasicShape

Manage "shape" drawing interaction on an OpenLayers map.

Hierarchy (View Summary)

Interaction
- DrawBasicShape

Index

Constructors

Methods

destroy getInteraction getDefaultCircleOptions getDefaultLineOptions getDefaultPointOptions getDefaultPolygonOptions

Constructors

constructor

new DrawBasicShape(
    interactionGroup: InteractionGroup,
    interactionUid: string,
    options: Options,
): DrawBasicShape
Parameters
- interactionGroup: InteractionGroup
- interactionUid: string
- options: Options
Returns DrawBasicShape
Overrides Interaction.constructor
- Defined in interaction/drawBasicShape.ts:12

Methods

destroy

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

Returns void
Inherited from Interaction.destroy
- Defined in interaction/Interaction.ts:18

getInteraction

getInteraction(): undefined | Draw
Returns undefined | Draw
the interactions.
- Defined in interaction/drawBasicShape.ts:36

`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:58

`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:69

`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:81

`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:46