InteractionConfiguration

Properties

• cursor_keyboard_rotation_configuration(CursorKeyboardRotationConfiguration) –

  Options to control the keyboard and mouse cursor being used together

• enable_multi_finger_gesture_race(bool) –

  If True, then rotation_threshold and pinch_zoom_threshold

• flags(InteractionFlag) –

  Defines the map events to be enabled/disabled.

• keyboard_configuration(KeyboardConfiguration) –

  Options to configure how keyboard keys may be used to control the map.

• pinch_move_threshold(Number) –

  Map starts to move when pinch_move_threshold has been achieved

• pinch_move_win_gestures(MultiFingerGesture) –

  When pinch_move_threshold wins over rotation_threshold

• pinch_zoom_threshold(Number) –

  Map starts to zoom when pinch_zoom_threshold has been achieved or

• pinch_zoom_win_gestures(MultiFingerGesture) –

  When pinch_zoom_threshold wins over rotation_threshold

• rotation_threshold(Number) –

  Map starts to rotate when rotation_threshold has been achieved or

• rotation_win_gestures(MultiFingerGesture) –

  When rotation_threshold wins over pinch_zoom_threshold and

• scroll_wheel_velocity(Number) –

  The used velocity how fast the map should zoom in or out by scrolling

Properties

cursor_keyboard_rotation_configuration class-attribute instance-attribute

cursor_keyboard_rotation_configuration: CursorKeyboardRotationConfiguration = field(
    default_factory=lambda: CursorKeyboardRotationConfiguration()
)

Options to control the keyboard and mouse cursor being used together to rotate the map.

enable_multi_finger_gesture_race class-attribute instance-attribute

enable_multi_finger_gesture_race: bool = False

If True, then rotation_threshold and pinch_zoom_threshold and pinch_move_threshold will race. If multiple gestures win at the same time, then precedence: pinch_zoom_win_gestures > rotation_win_gestures > pinch_move_win_gestures

flags class-attribute instance-attribute

flags: InteractionFlag = ALL

Defines the map events to be enabled/disabled.

keyboard_configuration class-attribute instance-attribute

keyboard_configuration: KeyboardConfiguration = field(
    default_factory=lambda: KeyboardConfiguration()
)

Options to configure how keyboard keys may be used to control the map.

Keyboard movements using the arrow keys are enabled by default.

pinch_move_threshold class-attribute instance-attribute

pinch_move_threshold: Number = 40.0

Map starts to move when pinch_move_threshold has been achieved or another multi finger gesture wins which allows MultiFingerGesture.PINCH_MOVE.

Note

If InteractionConfiguration.flags doesn't contain InteractionFlag.PINCH_MOVE or enable_multi_finger_gesture_race is false then pinch move cannot win.

pinch_move_win_gestures class-attribute instance-attribute

pinch_move_win_gestures: MultiFingerGesture = (
    PINCH_ZOOM | PINCH_MOVE
)

When pinch_move_threshold wins over rotation_threshold and pinch_zoom_threshold then pinch_move_win_gestures gestures will be used.

By default MultiFingerGesture.PINCH_MOVE and MultiFingerGesture.PINCH_ZOOM gestures will take effect see MultiFingerGesture for custom settings.

pinch_zoom_threshold class-attribute instance-attribute

pinch_zoom_threshold: Number = 0.5

Map starts to zoom when pinch_zoom_threshold has been achieved or another multi finger gesture wins which allows MultiFingerGesture.PINCH_ZOOM.

Note

If InteractionConfiguration.flags doesn't contain InteractionFlag.PINCH_ZOOM or enable_multi_finger_gesture_race is false then zoom cannot win.

pinch_zoom_win_gestures class-attribute instance-attribute

pinch_zoom_win_gestures: MultiFingerGesture = (
    PINCH_ZOOM | PINCH_MOVE
)

When pinch_zoom_threshold wins over rotation_threshold and pinch_move_threshold then pinch_zoom_win_gestures gestures will be used.

By default MultiFingerGesture.PINCH_ZOOM and MultiFingerGesture.PINCH_MOVE gestures will take effect see MultiFingerGesture for custom settings.

rotation_threshold class-attribute instance-attribute

rotation_threshold: Number = 20.0

Map starts to rotate when rotation_threshold has been achieved or another multi finger gesture wins which allows MultiFingerGesture.ROTATE.

Note

If InteractionConfiguration.flags doesn't contain InteractionFlag.ROTATE or enable_multi_finger_gesture_race is false then rotate cannot win.

rotation_win_gestures class-attribute instance-attribute

rotation_win_gestures: MultiFingerGesture = ROTATE

When rotation_threshold wins over pinch_zoom_threshold and pinch_move_threshold then rotation_win_gestures gestures will be used.

scroll_wheel_velocity class-attribute instance-attribute

scroll_wheel_velocity: Number = 0.005

The used velocity how fast the map should zoom in or out by scrolling with the scroll wheel of a mouse.