Javascript API 7.x

Class: KeyTrigger

bu.interaction. KeyTrigger

An interaction to control a viewer by pressing and unpressing a key that triggers and event.

new KeyTrigger( [options])

Parameters:
Name Type Argument Description
options bu.interaction.KeyOptions <optional>

Options.
Source:
bu/interaction/keytrigger.js
Fires:
  • ol.Object.Event#event:change:active

Extends

Members

parameters :Object.<string, (number|string|boolean)>

The object that stores values for the parameters this interaction modifies. Property names of the object are the parameter names and values are simple primitives as number, string or boolean.

Type:
  • Object.<string, (number|string|boolean)>
Inherited From:
Overrides:
Source:
bu/interaction/triggerinteraction.js

Methods

getActive()

Return whether the interaction is currently active.

Inherited From:
Source:
bu/interaction/interaction.js
Returns:

true if the interaction is active, false otherwise.

Type
boolean

getElement()

Return the DOM element where the events are listened to.

Inherited From:
Source:
bu/interaction/interaction.js
Returns:
Type
Element

setActive(active)

Activate or deactivate the interaction.

Parameters:
Name Type Description
active boolean

Active.
Inherited From:
Source:
bu/interaction/interaction.js