Class EventHandler

featureInteraction

• get featureInteraction(): FeatureAtPixelInteraction

• Returns FeatureAtPixelInteraction

featureProviderInteraction

• get featureProviderInteraction(): FeatureProviderInteraction

• Returns FeatureProviderInteraction

interactions

• get interactions(): AbstractInteraction[]

• A copy of all the EventHandler interactions

  Returns AbstractInteraction[]

modifierChanged

• get modifierChanged(): VcsEvent<ModificationKeyType>

• An event called, when the modifier changes. Order of precedence, if more then one key is pressed: SHIFT, ALT, CTRL

  Returns VcsEvent<ModificationKeyType>

positionInteraction

• get positionInteraction(): CoordinateAtPixel

• Returns CoordinateAtPixel

constructor

• new EventHandler(): EventHandler

• Returns EventHandler

addExclusiveInteraction

• addExclusiveInteraction(interaction, removed, index?, id?): (() => void)

• Add a dynamic interaction to the interaction chain. This is the default methodology for user map interactions, such as drawing or measuring. If another exclusive interaction is added, this interaction is removed and a provided callback is called. Use the id parameter to add multiple interactions from the same source (if you don't wish to provide an InteractionChain)

  Parameters

  • interaction: AbstractInteraction

  • removed: (() => void)

    the callback for when the interaction is forcefully removed.

    • • (): void

      • Returns void

  • Optional index: number

    the position at which to push the interaction. If no index is provided, the interaction is pushed at the end and therefore is executed last.

  • Optional id: string

    an id to allow for multiple interactions to belong to the same exclusive registerer

  Returns (() => void)

  function to remove the interaction with. returns number of removed interactions (0|1)

  • • (): void

    • Add a dynamic interaction to the interaction chain. This is the default methodology for user map interactions, such as drawing or measuring. If another exclusive interaction is added, this interaction is removed and a provided callback is called. Use the id parameter to add multiple interactions from the same source (if you don't wish to provide an InteractionChain)

      Returns void

      function to remove the interaction with. returns number of removed interactions (0|1)

addPersistentInteraction

• addPersistentInteraction(interaction, index?): (() => number)

• Adds an interaction permanently to the interaction chain. Only add non-interferring interactions in such a fashion (for instance for displaying the cursor position)

  Parameters

  • interaction: AbstractInteraction

  • Optional index: number = 3

    at what position this interaction should be added. By default, it is added after the featureProviderInteraction

  Returns (() => number)

  function to remove the interaction with. returns number of removed interactions (0|1)

  • • (): number

    • Adds an interaction permanently to the interaction chain. Only add non-interferring interactions in such a fashion (for instance for displaying the cursor position)

      Returns number

      function to remove the interaction with. returns number of removed interactions (0|1)

destroy

• destroy(): void

• Destroys the event handler and its interaction chain.

  Returns void

handleMapEvent

• handleMapEvent(event): void

• Handles an event triggered by

  Parameters

  • event: MapEvent

  Returns void

removeExclusive

• removeExclusive(): void

• Removes any exclusive listeners. Typically only called from the framework to ensure the pubsub listeners are consistent

  Returns void

clickDuration

dragDuration

exclusiveAdded

exclusiveRemoved