MapGestureArea QML Type | Qt Location 5.5

- Qt 5.5
- Qt Location
- QML Types
- MapGestureArea QML Type
- Qt 5.5.1 Reference Documentation

# MapGestureArea QML Type

The MapGestureArea type provides Map gesture interaction. More...

Import Statement: | import QtLocation 5.3
Since: | Qt Location 5.0

- List of all members, including inherited members

## Properties

- activeGestures : enumeration
- enabled : bool
- flickDeceleration : real
- isPanActive : bool
- isPinchActive : bool
- maximumZoomLevelChange : real
- panEnabled : bool
- pinchEnabled : bool

## Signals

- flickFinished()
- flickStarted()
- panFinished()
- panStarted()
- pinchFinished(PinchEvent event)
- pinchStarted(PinchEvent event)
- pinchUpdated(PinchEvent event)

## Detailed Description

MapGestureArea objects are used as part of a Map, to provide for panning, flicking and pinch-to-zoom gesture used on touch displays.

A MapGestureArea is automatically created with a new Map and available with the gesture property. This is the only way to create a MapGestureArea, and once created this way cannot be destroyed without its parent Map.

The two most commonly used properties of the MapGestureArea are the enabled and activeGestures properties. Both of these must be set before a MapGestureArea will have any effect upon interaction with the Map. The flickDeceleration property controls how quickly the map pan slows after contact is released while panning the map.

### Performance

The MapGestureArea, when enabled, must process all incoming touch events in order to track the shape and size of the "pinch". The overhead added on touch events can be considered constant time.

### Example Usage

The following example enables the zoom and pan gestures on the map, but not flicking. So the map scrolling will halt immediately on releasing the mouse button / touch.

    Map {
        gesture.enabled: true
        gesture.activeGestures: MapGestureArea.ZoomGesture | MapGestureArea.PanGesture
    }

## Property Documentation

activeGestures : enumeration

This property holds the gestures that will be active. By default the zoom, pan and flick gestures are enabled.

- MapGestureArea.NoGesture - Don't support any additional gestures (value: 0x0000).
- MapGestureArea.ZoomGesture - Support the map zoom gesture (value: 0x0001).
- MapGestureArea.PanGesture - Support the map pan gesture (value: 0x0002).
- MapGestureArea.FlickGesture - Support the map flick gesture (value: 0x0004).

enabled : bool

This property holds whether the gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.

flickDeceleration : real

This property holds the rate at which a flick will decelerate.

The default value is 2500.

isPanActive : bool

This read-only property holds whether any pan gesture (panning or flicking) is active.

Note: Change notifications for this property were introduced in Qt 5.5.

isPinchActive : bool

This read-only property holds whether any pinch gesture is active.

maximumZoomLevelChange : real

This property holds the maximum zoom level change per pinch, essentially meant to be used for setting the zoom sensitivity.

It is an indicative measure calculated from the dimensions of the map area, roughly corresponding how much zoom level could change with maximum pinch zoom. Default value is 4.0, maximum value is 10.0

panEnabled : bool

This property holds whether the pan gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.

pinchEnabled : bool

This property holds whether the pinch gestures are enabled. Note: disabling gestures during an active gesture does not have effect on the potentially active current gesture.

## Signal Documentation

flickFinished()

This signal is emitted when the view stops moving due to a flick. The order of panFinished() and flickFinished() is not specified.

The corresponding handler is `onFlickFinished`.

flickStarted()

This signal is emitted when the view is flicked. A flick starts from the point that the mouse or touch is released, while still in motion.

The corresponding handler is `onFlichStarted`.

panFinished()

This signal is emitted when the view stops moving due to user interaction. If a flick was generated, this signal is emitted when the flick stops. If a flick was not generated, this signal is emitted when the user stops dragging - that is a mouse or touch release.

The corresponding handler is `onPanFinished`.

panStarted()

This signal is emitted when the view begins moving due to user interaction. Typically this means that the user is dragging a finger - or a mouse with one of more mouse buttons pressed - on the map.

The corresponding handler is `onPanStarted`.

pinchFinished(PinchEvent event)

This signal is emitted at the end of a pinch gesture.

The corresponding handler is `onPinchFinished`.

See also pinchStarted and pinchUpdated.

pinchStarted(PinchEvent event)

This signal is emitted when a pinch gesture is started.

The corresponding handler is `onPinchStarted`.

See also pinchUpdated and pinchFinished.

pinchUpdated(PinchEvent event)

This signal is emitted as the user's fingers move across the map, after the pinchStarted signal is emitted.

The corresponding handler is `onPinchUpdated`.

See also pinchStarted and pinchFinished.