QGIS API Documentation
3.2.0-Bonn (bc43194)
|
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. More... | |
void | readProject (const QDomDocument &) |
called to read map canvas settings from project More... | |
void | refresh () |
Repaints the canvas map. More... | |
void | refreshAllLayers () |
Reload all layers, clear the cache and refresh the canvas. More... | |
void | saveAsImage (const QString &fileName, QPixmap *QPixmap=nullptr, const QString &="PNG") |
Save the convtents of the map canvas to disk as an image. More... | |
void | selectionChangedSlot () |
Receives signal about selection change, and pass it on with layer info. More... | |
void | setMagnificationFactor (double factor) |
Sets the factor of magnification to apply to the map canvas. More... | |
void | setRenderFlag (bool flag) |
Sets whether a user has disabled canvas renders via the GUI. More... | |
void | setScaleLocked (bool isLocked) |
Lock the scale, so zooming can be performed using magnication. More... | |
void | stopRendering () |
stop rendering (if there is any right now) More... | |
void | writeProject (QDomDocument &) |
called to write map canvas settings to project More... | |
void | zoomIn () |
Zoom in with fixed factor. More... | |
void | zoomOut () |
Zoom out with fixed factor. More... | |
void | zoomToSelected (QgsVectorLayer *layer=nullptr) |
Zoom to the extent of the selected features of provided (vector) layer. More... | |
Signals | |
void | canvasColorChanged () |
Emitted when canvas background color changes. More... | |
void | currentLayerChanged (QgsMapLayer *layer) |
Emitted when the current layer is changed. More... | |
void | destinationCrsChanged () |
Emitted when map CRS has changed. More... | |
void | extentsChanged () |
Emitted when the extents of the map change. More... | |
void | keyPressed (QKeyEvent *e) |
Emit key press event. More... | |
void | keyReleased (QKeyEvent *e) |
Emit key release event. More... | |
void | layersChanged () |
Emitted when a new set of layers has been received. More... | |
void | layerStyleOverridesChanged () |
Emitted when the configuration of overridden layer styles changes. More... | |
void | magnificationChanged (double) |
Emitted when the scale of the map changes. More... | |
void | mapCanvasRefreshed () |
Emitted when canvas finished a refresh request. More... | |
void | mapToolSet (QgsMapTool *newTool, QgsMapTool *oldTool) |
Emit map tool changed with the old tool. More... | |
void | messageEmitted (const QString &title, const QString &message, Qgis::MessageLevel=Qgis::Info) |
emit a message (usually to be displayed in a message bar) More... | |
void | renderComplete (QPainter *) |
Emitted when the canvas has rendered. More... | |
void | renderStarting () |
Emitted when the canvas is about to be rendered. More... | |
void | rotationChanged (double) |
Emitted when the rotation of the map changes. More... | |
void | scaleChanged (double) |
Emitted when the scale of the map changes. More... | |
void | selectionChanged (QgsVectorLayer *layer) |
Emitted when selection in any layer gets changed. More... | |
void | themeChanged (const QString &theme) |
Emitted when the canvas has been assigned a different map theme. More... | |
void | transformContextChanged () |
Emitted when the canvas transform context is changed. More... | |
void | xyCoordinates (const QgsPointXY &p) |
Emits current mouse position. More... | |
void | zoomLastStatusChanged (bool) |
Emitted when zoom last status changed. More... | |
void | zoomNextStatusChanged (bool) |
Emitted when zoom next status changed. More... | |
Public Member Functions | |
QgsMapCanvas (QWidget *parent=nullptr) | |
Constructor. More... | |
~QgsMapCanvas () override | |
QList< QgsMapCanvasAnnotationItem * > | annotationItems () const |
Returns a list of all annotation items in the canvas. More... | |
bool | annotationsVisible () const |
Returns true if annotations are visible within the map canvas. More... | |
bool | antiAliasingEnabled () const |
true if antialising is enabled More... | |
QColor | canvasColor () const |
Read property of QColor bgColor. More... | |
QgsPointXY | center () const |
Gets map center, in geographical coordinates. More... | |
void | clearCache () |
Make sure to remove any rendered images from cache (does nothing if cache is not enabled) More... | |
void | clearExtentHistory () |
QgsMapLayer * | currentLayer () |
returns current layer (set by legend widget) More... | |
void | enableAntiAliasing (bool flag) |
used to determine if anti-aliasing is enabled or not More... | |
void | enableMapTileRendering (bool flag) |
sets map tile rendering flag More... | |
QgsExpressionContextScope & | expressionContextScope () |
Returns a reference to the expression context scope for the map canvas. More... | |
const QgsExpressionContextScope & | expressionContextScope () const |
Returns a const reference to the expression context scope for the map canvas. More... | |
QgsRectangle | extent () const |
Returns the current zoom extent of the map canvas. More... | |
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. More... | |
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. More... | |
void | freeze (bool frozen=true) |
Freeze/thaw the map canvas. More... | |
QgsRectangle | fullExtent () const |
Returns the combined extent for all layers on the map canvas. More... | |
const QgsMapToPixel * | getCoordinateTransform () |
Gets the current coordinate transform. More... | |
bool | isCachingEnabled () const |
Check whether images of rendered layers are curerently being cached. More... | |
bool | isDrawing () |
Find out whether rendering is in progress. More... | |
bool | isFrozen () const |
Returns true if canvas is frozen. More... | |
bool | isParallelRenderingEnabled () const |
Check whether the layers are rendered in parallel or sequentially. More... | |
const QgsLabelingEngineSettings & | labelingEngineSettings () const |
Returns global labeling engine settings from the internal map settings. More... | |
const QgsLabelingResults * | labelingResults () const |
Gets access to the labeling results (may be null) More... | |
QgsMapLayer * | layer (int index) |
Returns the map layer at position index in the layer stack. More... | |
int | layerCount () const |
Returns number of layers on the map. More... | |
QList< QgsMapLayer * > | layers () const |
Returns the list of layers shown within the map canvas. More... | |
QMap< QString, QString > | layerStyleOverrides () const |
Returns the stored overrides of styles for layers. More... | |
double | magnificationFactor () const |
Returns the magnification factor. More... | |
const QgsMapSettings & | mapSettings () const |
Gets access to properties used for map rendering. More... | |
QgsMapTool * | mapTool () |
Returns the currently active tool. More... | |
QgsUnitTypes::DistanceUnit | mapUnits () const |
Convenience function for returning the current canvas map units. More... | |
double | mapUnitsPerPixel () const |
Returns the mapUnitsPerPixel (map units per pixel) for the canvas. More... | |
int | mapUpdateInterval () const |
Find out how often map preview should be updated while it is being rendered (in milliseconds) More... | |
QPoint | mouseLastXY () |
returns last position of mouse cursor More... | |
void | panAction (QMouseEvent *event) |
Called when mouse is moving and pan is activated. More... | |
void | panActionEnd (QPoint releasePoint) |
Ends pan action and redraws the canvas. More... | |
void | panToFeatureIds (QgsVectorLayer *layer, const QgsFeatureIds &ids) |
Centers canvas extent to feature ids. More... | |
void | panToSelected (QgsVectorLayer *layer=nullptr) |
Pan to the selected features of current (vector) layer keeping same extent. More... | |
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. More... | |
QgsPreviewEffect::PreviewMode | previewMode () const |
Returns the current preview mode for the map canvas. More... | |
bool | previewModeEnabled () const |
Returns whether a preview mode is enabled for the map canvas. More... | |
bool | renderFlag () const |
Returns true if canvas render is disabled as a result of user disabling renders via the GUI. More... | |
double | rotation () const |
Gets the current map canvas rotation in clockwise degrees. More... | |
double | scale () const |
Returns the last reported scale of the canvas. More... | |
bool | scaleLocked () const |
Returns whether the scale is locked, so zooming can be performed using magnication. More... | |
QColor | selectionColor () const |
Returns color for selected features. More... | |
void | setAnnotationsVisible (bool visible) |
Sets whether annotations are visible in the canvas. More... | |
void | setCachingEnabled (bool enabled) |
Set whether to cache images of rendered layers. More... | |
void | setCanvasColor (const QColor &_newVal) |
Write property of QColor bgColor. More... | |
void | setCenter (const QgsPointXY ¢er) |
Set the center of the map canvas, in geographical coordinates. More... | |
void | setCurrentLayer (QgsMapLayer *layer) |
void | setDestinationCrs (const QgsCoordinateReferenceSystem &crs) |
sets destination coordinate reference system More... | |
void | setExpressionContextScope (const QgsExpressionContextScope &scope) |
Sets an expression context scope for the map canvas. More... | |
void | setExtent (const QgsRectangle &r, bool magnified=false) |
Sets the extent of the map canvas. More... | |
void | setLabelingEngineSettings (const QgsLabelingEngineSettings &settings) |
Sets global labeling engine settings in the internal map settings. More... | |
void | setLayers (const QList< QgsMapLayer *> &layers) |
Sets the list of layers that should be shown in the canvas. More... | |
void | setLayerStyleOverrides (const QMap< QString, QString > &overrides) |
Sets the stored overrides of styles for rendering layers. More... | |
void | setMapSettingsFlags (QgsMapSettings::Flags flags) |
Resets the flags for the canvas' map settings. More... | |
void | setMapTool (QgsMapTool *mapTool, bool clean=false) |
Sets the map tool currently being used on the canvas. More... | |
void | setMapUpdateInterval (int timeMilliseconds) |
Set how often map preview should be updated while it is being rendered (in milliseconds) More... | |
void | setParallelRenderingEnabled (bool enabled) |
Set whether the layers are rendered in parallel or sequentially. More... | |
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. More... | |
void | setPreviewMode (QgsPreviewEffect::PreviewMode mode) |
Sets a preview mode for the map canvas. More... | |
void | setPreviewModeEnabled (bool previewEnabled) |
Enables a preview mode for the map canvas. More... | |
void | setRotation (double degrees) |
Set the rotation of the map canvas in clockwise degrees. More... | |
void | setSegmentationTolerance (double tolerance) |
Sets the segmentation tolerance applied when rendering curved geometries. More... | |
void | setSegmentationToleranceType (QgsAbstractGeometry::SegmentationToleranceType type) |
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) More... | |
void | setSelectionColor (const QColor &color) |
Set color of selected vector features. More... | |
void | setSnappingUtils (QgsSnappingUtils *utils) |
Assign an instance of snapping utils to the map canvas. More... | |
void | setTheme (const QString &theme) |
Sets a map theme to show in the canvas. More... | |
void | setWheelFactor (double factor) |
Sets wheel zoom factor (should be greater than 1) More... | |
QgsSnappingUtils * | snappingUtils () const |
Returns snapping utility class that is associated with map canvas. More... | |
QString | theme () const |
Returns the map's theme shown in the canvas, if set. More... | |
void | unsetMapTool (QgsMapTool *mapTool) |
Unset the current map tool or last non zoom tool. More... | |
void | updateScale () |
Emits signal scaleChanged to update scale in main window. More... | |
void | waitWhileRendering () |
Blocks until the rendering job has finished. More... | |
void | zoomByFactor (double scaleFactor, const QgsPointXY *center=nullptr) |
Zoom with the factor supplied. More... | |
void | zoomScale (double scale) |
Zooms the canvas to a specific scale. More... | |
void | zoomToFeatureExtent (QgsRectangle &rect) |
Zooms to feature extent. More... | |
void | zoomToFeatureIds (QgsVectorLayer *layer, const QgsFeatureIds &ids) |
Set canvas extent to the bounding box of a set of features. More... | |
void | zoomToFullExtent () |
Zoom to the full extent of all layers. More... | |
void | zoomToNextExtent () |
Zoom to the next extent (view) More... | |
void | zoomToPreviousExtent () |
Zoom to the previous extent (view) More... | |
void | zoomWithCenter (int x, int y, bool zoomIn) |
Zooms in/out with a given center. More... | |
Protected Slots | |
void | updateCanvasItemPositions () |
called on resize or changed extent to notify canvas items to change their rectangle More... | |
Protected Member Functions | |
void | dragEnterEvent (QDragEnterEvent *e) override |
Overridden drag enter event. More... | |
bool | event (QEvent *e) override |
Overridden standard event to be gestures aware. More... | |
void | keyPressEvent (QKeyEvent *e) override |
Overridden key press event. More... | |
void | keyReleaseEvent (QKeyEvent *e) override |
Overridden key release event. More... | |
void | mouseDoubleClickEvent (QMouseEvent *e) override |
Overridden mouse double-click event. More... | |
void | mouseMoveEvent (QMouseEvent *e) override |
Overridden mouse move event. More... | |
void | mousePressEvent (QMouseEvent *e) override |
Overridden mouse press event. More... | |
void | mouseReleaseEvent (QMouseEvent *e) override |
Overridden mouse release event. More... | |
void | moveCanvasContents (bool reset=false) |
called when panning is in action, reset indicates end of panning More... | |
void | paintEvent (QPaintEvent *e) override |
Overridden paint event. More... | |
void | resizeEvent (QResizeEvent *e) override |
Overridden resize event. More... | |
void | wheelEvent (QWheelEvent *e) override |
Overridden mouse wheel event. More... | |
Protected Attributes | |
std::unique_ptr< CanvasProperties > | mCanvasProperties |
Handle pattern for implementation object. More... | |
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 74 of file qgsmapcanvas.h.
QgsMapCanvas::QgsMapCanvas | ( | QWidget * | parent = nullptr | ) |
Constructor.
Definition at line 101 of file qgsmapcanvas.cpp.
|
override |
Definition at line 201 of file qgsmapcanvas.cpp.
QList< QgsMapCanvasAnnotationItem * > QgsMapCanvas::annotationItems | ( | ) | const |
Returns a list of all annotation items in the canvas.
Definition at line 2175 of file qgsmapcanvas.cpp.
|
inline |
Returns true if annotations are visible within the map canvas.
Definition at line 589 of file qgsmapcanvas.h.
|
inline |
true if antialising is enabled
Definition at line 470 of file qgsmapcanvas.h.
QColor QgsMapCanvas::canvasColor | ( | ) | const |
Read property of QColor bgColor.
Definition at line 1709 of file qgsmapcanvas.cpp.
|
signal |
Emitted when canvas background color changes.
QgsPointXY QgsMapCanvas::center | ( | ) | const |
Gets map center, in geographical coordinates.
Definition at line 859 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 437 of file qgsmapcanvas.cpp.
void QgsMapCanvas::clearExtentHistory | ( | ) |
Definition at line 936 of file qgsmapcanvas.cpp.
QgsMapLayer * QgsMapCanvas::currentLayer | ( | ) |
returns current layer (set by legend widget)
Definition at line 464 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the current layer is changed.
|
signal |
Emitted when map CRS has changed.
|
overrideprotected |
Overridden drag enter event.
Definition at line 2108 of file qgsmapcanvas.cpp.
void QgsMapCanvas::enableAntiAliasing | ( | bool | flag | ) |
used to determine if anti-aliasing is enabled or not
Definition at line 267 of file qgsmapcanvas.cpp.
void QgsMapCanvas::enableMapTileRendering | ( | bool | flag | ) |
sets map tile rendering flag
Definition at line 272 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden standard event to be gestures aware.
Definition at line 2122 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 558 of file qgsmapcanvas.h.
|
inline |
Returns a const reference to the expression context scope for the map canvas.
Definition at line 566 of file qgsmapcanvas.h.
QgsRectangle QgsMapCanvas::extent | ( | ) | const |
Returns the current zoom extent of the map canvas.
Definition at line 783 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 1092 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 1115 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 1741 of file qgsmapcanvas.cpp.
QgsRectangle QgsMapCanvas::fullExtent | ( | ) | const |
Returns the combined extent for all layers on the map canvas.
Definition at line 788 of file qgsmapcanvas.cpp.
const QgsMapToPixel * QgsMapCanvas::getCoordinateTransform | ( | ) |
Gets the current coordinate transform.
Definition at line 304 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isCachingEnabled | ( | ) | const |
Check whether images of rendered layers are curerently being cached.
Definition at line 432 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isDrawing | ( | ) |
Find out whether rendering is in progress.
Definition at line 297 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isFrozen | ( | ) | const |
Returns true if canvas is frozen.
Definition at line 1746 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::isParallelRenderingEnabled | ( | ) | const |
Check whether the layers are rendered in parallel or sequentially.
Definition at line 448 of file qgsmapcanvas.cpp.
|
signal |
Emit key press event.
|
overrideprotected |
Overridden key press event.
Definition at line 1192 of file qgsmapcanvas.cpp.
|
signal |
Emit key release event.
|
overrideprotected |
Overridden key release event.
Definition at line 1286 of file qgsmapcanvas.cpp.
const QgsLabelingEngineSettings & QgsMapCanvas::labelingEngineSettings | ( | ) | const |
Returns global labeling engine settings from the internal map settings.
Definition at line 2206 of file qgsmapcanvas.cpp.
const QgsLabelingResults * QgsMapCanvas::labelingResults | ( | ) | const |
Gets access to the labeling results (may be null)
Definition at line 405 of file qgsmapcanvas.cpp.
QgsMapLayer * QgsMapCanvas::layer | ( | int | index | ) |
Returns the map layer at position index in the layer stack.
Definition at line 277 of file qgsmapcanvas.cpp.
int QgsMapCanvas::layerCount | ( | ) | const |
Returns number of layers on the map.
Definition at line 1724 of file qgsmapcanvas.cpp.
QList< QgsMapLayer * > QgsMapCanvas::layers | ( | ) | const |
Returns the list of layers shown within the map canvas.
Definition at line 1730 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 1735 of file qgsmapcanvas.cpp.
QMap< QString, QString > QgsMapCanvas::layerStyleOverrides | ( | ) | const |
Returns the stored overrides of styles for layers.
Definition at line 1761 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 |
|
signal |
Emitted when canvas finished a refresh request.
const QgsMapSettings & QgsMapCanvas::mapSettings | ( | ) | const |
Gets access to properties used for map rendering.
Definition at line 358 of file qgsmapcanvas.cpp.
QgsMapTool * QgsMapCanvas::mapTool | ( | ) |
Returns the currently active tool.
Definition at line 1871 of file qgsmapcanvas.cpp.
|
signal |
Emit map tool changed with the old tool.
QgsUnitTypes::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 1756 of file qgsmapcanvas.cpp.
double QgsMapCanvas::mapUnitsPerPixel | ( | ) | const |
Returns the mapUnitsPerPixel (map units per pixel) for the canvas.
Definition at line 1751 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 458 of file qgsmapcanvas.cpp.
|
signal |
emit a message (usually to be displayed in a message bar)
|
overrideprotected |
Overridden mouse double-click event.
Definition at line 1318 of file qgsmapcanvas.cpp.
QPoint QgsMapCanvas::mouseLastXY | ( | ) |
returns last position of mouse cursor
Definition at line 1912 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden mouse move event.
Definition at line 1600 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden mouse press event.
Definition at line 1373 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden mouse release event.
Definition at line 1411 of file qgsmapcanvas.cpp.
|
protected |
called when panning is in action, reset indicates end of panning
Definition at line 1903 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden paint event.
Definition at line 1492 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panAction | ( | QMouseEvent * | event | ) |
Called when mouse is moving and pan is activated.
Definition at line 1895 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panActionEnd | ( | QPoint | releasePoint | ) |
Ends pan action and redraws the canvas.
Definition at line 1876 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panToFeatureIds | ( | QgsVectorLayer * | layer, |
const QgsFeatureIds & | ids | ||
) |
Centers canvas extent to feature ids.
layer | the vector layer |
ids | the feature ids |
Definition at line 1012 of file qgsmapcanvas.cpp.
void QgsMapCanvas::panToSelected | ( | QgsVectorLayer * | layer = nullptr | ) |
Pan to the selected features of current (vector) layer keeping same extent.
Definition at line 1069 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.
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 1947 of file qgsmapcanvas.cpp.
bool QgsMapCanvas::previewModeEnabled | ( | ) | const |
Returns whether a preview mode is enabled for the map canvas.
Definition at line 1927 of file qgsmapcanvas.cpp.
|
slot |
called to read map canvas settings from project
Definition at line 1973 of file qgsmapcanvas.cpp.
|
slot |
Repaints the canvas map.
Definition at line 470 of file qgsmapcanvas.cpp.
|
slot |
Reload all layers, clear the cache and refresh the canvas.
Definition at line 2140 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. TODO: deprecate when decorations are reimplemented as map canvas items
|
inline |
Returns true if canvas render is disabled as a result of user disabling renders via the GUI.
Definition at line 371 of file qgsmapcanvas.h.
|
signal |
Emitted when the canvas is about to be rendered.
|
overrideprotected |
Overridden resize event.
Definition at line 1472 of file qgsmapcanvas.cpp.
double QgsMapCanvas::rotation | ( | ) | const |
Gets the current map canvas rotation in clockwise degrees.
Definition at line 866 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the rotation of the map changes.
|
slot |
Save the convtents of the map canvas to disk as an image.
Definition at line 713 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 292 of file qgsmapcanvas.cpp.
|
signal |
Emitted when the scale of the map changes.
|
inline |
Returns whether the scale is locked, so zooming can be performed using magnication.
Definition at line 464 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 2097 of file qgsmapcanvas.cpp.
QColor QgsMapCanvas::selectionColor | ( | ) | const |
Returns color for selected features.
Definition at line 1719 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setAnnotationsVisible | ( | bool | visible | ) |
Sets whether annotations are visible in the canvas.
Definition at line 2192 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCachingEnabled | ( | bool | enabled | ) |
Set whether to cache images of rendered layers.
Definition at line 410 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCanvasColor | ( | const QColor & | _newVal | ) |
Write property of QColor bgColor.
Definition at line 1686 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCenter | ( | const QgsPointXY & | center | ) |
Set the center of the map canvas, in geographical coordinates.
Definition at line 845 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setCurrentLayer | ( | QgsMapLayer * | layer | ) |
Definition at line 286 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setDestinationCrs | ( | const QgsCoordinateReferenceSystem & | crs | ) |
sets destination coordinate reference system
Definition at line 363 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 549 of file qgsmapcanvas.h.
void QgsMapCanvas::setExtent | ( | const QgsRectangle & | r, |
bool | magnified = false |
||
) |
Sets the extent of the map canvas.
Definition at line 794 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setLabelingEngineSettings | ( | const QgsLabelingEngineSettings & | settings | ) |
Sets global labeling engine settings in the internal map settings.
Definition at line 2201 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 309 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 1766 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.
Definition at line 246 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setMapSettingsFlags | ( | QgsMapSettings::Flags | flags | ) |
Resets the flags for the canvas' map settings.
Definition at line 398 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 1630 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 453 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setParallelRenderingEnabled | ( | bool | enabled | ) |
Set whether the layers are rendered in parallel or sequentially.
Definition at line 443 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 684 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 1937 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 1917 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 1797 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setRotation | ( | double | degrees | ) |
Set the rotation of the map canvas in clockwise degrees.
Definition at line 871 of file qgsmapcanvas.cpp.
|
slot |
Lock the scale, so zooming can be performed using magnication.
Definition at line 1595 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 2165 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 2170 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setSelectionColor | ( | const QColor & | color | ) |
Set color of selected vector features.
Definition at line 1714 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 1968 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 1776 of file qgsmapcanvas.cpp.
void QgsMapCanvas::setWheelFactor | ( | double | factor | ) |
Sets wheel zoom factor (should be greater than 1)
Definition at line 1554 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 1957 of file qgsmapcanvas.cpp.
|
slot |
stop rendering (if there is any right now)
Definition at line 698 of file qgsmapcanvas.cpp.
|
inline |
Returns the map's theme shown in the canvas, if set.
Definition at line 424 of file qgsmapcanvas.h.
|
signal |
|
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 1670 of file qgsmapcanvas.cpp.
|
protectedslot |
called on resize or changed extent to notify canvas items to change their rectangle
Definition at line 1499 of file qgsmapcanvas.cpp.
void QgsMapCanvas::updateScale | ( | ) |
Emits signal scaleChanged to update scale in main window.
Definition at line 884 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 2157 of file qgsmapcanvas.cpp.
|
overrideprotected |
Overridden mouse wheel event.
Definition at line 1517 of file qgsmapcanvas.cpp.
|
slot |
called to write map canvas settings to project
Definition at line 2024 of file qgsmapcanvas.cpp.
|
signal |
Emits current mouse position.
void QgsMapCanvas::zoomByFactor | ( | double | scaleFactor, |
const QgsPointXY * | center = nullptr |
||
) |
Zoom with the factor supplied.
Factor > 1 zooms out, interval (0,1) zooms in If point is given, re-center on it
Definition at line 2081 of file qgsmapcanvas.cpp.
|
slot |
Zoom in with fixed factor.
Definition at line 1559 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 1565 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomScale | ( | double | scale | ) |
Zooms the canvas to a specific scale.
The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
Definition at line 1571 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 968 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 992 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToFullExtent | ( | ) |
Zoom to the full extent of all layers.
Definition at line 890 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToNextExtent | ( | ) |
Zoom to the next extent (view)
Definition at line 921 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomToPreviousExtent | ( | ) |
Zoom to the previous extent (view)
Definition at line 905 of file qgsmapcanvas.cpp.
|
slot |
Zoom to the extent of the selected features of provided (vector) layer.
layer | optionally specify different than current layer |
Definition at line 946 of file qgsmapcanvas.cpp.
void QgsMapCanvas::zoomWithCenter | ( | int | x, |
int | y, | ||
bool | zoomIn | ||
) |
Zooms in/out with a given center.
Definition at line 1576 of file qgsmapcanvas.cpp.
|
friend |
Definition at line 1034 of file qgsmapcanvas.h.
|
protected |
Handle pattern for implementation object.
Definition at line 872 of file qgsmapcanvas.h.
|
readwrite |
Definition at line 88 of file qgsmapcanvas.h.
|
readwrite |
Definition at line 87 of file qgsmapcanvas.h.