Class Snap

Class used for snapping features on a map.

Hierarchy (View Summary)

Interaction
- Snap

Index

Constructors

Properties

Methods

startInteraction stopInteraction

Constructors

constructor

new Snap(options: SnapOptions, geometryApi: GeometryApi): Snap
Initializes a Snap component.
Parameters
- options: SnapOptions
  Object to configure the initialization of the Snap interaction
- geometryApi: GeometryApi
  The geometry API used to retrieve geometry groups if a geometry group key is provided in the options
Returns Snap
Overrides Interaction.constructor
- Defined in packages/geoview-core/src/geo/interaction/snap.ts:31

Properties

mapViewer

mapViewer: MapViewer

Reference the MapViewer associated with this interaction

Methods

startInteraction

startInteraction(): void
Starts the interaction on the map.

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

stopInteraction

stopInteraction(): void
Stops the interaction on the map.

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