Class QfMapCanvas

ClassList > QfMapCanvas

Inherits the following classes: QtQuick::Item

Inherited by the following classes: MapCanvas

Public Properties

Type	Name
property real	bottomMargin
property bool	forceDeferredLayersRepaint
property bool	freehandDigitizing
property bool	hovered
property bool	incrementalRendering
property bool	interactive
property bool	isMapRotationEnabled
property bool	isRendering
property bool	jumping
property QgsQuickMapCanvasMap	mapCanvasWrapper
property QgsQuickMapSettings	mapSettings
property bool	mouseAsTouchScreen Treat mouse and touchpad input as touch screen input.
property bool	pinched
property bool	previewJobsEnabled
property list< int >	previewJobsQuadrants
property real	quality
property real	rightMargin
property bool	smooth

Public Signals

Type	Name
signal void	aboutToWheelZoom Emitted when a zoom action is about to occur, allowing for pre-zoom adjustments.
signal void	clicked (var point, var type) This signal is emitted independently of double tap / click.
signal void	confirmedClicked (var point) This signal is only emitted if there is no double tap/click coming after a short delay.
signal void	doubleClicked (var point, var type) This signal is emitted on a double tap.
signal void	longPressReleased (var type) Emitted when a release happens after a long press.
signal void	longPressed (var point, var type)
signal void	rightClicked (var point, var type) This signal is emitted when a right mouse/stylus click occurs.

Public Functions

Type	Name
void	freeze (id)
void	jumpTo (point, scale=-1, rotation=-1, handleMargins=false, callback=null)
void	jumpToPosition (positionSource, scale=-1, rotation=-1, handleMargins=false, callback=null)
void	refresh (ignoreFreeze)
void	stopRendering ()
void	unfreeze (id)
void	zoomIn (point)
void	zoomOut (point)

Public Properties Documentation

property bottomMargin

real QfMapCanvas::bottomMargin;

---

property forceDeferredLayersRepaint

bool QfMapCanvas::forceDeferredLayersRepaint;

---

property freehandDigitizing

bool QfMapCanvas::freehandDigitizing;

---

property hovered

bool QfMapCanvas::hovered;

---

property incrementalRendering

bool QfMapCanvas::incrementalRendering;

---

property interactive

bool QfMapCanvas::interactive;

---

property isMapRotationEnabled

bool QfMapCanvas::isMapRotationEnabled;

---

property isRendering

bool QfMapCanvas::isRendering;

---

property jumping

bool QfMapCanvas::jumping;

Remark:

This property is read-only

---

property mapCanvasWrapper [1/2]

QgsQuickMapCanvasMap QfMapCanvas::mapCanvasWrapper;

---

property mapSettings

QgsQuickMapSettings QfMapCanvas::mapSettings;

---

property mouseAsTouchScreen

Treat mouse and touchpad input as touch screen input.

bool QfMapCanvas::mouseAsTouchScreen;

---

property pinched

bool QfMapCanvas::pinched;

Remark:

This property is read-only

---

property previewJobsEnabled

bool QfMapCanvas::previewJobsEnabled;

---

property previewJobsQuadrants

list<int> QfMapCanvas::previewJobsQuadrants;

---

property quality

real QfMapCanvas::quality;

---

property rightMargin

real QfMapCanvas::rightMargin;

---

property smooth

bool QfMapCanvas::smooth;

---

Public Signals Documentation

signal aboutToWheelZoom

Emitted when a zoom action is about to occur, allowing for pre-zoom adjustments.

void QfMapCanvas::aboutToWheelZoom;

---

signal clicked

This signal is emitted independently of double tap / click.

void QfMapCanvas::clicked;

---

signal confirmedClicked

This signal is only emitted if there is no double tap/click coming after a short delay.

void QfMapCanvas::confirmedClicked;

---

signal doubleClicked

This signal is emitted on a double tap.

void QfMapCanvas::doubleClicked;

---

signal longPressReleased

Emitted when a release happens after a long press.

void QfMapCanvas::longPressReleased;

---

signal longPressed

void QfMapCanvas::longPressed;

---

signal rightClicked

This signal is emitted when a right mouse/stylus click occurs.

void QfMapCanvas::rightClicked;

---

Public Functions Documentation

function freeze

void QfMapCanvas::freeze (
    id
) 

Freezes the map canvas refreshes.

In case of repeated geometry changes (animated resizes, pinch, pan...) triggering refreshes all the time can cause severe performance impacts.

If freeze is called, an internal counter is incremented and only when the counter is 0, refreshes will happen. It is therefore important to call freeze() and unfreeze() exactly the same number of times.

---

function jumpTo

void QfMapCanvas::jumpTo (
    point,
    scale=-1,
    rotation=-1,
    handleMargins=false,
    callback=null
) 

Smoothly animates the map to a new center point

---

function jumpToPosition

void QfMapCanvas::jumpToPosition (
    positionSource,
    scale=-1,
    rotation=-1,
    handleMargins=false,
    callback=null
) 

Jump and track a moving target

---

function refresh

void QfMapCanvas::refresh (
    ignoreFreeze
) 

---

function stopRendering

void QfMapCanvas::stopRendering () 

---

function unfreeze

void QfMapCanvas::unfreeze (
    id
) 

---

function zoomIn

void QfMapCanvas::zoomIn (
    point
) 

---

function zoomOut

void QfMapCanvas::zoomOut (
    point
) 

---

---

The documentation for this class was generated from the following file src/core/qml/QfMapCanvas.qml