QGIS API Documentation 3.39.0-Master (e8f1b343c48)
|
Map canvas is a class for displaying all GIS data types on a canvas. More...
#include <qgsmapcanvas.h>
Classes | |
class | CanvasProperties |
Deprecated to be deleted, stuff from here should be moved elsewhere. More... | |
Public Slots | |
void | layerStateChange () |
This slot is connected to the visibility change of one or more layers. | |
void | readProject (const QDomDocument &) |
called to read map canvas settings from project | |
void | redrawAllLayers () |
Clears all cached images and redraws all layers. | |
void | refresh () |
Repaints the canvas map. | |
void | refreshAllLayers () |
Reload all layers (including refreshing layer properties from their data sources), clears the cache and refreshes the canvas. | |
void | saveAsImage (const QString &fileName, QPixmap *QPixmap=nullptr, const QString &="PNG") |
Save the contents of the map canvas to disk as an image. | |
void | selectionChangedSlot () |
Receives signal about selection change, and pass it on with layer info. | |
void | setMagnificationFactor (double factor, const QgsPointXY *center=nullptr) |
Sets the factor of magnification to apply to the map canvas. | |
void | setRenderFlag (bool flag) |
Sets whether a user has disabled canvas renders via the GUI. | |
void | setScaleLocked (bool isLocked) |
Lock the scale, so zooming can be performed using magnication. | |
void | setZoomResolutions (const QList< double > &resolutions) |
Set a list of resolutions (map units per pixel) to which to "snap to" when zooming the map. | |
void | setZRange (const QgsDoubleRange &range) |
Sets the range of z-values which will be visible in the map. | |
void | stopRendering () |
stop rendering (if there is any right now) | |
void | writeProject (QDomDocument &) |
called to write map canvas settings to project | |
void | zoomIn () |
Zoom in with fixed factor. | |
double | zoomInFactor () const |
Returns the zoom in factor. | |
void | zoomOut () |
Zoom out with fixed factor. | |
double | zoomOutFactor () const |
Returns the zoom in factor. | |
const QList< double > & | zoomResolutions () const |
void | zoomToSelected (const QList< QgsMapLayer * > &layers) |
Zoom to the combined extent of the selected features of all provided (vector) layers. | |
void | zoomToSelected (QgsMapLayer *layer=nullptr) |
Zoom to the extent of the selected features of provided map layer. | |
QgsDoubleRange | zRange () const |
Returns the range of z-values which will be visible in the map. | |
Signals | |
void | canvasColorChanged () |
Emitted when canvas background color changes. | |
void | contextMenuAboutToShow (QMenu *menu, QgsMapMouseEvent *event) |
Emitted before the map canvas context menu will be shown. | |
void | currentLayerChanged (QgsMapLayer *layer) |
Emitted when the current layer is changed. | |
void | destinationCrsChanged () |
Emitted when map CRS has changed. | |
void | extentsChanged () |
Emitted when the extents of the map change. | |
void | keyPressed (QKeyEvent *e) |
Emit key press event. | |
void | keyReleased (QKeyEvent *e) |
Emit key release event. | |
void | layersChanged () |
Emitted when a new set of layers has been received. | |
void | layerStyleOverridesChanged () |
Emitted when the configuration of overridden layer styles changes. | |
void | magnificationChanged (double magnification) |
Emitted when the scale of the map changes. | |
void | mapCanvasRefreshed () |
Emitted when canvas finished a refresh request. | |
void | mapRefreshCanceled () |
Emitted when the pending map refresh has been canceled. | |
void | mapToolSet (QgsMapTool *newTool, QgsMapTool *oldTool) |
Emit map tool changed with the old tool. | |
void | messageEmitted (const QString &title, const QString &message, Qgis::MessageLevel level=Qgis::MessageLevel::Info) |
emit a message (usually to be displayed in a message bar) | |
void | panDistanceBearingChanged (double distance, Qgis::DistanceUnit unit, double bearing) |
Emitted whenever the distance or bearing of an in-progress panning operation is changed. | |
void | renderComplete (QPainter *painter) |
Emitted when the canvas has rendered. | |
void | renderErrorOccurred (const QString &error, QgsMapLayer *layer) |
Emitted whenever an error is encountered during a map render operation. | |
void | renderStarting () |
Emitted when the canvas is about to be rendered. | |
void | rotationChanged (double rotation) |
Emitted when the rotation of the map changes. | |
void | scaleChanged (double scale) |
Emitted when the scale of the map changes. | |
void | scaleLockChanged (bool locked) |
Emitted when the scale locked state of the map changes. | |
void | selectionChanged (QgsMapLayer *layer) |
Emitted when selection in any layer gets changed. | |
void | tapAndHoldGestureOccurred (const QgsPointXY &mapPoint, QTapAndHoldGesture *gesture) |
Emitted whenever a tap and hold gesture occurs at the specified map point. | |
void | temporalRangeChanged () |
Emitted when the map canvas temporal range changes. | |
void | themeChanged (const QString &theme) |
Emitted when the canvas has been assigned a different map theme. | |
void | transformContextChanged () |
Emitted when the canvas transform context is changed. | |
void | xyCoordinates (const QgsPointXY &p) |
Emits current mouse position. | |
void | zoomLastStatusChanged (bool available) |
Emitted when zoom last status changed. | |
void | zoomNextStatusChanged (bool available) |
Emitted when zoom next status changed. | |
void | zRangeChanged () |
Emitted when the map canvas z (elevation) range changes. | |
Public Member Functions | |
QgsMapCanvas (QWidget *parent=nullptr) | |
Constructor. | |
~QgsMapCanvas () override | |
void | addOverlayWidget (QWidget *widget, Qt::Edge edge) |
Adds an overlay widget to the layout, which will be bound to the specified edge. | |
bool | allowInteraction (QgsMapCanvasInteractionBlocker::Interaction interaction) const |
Returns true if the specified interaction is currently permitted on the canvas. | |
QList< QgsMapCanvasAnnotationItem * > | annotationItems () const |
Returns a list of all annotation items in the canvas. | |
bool | annotationsVisible () const |
Returns true if annotations are visible within the map canvas. | |
bool | antiAliasingEnabled () const |
true if antialiasing is enabled | |
QgsMapRendererCache * | cache () |
Returns the map renderer cache, if caching is enabled. | |
void | cancelJobs () |
Cancel any rendering job, in a blocking way. | |
QColor | canvasColor () const |
Read property of QColor bgColor. | |
QgsPointXY | center () const |
Gets map center, in geographical coordinates. | |
void | clearCache () |
Make sure to remove any rendered images from cache (does nothing if cache is not enabled) | |
void | clearExtentHistory () |
Clears the list of extents and sets current extent as first item. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
QgsMapLayer * | currentLayer () |
returns current layer (set by legend widget) | |
QgsExpressionContextScope * | defaultExpressionContextScope () const |
Creates a new scope which contains default variables and functions relating to the map canvas. | |
void | enableAntiAliasing (bool flag) |
used to determine if anti-aliasing is enabled or not | |
void | enableMapTileRendering (bool flag) |
sets map tile rendering flag | |
QgsExpressionContextScope & | expressionContextScope () |
Returns a reference to the expression context scope for the map canvas. | |
const QgsExpressionContextScope & | expressionContextScope () const |
Returns a const reference to the expression context scope for the map canvas. | |
QgsRectangle | extent () const |
Returns the current zoom extent of the map canvas. | |
void | flashFeatureIds (QgsVectorLayer *layer, const QgsFeatureIds &ids, const QColor &startColor=QColor(255, 0, 0, 255), const QColor &endColor=QColor(255, 0, 0, 0), int flashes=3, int duration=500) |
Causes a set of features with matching ids from a vector layer to flash within the canvas. | |
void | flashGeometries (const QList< QgsGeometry > &geometries, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem(), const QColor &startColor=QColor(255, 0, 0, 255), const QColor &endColor=QColor(255, 0, 0, 0), int flashes=3, int duration=500) |
Causes a set of geometries to flash within the canvas. | |
void | freeze (bool frozen=true) |
Freeze/thaw the map canvas. | |
QgsRectangle | fullExtent () const |
Returns the combined extent for all layers on the map canvas. | |
const QgsMapToPixel * | getCoordinateTransform () |
Gets the current coordinate transform. | |
void | installInteractionBlocker (QgsMapCanvasInteractionBlocker *blocker) |
Installs an interaction blocker onto the canvas, which may prevent certain map canvas interactions from occurring. | |
bool | isCachingEnabled () const |
Check whether images of rendered layers are curerently being cached. | |
bool | isDrawing () |
Find out whether rendering is in progress. | |
bool | isFrozen () const |
Returns true if canvas is frozen. | |
bool | isParallelRenderingEnabled () const |
Check whether the layers are rendered in parallel or sequentially. | |
const QgsLabelingEngineSettings & | labelingEngineSettings () const |
Returns global labeling engine settings from the internal map settings. | |
const QgsLabelingResults * | labelingResults (bool allowOutdatedResults=true) const |
Gets access to the labeling results (may be nullptr ). | |
QgsMapLayer * | layer (const QString &id) |
Returns the map layer with the matching ID, or nullptr if no layers could be found. | |
QgsMapLayer * | layer (int index) |
Returns the map layer at position index in the layer stack. | |
int | layerCount () const |
Returns number of layers on the map. | |
template<typename T > | |
QVector< T > | layers () const |
Returns a list of registered map layers with a specified layer type. | |
QList< QgsMapLayer * > | layers (bool expandGroupLayers=false) const |
Returns the list of layers shown within the map canvas. | |
QMap< QString, QString > | layerStyleOverrides () const |
Returns the stored overrides of styles for layers. | |
double | magnificationFactor () const |
Returns the magnification factor. | |
QgsMapSettings & | mapSettings () |
Returns a reference to the map settings used for map rendering. | |
const QgsMapSettings & | mapSettings () const |
Gets access to properties used for map rendering. | |
QgsMapTool * | mapTool () const |
Returns the currently active tool. | |
Qgis::DistanceUnit | mapUnits () const |
Convenience function for returning the current canvas map units. | |
double | mapUnitsPerPixel () const |
Returns the mapUnitsPerPixel (map units per pixel) for the canvas. | |
int | mapUpdateInterval () const |
Find out how often map preview should be updated while it is being rendered (in milliseconds) | |
QPoint | mouseLastXY () |
returns last position of mouse cursor | |
void | panAction (QMouseEvent *event) |
Called when mouse is moving and pan is activated. | |
void | panActionEnd (QPoint releasePoint) |
Ends pan action and redraws the canvas. | |
void | panActionStart (QPoint releasePoint) |
Starts a pan action. | |
void | panToFeatureIds (QgsVectorLayer *layer, const QgsFeatureIds &ids, bool alwaysRecenter=true) |
Centers canvas extent to feature ids. | |
void | panToSelected (const QList< QgsMapLayer * > &layers) |
Pan to the combined extent of the selected features of all provided (vector) layers. | |
void | panToSelected (QgsMapLayer *layer=nullptr) |
Pan to the selected features of current ayer keeping same extent. | |
bool | previewJobsEnabled () const |
Returns true if canvas map preview jobs (low priority render jobs which render portions of the view just outside of the canvas extent, to allow preview of these out-of-canvas areas when panning or zooming out the map) are enabled for the canvas. | |
QgsPreviewEffect::PreviewMode | previewMode () const |
Returns the current preview mode for the map canvas. | |
bool | previewModeEnabled () const |
Returns whether a preview mode is enabled for the map canvas. | |
QgsProject * | project () |
Returns the project linked to this canvas. | |
QgsRectangle | projectExtent () const |
Returns the associated project's full extent, in the canvas' CRS. | |
void | removeInteractionBlocker (QgsMapCanvasInteractionBlocker *blocker) |
Removes an interaction blocker from the canvas. | |
const QgsRenderedItemResults * | renderedItemResults (bool allowOutdatedResults=true) const |
Gets access to the rendered item results (may be nullptr ), which includes the results of rendering annotation items in the canvas map. | |
bool | renderFlag () const |
Returns true if canvas render is disabled as a result of user disabling renders via the GUI. | |
double | rotation () const |
Gets the current map canvas rotation in clockwise degrees. | |
double | scale () const |
Returns the last reported scale of the canvas. | |
bool | scaleLocked () const |
Returns whether the scale is locked, so zooming can be performed using magnication. | |
QColor | selectionColor () const |
Returns color for selected features. | |
void | setAnnotationsVisible (bool visible) |
Sets whether annotations are visible in the canvas. | |
void | setCachingEnabled (bool enabled) |
Set whether to cache images of rendered layers. | |
void | setCanvasColor (const QColor &_newVal) |
Write property of QColor bgColor. | |
void | setCenter (const QgsPointXY ¢er) |
Set the center of the map canvas, in geographical coordinates. | |
void | setCurrentLayer (QgsMapLayer *layer) |
void | setCustomDropHandlers (const QVector< QPointer< QgsCustomDropHandler > > &handlers) |
Sets a list of custom drop handlers to use when drop events occur on the canvas. | |
void | setDestinationCrs (const QgsCoordinateReferenceSystem &crs) |
Sets destination coordinate reference system. | |
void | setExpressionContextScope (const QgsExpressionContextScope &scope) |
Sets an expression context scope for the map canvas. | |
void | setExtent (const QgsRectangle &r, bool magnified=false) |
Sets the extent of the map canvas to the specified rectangle. | |
void | setLabelingEngineSettings (const QgsLabelingEngineSettings &settings) |
Sets global labeling engine settings in the internal map settings. | |
void | setLayers (const QList< QgsMapLayer * > &layers) |
Sets the list of layers that should be shown in the canvas. | |
void | setLayerStyleOverrides (const QMap< QString, QString > &overrides) |
Sets the stored overrides of styles for rendering layers. | |
void | setMapController (QgsAbstract2DMapController *controller) |
Sets the input controller device to use for controlling the canvas. | |
void | setMapSettingsFlags (Qgis::MapSettingsFlags flags) |
Resets the flags for the canvas' map settings. | |
void | setMapTool (QgsMapTool *mapTool, bool clean=false) |
Sets the map tool currently being used on the canvas. | |
void | setMapUpdateInterval (int timeMilliseconds) |
Set how often map preview should be updated while it is being rendered (in milliseconds) | |
void | setParallelRenderingEnabled (bool enabled) |
Set whether the layers are rendered in parallel or sequentially. | |
void | setPreviewJobsEnabled (bool enabled) |
Sets whether canvas map preview jobs (low priority render jobs which render portions of the view just outside of the canvas extent, to allow preview of these out-of-canvas areas when panning or zooming out the map) are enabled for the canvas. | |
void | setPreviewMode (QgsPreviewEffect::PreviewMode mode) |
Sets a preview mode for the map canvas. | |
void | setPreviewModeEnabled (bool previewEnabled) |
Enables a preview mode for the map canvas. | |
void | setProject (QgsProject *project) |
Sets the project linked to this canvas. | |
bool | setReferencedExtent (const QgsReferencedRectangle &extent) |
Sets the canvas to the specified extent. | |
void | setRotation (double degrees) |
Set the rotation of the map canvas in clockwise degrees. | |
void | setSegmentationTolerance (double tolerance) |
Sets the segmentation tolerance applied when rendering curved geometries. | |
void | setSegmentationToleranceType (QgsAbstractGeometry::SegmentationToleranceType type) |
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) | |
void | setSelectionColor (const QColor &color) |
Set color of selected vector features. | |
void | setSnappingUtils (QgsSnappingUtils *utils) |
Assign an instance of snapping utils to the map canvas. | |
void | setTemporalController (QgsTemporalController *controller) |
Sets the temporal controller for this canvas. | |
void | setTemporalRange (const QgsDateTimeRange &range) |
Set datetime range for the map canvas. | |
void | setTheme (const QString &theme) |
Sets a map theme to show in the canvas. | |
void | setWheelFactor (double factor) |
Sets wheel zoom factor (should be greater than 1) | |
QgsSnappingUtils * | snappingUtils () const |
Returns snapping utility class that is associated with map canvas. | |
const QgsTemporalController * | temporalController () const |
Gets access to the temporal controller that will be used to update the canvas temporal range. | |
const QgsDateTimeRange & | temporalRange () const |
Returns map canvas datetime range. | |
QString | theme () const |
Returns the map's theme shown in the canvas, if set. | |
void | unsetMapTool (QgsMapTool *mapTool) |
Unset the current map tool or last non zoom tool. | |
void | updateScale () |
Emits signal scaleChanged to update scale in main window. | |
void | waitWhileRendering () |
Blocks until the rendering job has finished. | |
void | zoomByFactor (double scaleFactor, const QgsPointXY *center=nullptr, bool ignoreScaleLock=false) |
Zoom with the factor supplied. | |
void | zoomScale (double scale, bool ignoreScaleLock=false) |
Zooms the canvas to a specific scale. | |
void | zoomToFeatureExtent (QgsRectangle &rect) |
Zooms to feature extent. | |
void | zoomToFeatureIds (QgsVectorLayer *layer, const QgsFeatureIds &ids) |
Set canvas extent to the bounding box of a set of features. | |
void | zoomToFullExtent () |
Zoom to the full extent of all layers currently visible in the canvas. | |
void | zoomToNextExtent () |
Zoom to the next extent (view) | |
void | zoomToPreviousExtent () |
Zoom to the previous extent (view) | |
void | zoomToProjectExtent () |
Zoom to the full extent the project associated with this canvas. | |
void | zoomWithCenter (int x, int y, bool zoomIn) |
Zooms in/out with a given center. | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Protected Slots | |
void | updateCanvasItemPositions () |
called on resize or changed extent to notify canvas items to change their rectangle | |
Protected Member Functions | |
void | dragEnterEvent (QDragEnterEvent *e) override |
void | dropEvent (QDropEvent *event) override |
void | emitExtentsChanged () |
Emits the extentsChanged signal when appropriate. | |
bool | event (QEvent *e) override |
void | keyPressEvent (QKeyEvent *e) override |
void | keyReleaseEvent (QKeyEvent *e) override |
void | mouseDoubleClickEvent (QMouseEvent *e) override |
void | mouseMoveEvent (QMouseEvent *e) override |
void | mousePressEvent (QMouseEvent *e) override |
void | mouseReleaseEvent (QMouseEvent *e) override |
void | moveCanvasContents (bool reset=false) |
called when panning is in action, reset indicates end of panning | |
void | paintEvent (QPaintEvent *e) override |
void | resizeEvent (QResizeEvent *e) override |
void | showEvent (QShowEvent *event) override |
bool | viewportEvent (QEvent *event) override |
void | wheelEvent (QWheelEvent *e) override |
Protected Attributes | |
std::unique_ptr< CanvasProperties > | mCanvasProperties |
Handle pattern for implementation object. | |
Properties | |
bool | previewJobsEnabled |
QString | theme |
Friends | |
class | TestQgsMapCanvas |
Map canvas is a class for displaying all GIS data types on a canvas.
Definition at line 92 of file qgsmapcanvas.h.
QgsMapCanvas::QgsMapCanvas | ( | QWidget * | parent = nullptr | ) |
Constructor.
Definition at line 128 of file qgsmapcanvas.cpp.
|
override |
Definition at line 257 of file qgsmapcanvas.cpp.
void QgsMapCanvas::addOverlayWidget | ( | QWidget * | widget, |
Qt::Edge | edge | ||
) |
Adds an overlay widget to the layout, which will be bound to the specified edge.
The widget will always float above the map canvas.
Definition at line 288 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::allowInteraction | ( | QgsMapCanvasInteractionBlocker::Interaction | interaction | ) | const |
Returns true
if the specified interaction is currently permitted on the canvas.
Definition at line 1387 of file qgsmapcanvas.cpp.
QList< QgsMapCanvasAnnotationItem * > QgsMapCanvas::annotationItems | ( | ) | const |
Returns a list of all annotation items in the canvas.
Definition at line 3495 of file qgsmapcanvas.cpp.
|
inline |
Returns true
if annotations are visible within the map canvas.
Definition at line 786 of file qgsmapcanvas.h.
bool QgsMapCanvas::antiAliasingEnabled | ( | ) | const |
true
if antialiasing is enabled
Definition at line 342 of file qgsmapcanvas.cpp.
QgsMapRendererCache * QgsMapCanvas::cache | ( | ) |
Returns the map renderer cache, if caching is enabled.
Definition at line 669 of file qgsmapcanvas.cpp.
void QgsMapCanvas::cancelJobs | ( | ) |
Cancel any rendering job, in a blocking way.
Used for application closing.
Definition at line 293 of file qgsmapcanvas.cpp.
QColor QgsMapCanvas::canvasColor | ( | ) | const |
Read property of QColor bgColor.
Definition at line 2873 of file qgsmapcanvas.cpp.
|
signal |
Emitted when canvas background color changes.
QgsPointXY QgsMapCanvas::center | ( | ) | const |
Gets map center, in geographical coordinates.
Definition at line 1639 of file qgsmapcanvas.cpp.
void QgsMapCanvas::clearCache | ( | ) |
Make sure to remove any rendered images from cache (does nothing if cache is not enabled)
Definition at line 658 of file qgsmapcanvas.cpp.
void QgsMapCanvas::clearExtentHistory | ( | ) |
Clears the list of extents and sets current extent as first item.
Definition at line 1731 of file qgsmapcanvas.cpp.
|
signal |
Emitted before the map canvas context menu will be shown.
Can be used to extend the context menu.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context.
Implements QgsExpressionContextGenerator.
Definition at line 707 of file qgsmapcanvas.cpp.
QgsMapLayer * QgsMapCanvas::currentLayer | ( | ) |
returns current layer (set by legend widget)
Definition at line 695 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the current layer is changed.
QgsExpressionContextScope * QgsMapCanvas::defaultExpressionContextScope | ( | ) | const |
Creates a new scope which contains default variables and functions relating to the map canvas.
Definition at line 700 of file qgsmapcanvas.cpp.
|
signal |
Emitted when map CRS has changed.
|
overrideprotected |
Definition at line 3380 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 3143 of file qgsmapcanvas.cpp.
|
protected |
Emits the extentsChanged signal when appropriate.
Definition at line 3183 of file qgsmapcanvas.cpp.
void QgsMapCanvas::enableAntiAliasing | ( | bool | flag | ) |
used to determine if anti-aliasing is enabled or not
Definition at line 336 of file qgsmapcanvas.cpp.
void QgsMapCanvas::enableMapTileRendering | ( | bool | flag | ) |
sets map tile rendering flag
Definition at line 347 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 3433 of file qgsmapcanvas.cpp.
|
inline |
Returns a reference to the expression context scope for the map canvas.
This scope is injected into the expression context used for rendering the map, and can be used to apply specific variable overrides for expression evaluation for the map canvas render.
Definition at line 745 of file qgsmapcanvas.h.
|
inline |
Returns a const reference to the expression context scope for the map canvas.
Definition at line 753 of file qgsmapcanvas.h.
QgsRectangle QgsMapCanvas::extent | ( | ) | const |
Returns the current zoom extent of the map canvas.
Definition at line 1508 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the extents of the map change.
void QgsMapCanvas::flashFeatureIds | ( | QgsVectorLayer * | layer, |
const QgsFeatureIds & | ids, | ||
const QColor & | startColor = QColor( 255, 0, 0, 255 ) , |
||
const QColor & | endColor = QColor( 255, 0, 0, 0 ) , |
||
int | flashes = 3 , |
||
int | duration = 500 |
||
) |
Causes a set of features with matching ids from a vector layer to flash within the canvas.
The startColor and endColor can be specified, along with the number of flashes and duration of each flash (in milliseconds).
Definition at line 2192 of file qgsmapcanvas.cpp.
void QgsMapCanvas::flashGeometries | ( | const QList< QgsGeometry > & | geometries, |
const QgsCoordinateReferenceSystem & | crs = QgsCoordinateReferenceSystem() , |
||
const QColor & | startColor = QColor( 255, 0, 0, 255 ) , |
||
const QColor & | endColor = QColor( 255, 0, 0, 0 ) , |
||
int | flashes = 3 , |
||
int | duration = 500 |
||
) |
Causes a set of geometries to flash within the canvas.
If crs is a valid coordinate reference system, the geometries will be automatically transformed from this CRS to the canvas CRS.
The startColor and endColor can be specified, along with the number of flashes and duration of each flash (in milliseconds).
Definition at line 2215 of file qgsmapcanvas.cpp.
void QgsMapCanvas::freeze | ( | bool | frozen = true | ) |
Freeze/thaw the map canvas.
This is used to prevent the canvas from responding to events while layers are being added/removed etc.
frozen | Boolean specifying if the canvas should be frozen (true ) or thawed (false ). Default is true . |
Definition at line 2928 of file qgsmapcanvas.cpp.
QgsRectangle QgsMapCanvas::fullExtent | ( | ) | const |
Returns the combined extent for all layers on the map canvas.
This method returns the combined extent for all layers which are currently visible in the map canvas. The returned extent will be in the same CRS as the map canvas.
Definition at line 1513 of file qgsmapcanvas.cpp.
const QgsMapToPixel * QgsMapCanvas::getCoordinateTransform | ( | ) |
Gets the current coordinate transform.
Definition at line 397 of file qgsmapcanvas.cpp.
void QgsMapCanvas::installInteractionBlocker | ( | QgsMapCanvasInteractionBlocker * | blocker | ) |
Installs an interaction blocker onto the canvas, which may prevent certain map canvas interactions from occurring.
The caller retains ownership of blocker, and must correctly call removeInteractionBlocker() before deleting the object.
Definition at line 1377 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isCachingEnabled | ( | ) | const |
Check whether images of rendered layers are curerently being cached.
Definition at line 653 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isDrawing | ( | ) |
Find out whether rendering is in progress.
Definition at line 390 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isFrozen | ( | ) | const |
Returns true
if canvas is frozen.
Definition at line 2933 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isParallelRenderingEnabled | ( | ) | const |
Check whether the layers are rendered in parallel or sequentially.
Definition at line 679 of file qgsmapcanvas.cpp.
|
signal |
Emit key press event.
|
overrideprotected |
Definition at line 2294 of file qgsmapcanvas.cpp.
|
signal |
Emit key release event.
|
overrideprotected |
Definition at line 2394 of file qgsmapcanvas.cpp.
const QgsLabelingEngineSettings & QgsMapCanvas::labelingEngineSettings | ( | ) | const |
Returns global labeling engine settings from the internal map settings.
Definition at line 3526 of file qgsmapcanvas.cpp.
const QgsLabelingResults * QgsMapCanvas::labelingResults | ( | bool | allowOutdatedResults = true | ) | const |
Gets access to the labeling results (may be nullptr
).
Since QGIS 3.20, if the allowOutdatedResults flag is false
then outdated labeling results (e.g. as a result of an ongoing canvas render) will not be returned, and instead nullptr
will be returned.
Definition at line 614 of file qgsmapcanvas.cpp.
QgsMapLayer * QgsMapCanvas::layer | ( | const QString & | id | ) |
Returns the map layer with the matching ID, or nullptr
if no layers could be found.
This method searches both layers associated with the map canvas (see layers()) and layers from the QgsProject associated with the canvas (which is current the QgsProject::instance()). It can be used to resolve layer IDs to layers which may be visible in the canvas, but not associated with a QgsProject.
Definition at line 361 of file qgsmapcanvas.cpp.
QgsMapLayer * QgsMapCanvas::layer | ( | int | index | ) |
Returns the map layer at position index in the layer stack.
Definition at line 352 of file qgsmapcanvas.cpp.
int QgsMapCanvas::layerCount | ( | ) | const |
Returns number of layers on the map.
Definition at line 2912 of file qgsmapcanvas.cpp.
|
inline |
Returns a list of registered map layers with a specified layer type.
Definition at line 518 of file qgsmapcanvas.h.
QList< QgsMapLayer * > QgsMapCanvas::layers | ( | bool | expandGroupLayers = false | ) | const |
Returns the list of layers shown within the map canvas.
Since QGIS 3.24, if the expandGroupLayers option is true
then group layers will be converted to all their child layers.
Definition at line 2917 of file qgsmapcanvas.cpp.
|
signal |
Emitted when a new set of layers has been received.
|
slot |
This slot is connected to the visibility change of one or more layers.
Definition at line 2922 of file qgsmapcanvas.cpp.
QMap< QString, QString > QgsMapCanvas::layerStyleOverrides | ( | ) | const |
Returns the stored overrides of styles for layers.
Definition at line 2948 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the configuration of overridden layer styles changes.
|
signal |
Emitted when the scale of the map changes.
double QgsMapCanvas::magnificationFactor | ( | ) | const |
Returns the magnification factor.
Definition at line 331 of file qgsmapcanvas.cpp.
|
signal |
Emitted when canvas finished a refresh request.
|
signal |
Emitted when the pending map refresh has been canceled.
QgsMapSettings & QgsMapCanvas::mapSettings | ( | ) |
Returns a reference to the map settings used for map rendering.
Definition at line 501 of file qgsmapcanvas.cpp.
const QgsMapSettings & QgsMapCanvas::mapSettings | ( | ) | const |
Gets access to properties used for map rendering.
Definition at line 496 of file qgsmapcanvas.cpp.
QgsMapTool * QgsMapCanvas::mapTool | ( | ) | const |
Returns the currently active tool.
Definition at line 3079 of file qgsmapcanvas.cpp.
|
signal |
Emit map tool changed with the old tool.
Qgis::DistanceUnit QgsMapCanvas::mapUnits | ( | ) | const |
Convenience function for returning the current canvas map units.
The map units are dictated by the canvas' destinationCrs() map units.
Definition at line 2943 of file qgsmapcanvas.cpp.
double QgsMapCanvas::mapUnitsPerPixel | ( | ) | const |
Returns the mapUnitsPerPixel (map units per pixel) for the canvas.
Definition at line 2938 of file qgsmapcanvas.cpp.
int QgsMapCanvas::mapUpdateInterval | ( | ) | const |
Find out how often map preview should be updated while it is being rendered (in milliseconds)
Definition at line 689 of file qgsmapcanvas.cpp.
|
signal |
emit a message (usually to be displayed in a message bar)
|
overrideprotected |
Definition at line 2426 of file qgsmapcanvas.cpp.
QPoint QgsMapCanvas::mouseLastXY | ( | ) |
returns last position of mouse cursor
Definition at line 3189 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 2759 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 2509 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 2562 of file qgsmapcanvas.cpp.
|
protected |
called when panning is in action, reset indicates end of panning
Definition at line 3134 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 2639 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panAction | ( | QMouseEvent * | event | ) |
Called when mouse is moving and pan is activated.
Definition at line 3117 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panActionEnd | ( | QPoint | releasePoint | ) |
Ends pan action and redraws the canvas.
Definition at line 3089 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panActionStart | ( | QPoint | releasePoint | ) |
Starts a pan action.
Definition at line 3108 of file qgsmapcanvas.cpp.
|
signal |
Emitted whenever the distance or bearing of an in-progress panning operation is changed.
This signal will be emitted during a pan operation as the user moves the map, giving the total distance and bearing between the map position at the start of the pan and the current pan position.
void QgsMapCanvas::panToFeatureIds | ( | QgsVectorLayer * | layer, |
const QgsFeatureIds & | ids, | ||
bool | alwaysRecenter = true |
||
) |
Centers canvas extent to feature ids.
layer | the vector layer |
ids | the feature ids |
alwaysRecenter | if false , the canvas is recentered only if the bounding box is not contained within the current extent |
Definition at line 2001 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panToSelected | ( | const QList< QgsMapLayer * > & | layers | ) |
Pan to the combined extent of the selected features of all provided (vector) layers.
layers | A list of layers |
Definition at line 2119 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panToSelected | ( | QgsMapLayer * | layer = nullptr | ) |
Pan to the selected features of current ayer keeping same extent.
Definition at line 2059 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::previewJobsEnabled | ( | ) | const |
Returns true
if canvas map preview jobs (low priority render jobs which render portions of the view just outside of the canvas extent, to allow preview of these out-of-canvas areas when panning or zooming out the map) are enabled for the canvas.
Definition at line 1039 of file qgsmapcanvas.cpp.
QgsPreviewEffect::PreviewMode QgsMapCanvas::previewMode | ( | ) | const |
Returns the current preview mode for the map canvas.
This setting only has an effect if previewModeEnabled is true
.
Definition at line 3224 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::previewModeEnabled | ( | ) | const |
Returns whether a preview mode is enabled for the map canvas.
true
if a preview mode is currently enabled Definition at line 3204 of file qgsmapcanvas.cpp.
QgsProject * QgsMapCanvas::project | ( | ) |
Returns the project linked to this canvas.
The returned value may be nullptr
.
Definition at line 3084 of file qgsmapcanvas.cpp.
QgsRectangle QgsMapCanvas::projectExtent | ( | ) | const |
Returns the associated project's full extent, in the canvas' CRS.
This method returns the full extent for the project associated with this canvas. Unlike fullExtent(), this method does NOT consider which layers are actually visible in the map canvas.
Definition at line 1518 of file qgsmapcanvas.cpp.
|
slot |
called to read map canvas settings from project
Definition at line 3250 of file qgsmapcanvas.cpp.
|
slot |
Clears all cached images and redraws all layers.
Definition at line 3468 of file qgsmapcanvas.cpp.
|
slot |
Repaints the canvas map.
Definition at line 724 of file qgsmapcanvas.cpp.
|
slot |
Reload all layers (including refreshing layer properties from their data sources), clears the cache and refreshes the canvas.
Definition at line 3456 of file qgsmapcanvas.cpp.
void QgsMapCanvas::removeInteractionBlocker | ( | QgsMapCanvasInteractionBlocker * | blocker | ) |
Removes an interaction blocker from the canvas.
Definition at line 1382 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the canvas has rendered.
Passes a pointer to the painter on which the map was drawn. This is useful for plugins that wish to draw on the map after it has been rendered. Passing the painter allows plugins to work when the map is being rendered onto a pixmap other than the mapCanvas own pixmap member.
const QgsRenderedItemResults * QgsMapCanvas::renderedItemResults | ( | bool | allowOutdatedResults = true | ) | const |
Gets access to the rendered item results (may be nullptr
), which includes the results of rendering annotation items in the canvas map.
If the allowOutdatedResults flag is false
then outdated rendered item results (e.g. as a result of an ongoing canvas render) will not be returned, and instead nullptr
will be returned.
Definition at line 622 of file qgsmapcanvas.cpp.
|
signal |
Emitted whenever an error is encountered during a map render operation.
The layer argument indicates the associated map layer, if available.
|
inline |
Returns true
if canvas render is disabled as a result of user disabling renders via the GUI.
Definition at line 549 of file qgsmapcanvas.h.
|
signal |
Emitted when the canvas is about to be rendered.
|
overrideprotected |
Definition at line 2610 of file qgsmapcanvas.cpp.
double QgsMapCanvas::rotation | ( | ) | const |
Gets the current map canvas rotation in clockwise degrees.
Definition at line 1650 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the rotation of the map changes.
|
slot |
Save the contents of the map canvas to disk as an image.
Definition at line 1442 of file qgsmapcanvas.cpp.
double QgsMapCanvas::scale | ( | ) | const |
Returns the last reported scale of the canvas.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 385 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the scale of the map changes.
|
signal |
Emitted when the scale locked state of the map changes.
locked | true if the scale is locked |
|
inline |
Returns whether the scale is locked, so zooming can be performed using magnication.
Definition at line 643 of file qgsmapcanvas.h.
|
signal |
Emitted when selection in any layer gets changed.
|
slot |
Receives signal about selection change, and pass it on with layer info.
Definition at line 3369 of file qgsmapcanvas.cpp.
QColor QgsMapCanvas::selectionColor | ( | ) | const |
Returns color for selected features.
Definition at line 2907 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setAnnotationsVisible | ( | bool | visible | ) |
Sets whether annotations are visible in the canvas.
Definition at line 3511 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCachingEnabled | ( | bool | enabled | ) |
Set whether to cache images of rendered layers.
Definition at line 630 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCanvasColor | ( | const QColor & | _newVal | ) |
Write property of QColor bgColor.
Definition at line 2848 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCenter | ( | const QgsPointXY & | center | ) |
Set the center of the map canvas, in geographical coordinates.
Definition at line 1624 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCurrentLayer | ( | QgsMapLayer * | layer | ) |
Definition at line 376 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCustomDropHandlers | ( | const QVector< QPointer< QgsCustomDropHandler > > & | handlers | ) |
Sets a list of custom drop handlers to use when drop events occur on the canvas.
Definition at line 1049 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setDestinationCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
Sets destination coordinate reference system.
Definition at line 506 of file qgsmapcanvas.cpp.
|
inline |
Sets an expression context scope for the map canvas.
This scope is injected into the expression context used for rendering the map, and can be used to apply specific variable overrides for expression evaluation for the map canvas render. This method will overwrite the existing expression context scope for the canvas.
scope | new expression context scope |
Definition at line 736 of file qgsmapcanvas.h.
void QgsMapCanvas::setExtent | ( | const QgsRectangle & | r, |
bool | magnified = false |
||
) |
Sets the extent of the map canvas to the specified rectangle.
The magnified argument dictates whether existing canvas constraints such as a scale lock should be respected or not during the operation. If magnified is true
then an existing scale lock constraint will be applied. This means that the final visible canvas extent may not match the specified extent.
If magnified is false
then scale lock settings will be ignored, and the specified rectangle will ALWAYS be visible in the canvas.
Definition at line 1536 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setLabelingEngineSettings | ( | const QgsLabelingEngineSettings & | settings | ) |
Sets global labeling engine settings in the internal map settings.
Definition at line 3521 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setLayers | ( | const QList< QgsMapLayer * > & | layers | ) |
Sets the list of layers that should be shown in the canvas.
If the map canvas has been associated with a map theme via a call to setTheme(), then any calls to setLayers() are ignored. It is necessary to first clear the theme association by calling setTheme() with an empty string before setLayers() calls can be made.
Definition at line 402 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setLayerStyleOverrides | ( | const QMap< QString, QString > & | overrides | ) |
Sets the stored overrides of styles for rendering layers.
If the map canvas has been associated with a map theme via a call to setTheme(), then any calls to setLayerStyleOverrides() are ignored. It is necessary to first clear the theme association by calling setTheme() with an empty string before setLayerStyleOverrides() calls can be made.
Definition at line 2953 of file qgsmapcanvas.cpp.
|
slot |
Sets the factor of magnification to apply to the map canvas.
Indeed, we increase/decrease the DPI of the map settings according to this factor in order to render marker point, labels, ... bigger.
factor | The factor of magnification |
center | Optional point to re-center the map |
Definition at line 315 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setMapController | ( | QgsAbstract2DMapController * | controller | ) |
Sets the input controller device to use for controlling the canvas.
Ownership of controller is transferred to the canvas.
Definition at line 1397 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setMapSettingsFlags | ( | Qgis::MapSettingsFlags | flags | ) |
Resets the flags for the canvas' map settings.
Definition at line 607 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setMapTool | ( | QgsMapTool * | mapTool, |
bool | clean = false |
||
) |
Sets the map tool currently being used on the canvas.
Definition at line 2791 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setMapUpdateInterval | ( | int | timeMilliseconds | ) |
Set how often map preview should be updated while it is being rendered (in milliseconds)
Definition at line 684 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setParallelRenderingEnabled | ( | bool | enabled | ) |
Set whether the layers are rendered in parallel or sequentially.
Definition at line 674 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setPreviewJobsEnabled | ( | bool | enabled | ) |
Sets whether canvas map preview jobs (low priority render jobs which render portions of the view just outside of the canvas extent, to allow preview of these out-of-canvas areas when panning or zooming out the map) are enabled for the canvas.
Definition at line 1044 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setPreviewMode | ( | QgsPreviewEffect::PreviewMode | mode | ) |
Sets a preview mode for the map canvas.
This setting only has an effect if previewModeEnabled is true
.
mode | preview mode for the canvas |
Definition at line 3214 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setPreviewModeEnabled | ( | bool | previewEnabled | ) |
Enables a preview mode for the map canvas.
previewEnabled | set to true to enable a preview mode |
Definition at line 3194 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setProject | ( | QgsProject * | project | ) |
Sets the project linked to this canvas.
Definition at line 2837 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::setReferencedExtent | ( | const QgsReferencedRectangle & | extent | ) |
Sets the canvas to the specified extent.
true
if the zoom was successful.QgsCsException | if a transformation error occurred. |
Definition at line 1605 of file qgsmapcanvas.cpp.
|
slot |
Sets whether a user has disabled canvas renders via the GUI.
flag | set to false to indicate that user has disabled renders |
Definition at line 2984 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setRotation | ( | double | degrees | ) |
Set the rotation of the map canvas in clockwise degrees.
Definition at line 1655 of file qgsmapcanvas.cpp.
|
slot |
Lock the scale, so zooming can be performed using magnication.
Definition at line 2750 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setSegmentationTolerance | ( | double | tolerance | ) |
Sets the segmentation tolerance applied when rendering curved geometries.
tolerance | the segmentation tolerance |
Definition at line 3485 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setSegmentationToleranceType | ( | QgsAbstractGeometry::SegmentationToleranceType | type | ) |
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)
type | the segmentation tolerance typename |
Definition at line 3490 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setSelectionColor | ( | const QColor & | color | ) |
Set color of selected vector features.
Definition at line 2878 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setSnappingUtils | ( | QgsSnappingUtils * | utils | ) |
Assign an instance of snapping utils to the map canvas.
The instance is not owned by the canvas, so it is possible to use one instance in multiple canvases.
For main canvas in QGIS, do not associate a different instance from the existing one (it is updated from the project's snapping configuration).
Definition at line 3245 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setTemporalController | ( | QgsTemporalController * | controller | ) |
Sets the temporal controller for this canvas.
The controller will be used to update the canvas' temporal range.
Definition at line 559 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setTemporalRange | ( | const QgsDateTimeRange & | range | ) |
Set datetime range for the map canvas.
The temporalRangeChanged() signal will be emitted if the temporal range has been changed.
Definition at line 1355 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setTheme | ( | const QString & | theme | ) |
Sets a map theme to show in the canvas.
The theme name must match a theme present in the associated project's QgsMapThemeCollection.
When the canvas is associated to a map theme, it will automatically follow the layer selection and layer styles from that theme. Calls to setLayers() or setLayerStyleOverrides() will have no effect, and canvases associated with a QgsLayerTreeMapCanvasBridge will no longer synchronize their state with the layer tree. In these cases it is necessary to call setTheme() with an empty string to clear the theme association and allow map updates with setLayers(), setLayerStyleOverrides(), or via QgsLayerTreeMapCanvasBridge.
If an empty string is passed then the current theme association will be cleared.
Definition at line 2963 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setWheelFactor | ( | double | factor | ) |
Sets wheel zoom factor (should be greater than 1)
Definition at line 2710 of file qgsmapcanvas.cpp.
|
inlineslot |
Set a list of resolutions (map units per pixel) to which to "snap to" when zooming the map.
resolutions | A list of resolutions |
Definition at line 980 of file qgsmapcanvas.h.
|
slot |
Sets the range of z-values which will be visible in the map.
Definition at line 1937 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 3177 of file qgsmapcanvas.cpp.
QgsSnappingUtils * QgsMapCanvas::snappingUtils | ( | ) | const |
Returns snapping utility class that is associated with map canvas.
If no snapping utils instance has been associated previously, an internal will be created for convenience (so map tools do not need to test for existence of the instance).
Main canvas in QGIS returns an instance which is always up-to-date with the project's snapping configuration.
Definition at line 3234 of file qgsmapcanvas.cpp.
|
slot |
stop rendering (if there is any right now)
Definition at line 1426 of file qgsmapcanvas.cpp.
|
signal |
Emitted whenever a tap and hold gesture occurs at the specified map point.
const QgsTemporalController * QgsMapCanvas::temporalController | ( | ) | const |
Gets access to the temporal controller that will be used to update the canvas temporal range.
Definition at line 602 of file qgsmapcanvas.cpp.
const QgsDateTimeRange & QgsMapCanvas::temporalRange | ( | ) | const |
Returns map canvas datetime range.
Definition at line 1372 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the map canvas temporal range changes.
|
inline |
Returns the map's theme shown in the canvas, if set.
Definition at line 598 of file qgsmapcanvas.h.
|
signal |
Emitted when the canvas has been assigned a different map theme.
|
signal |
Emitted when the canvas transform context is changed.
void QgsMapCanvas::unsetMapTool | ( | QgsMapTool * | mapTool | ) |
Unset the current map tool or last non zoom tool.
This is called from destructor of map tools to make sure that this map tool won't be used any more. You don't have to call it manually, QgsMapTool takes care of it.
Definition at line 2824 of file qgsmapcanvas.cpp.
|
protectedslot |
called on resize or changed extent to notify canvas items to change their rectangle
Definition at line 2646 of file qgsmapcanvas.cpp.
void QgsMapCanvas::updateScale | ( | ) |
Emits signal scaleChanged to update scale in main window.
Definition at line 1667 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 3418 of file qgsmapcanvas.cpp.
void QgsMapCanvas::waitWhileRendering | ( | ) |
Blocks until the rendering job has finished.
In almost all cases you do NOT want to call this, as it will hang the UI until the rendering job is complete. It's included in API solely for unit testing and standalone Python scripts.
Definition at line 3477 of file qgsmapcanvas.cpp.
|
overrideprotected |
Definition at line 2664 of file qgsmapcanvas.cpp.
|
slot |
called to write map canvas settings to project
Definition at line 3318 of file qgsmapcanvas.cpp.
|
signal |
Emits current mouse position.
void QgsMapCanvas::zoomByFactor | ( | double | scaleFactor, |
const QgsPointXY * | center = nullptr , |
||
bool | ignoreScaleLock = false |
||
) |
Zoom with the factor supplied.
Factor > 1 zooms out, interval (0,1) zooms in If point is given, re-center on it.
If ignoreScaleLock is set to true
, then any existing constraint on the map scale of the canvas will be ignored during the zoom operation.
Definition at line 3353 of file qgsmapcanvas.cpp.
|
slot |
Zoom in with fixed factor.
Definition at line 2715 of file qgsmapcanvas.cpp.
|
slot |
Returns the zoom in factor.
Definition at line 3685 of file qgsmapcanvas.cpp.
|
signal |
Emitted when zoom last status changed.
|
signal |
Emitted when zoom next status changed.
|
slot |
Zoom out with fixed factor.
Definition at line 2721 of file qgsmapcanvas.cpp.
|
slot |
Returns the zoom in factor.
Definition at line 3698 of file qgsmapcanvas.cpp.
|
inlineslot |
Definition at line 997 of file qgsmapcanvas.h.
void QgsMapCanvas::zoomScale | ( | double | scale, |
bool | ignoreScaleLock = false |
||
) |
Zooms the canvas to a specific scale.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
If ignoreScaleLock is set to true
, then any existing constraint on the map scale of the canvas will be ignored during the zoom operation.
Definition at line 2727 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToFeatureExtent | ( | QgsRectangle & | rect | ) |
Zooms to feature extent.
Adds a small margin around the extent and does a pan if rect is empty (point extent)
Definition at line 1953 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToFeatureIds | ( | QgsVectorLayer * | layer, |
const QgsFeatureIds & | ids | ||
) |
Set canvas extent to the bounding box of a set of features.
layer | the vector layer |
ids | the feature ids |
Definition at line 1977 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToFullExtent | ( | ) |
Zoom to the full extent of all layers currently visible in the canvas.
Definition at line 1673 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToNextExtent | ( | ) |
Zoom to the next extent (view)
Definition at line 1716 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToPreviousExtent | ( | ) |
Zoom to the previous extent (view)
Definition at line 1700 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToProjectExtent | ( | ) |
Zoom to the full extent the project associated with this canvas.
This method zooms to the full extent for the project associated with this canvas. Unlike zoomToFullExtent(), this method does NOT consider which layers are actually visible in the map canvas.
Definition at line 1686 of file qgsmapcanvas.cpp.
|
slot |
Zoom to the combined extent of the selected features of all provided (vector) layers.
layers | A list of layers |
Definition at line 1856 of file qgsmapcanvas.cpp.
|
slot |
Zoom to the extent of the selected features of provided map layer.
layer | optionally specify different than current layer |
Definition at line 1775 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomWithCenter | ( | int | x, |
int | y, | ||
bool | zoomIn | ||
) |
Zooms in/out with a given center.
Definition at line 2732 of file qgsmapcanvas.cpp.
|
slot |
Returns the range of z-values which will be visible in the map.
Definition at line 1932 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the map canvas z (elevation) range changes.
|
friend |
Definition at line 1548 of file qgsmapcanvas.h.
|
protected |
Handle pattern for implementation object.
Definition at line 1248 of file qgsmapcanvas.h.
|
readwrite |
Definition at line 106 of file qgsmapcanvas.h.
|
readwrite |
Definition at line 105 of file qgsmapcanvas.h.