InteractionConfiguration

Configures user interaction behavior.

Properties

• cursor_keyboard_rotation_configuration - Options to control the keyboard and mouse cursor being used together to rotate the map.
• enable_multi_finger_gesture_race - If True, then rotation_threshold and pinch_zoom_threshold and pinch_move_threshold will race.
• flags - Defines the map events to be enabled/disabled.
• keyboard_configuration - Options to configure how keyboard keys may be used to control the map.
• pinch_move_threshold - Map starts to move when pinch_move_threshold has been achieved or another multi finger gesture wins which allows flet_map.MultiFingerGesture.PINCH_MOVE.
• pinch_move_win_gestures - When pinch_move_threshold wins over rotation_threshold and pinch_zoom_threshold then pinch_move_win_gestures gestures will be used.
• pinch_zoom_threshold - Map starts to zoom when pinch_zoom_threshold has been achieved or another multi finger gesture wins which allows flet_map.MultiFingerGesture.PINCH_ZOOM.
• pinch_zoom_win_gestures - When pinch_zoom_threshold wins over rotation_threshold and pinch_move_threshold then pinch_zoom_win_gestures gestures will be used.
• rotation_threshold - Map starts to rotate when rotation_threshold has been achieved or another multi finger gesture wins which allows flet_map.MultiFingerGesture.ROTATE.
• rotation_win_gestures - When rotation_threshold wins over pinch_zoom_threshold and pinch_move_threshold then rotation_win_gestures gestures will be used.
• scroll_wheel_velocity - The used velocity how fast the map should zoom in or out by scrolling with the scroll wheel of a mouse.

Properties

buildcursor_keyboard_rotation_configurationclass-attributeinstance-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.

buildenable_multi_finger_gesture_raceclass-attributeinstance-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

buildflagsclass-attributeinstance-attribute

flags: InteractionFlag = InteractionFlag.ALL

Defines the map events to be enabled/disabled.

buildkeyboard_configurationclass-attributeinstance-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.

buildpinch_move_thresholdclass-attributeinstance-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 flet_map.MultiFingerGesture.PINCH_MOVE.

Note

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

buildpinch_move_win_gesturesclass-attributeinstance-attribute

pinch_move_win_gestures: MultiFingerGesture = MultiFingerGesture.PINCH_ZOOM | MultiFingerGesture.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 flet_map.MultiFingerGesture.PINCH_MOVE and flet_map.MultiFingerGesture.PINCH_ZOOM gestures will take effect see MultiFingerGesture for custom settings.

buildpinch_zoom_thresholdclass-attributeinstance-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 flet_map.MultiFingerGesture.PINCH_ZOOM.

Note

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

buildpinch_zoom_win_gesturesclass-attributeinstance-attribute

pinch_zoom_win_gestures: MultiFingerGesture = MultiFingerGesture.PINCH_ZOOM | MultiFingerGesture.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 flet_map.MultiFingerGesture.PINCH_ZOOM and flet_map.MultiFingerGesture.PINCH_MOVE gestures will take effect see MultiFingerGesture for custom settings.

buildrotation_thresholdclass-attributeinstance-attribute

rotation_threshold: Number = 20.0

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

Note

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

buildrotation_win_gesturesclass-attributeinstance-attribute

rotation_win_gestures: MultiFingerGesture = MultiFingerGesture.ROTATE

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

buildscroll_wheel_velocityclass-attributeinstance-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.