QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Signals | Public Member Functions | Properties | List of all members
QgsQuickMapSettings Class Reference

The QgsQuickMapSettings class encapsulates QgsMapSettings class to offer settings of configuration of map rendering via QML properties. More...

#include <qgsquickmapsettings.h>

Inheritance diagram for QgsQuickMapSettings:
Inheritance graph
[legend]

Signals

void destinationCrsChanged ()
 CRS of destination coordinate reference system. More...
 
void extentChanged ()
 Geographical coordinates of the rectangle that should be rendered. More...
 
void layersChanged ()
 Set list of layers for map rendering. More...
 
void mapUnitsPerPixelChanged ()
 Returns the distance in geographical coordinates that equals to one pixel in the map. More...
 
void outputDpiChanged ()
 Output DPI used for conversion between real world units (e.g. More...
 
void outputSizeChanged ()
 The size of the resulting map image. More...
 
void projectChanged ()
 A project property should be used as a primary source of project all other components in the application. More...
 
void rotationChanged ()
 The rotation of the resulting map image, in degrees clockwise. More...
 
void visibleExtentChanged ()
 Returns the actual extent derived from requested extent that takes takes output image size into account. More...
 

Public Member Functions

 QgsQuickMapSettings (QObject *parent=nullptr)
 Create new map settings. More...
 
 ~QgsQuickMapSettings ()=default
 
Q_INVOKABLE QPointF coordinateToScreen (const QgsPoint &point) const
 Convert a map coordinate to screen pixel coordinates. More...
 
QgsCoordinateReferenceSystem destinationCrs () const
 returns CRS of destination coordinate reference system More...
 
QgsRectangle extent () const
 Returns geographical coordinates of the rectangle that should be rendered. More...
 
QList< QgsMapLayer * > layers () const
 Gets list of layers for map rendering The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top) More...
 
QgsMapSettings mapSettings () const
 Clone map settings. More...
 
double mapUnitsPerPixel () const
 Returns the distance in geographical coordinates that equals to one pixel in the map. More...
 
double outputDpi () const
 Returns DPI used for conversion between real world units (e.g. More...
 
QSize outputSize () const
 Returns the size of the resulting map image. More...
 
QgsProjectproject () const
 A project property should be used as a primary source of project all other components in the application. More...
 
double rotation () const
 The rotation of the resulting map image, in degrees clockwise. More...
 
Q_INVOKABLE QgsPoint screenToCoordinate (const QPointF &point) const
 Convert a screen coordinate to a map coordinate. More...
 
Q_INVOKABLE void setCenter (const QgsPoint &center)
 Move current map extent to have center point defined by center. More...
 
void setDestinationCrs (const QgsCoordinateReferenceSystem &destinationCrs)
 sets destination coordinate reference system More...
 
void setExtent (const QgsRectangle &extent)
 Set coordinates of the rectangle which should be rendered. More...
 
void setLayers (const QList< QgsMapLayer *> &layers)
 Set list of layers for map rendering. More...
 
void setOutputDpi (double outputDpi)
 Sets DPI used for conversion between real world units (e.g. mm) and pixels. More...
 
void setOutputSize (const QSize &outputSize)
 Sets the size of the resulting map image. More...
 
void setProject (QgsProject *project)
 A project property should be used as a primary source of project all other components in the application. More...
 
void setRotation (double rotation)
 The rotation of the resulting map image, in degrees clockwise. More...
 
void setTransformContext (const QgsCoordinateTransformContext &context)
 Sets the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...
 
Q_INVOKABLE QgsCoordinateTransformContext transformContext () const
 Returns the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...
 
QgsRectangle visibleExtent () const
 Returns the actual extent derived from requested extent that takes takes output image size into account. More...
 

Properties

QgsCoordinateReferenceSystem destinationCrs
 CRS of destination coordinate reference system. More...
 
QgsRectangle extent
 Geographical coordinates of the rectangle that should be rendered. More...
 
QList< QgsMapLayer * > layers
 Set list of layers for map rendering. More...
 
double mapUnitsPerPixel
 Returns the distance in geographical coordinates that equals to one pixel in the map. More...
 
double outputDpi
 Output DPI used for conversion between real world units (e.g. More...
 
QSize outputSize
 The size of the resulting map image. More...
 
QgsProject project
 A project property should be used as a primary source of project all other components in the application. More...
 
double rotation
 The rotation of the resulting map image, in degrees clockwise. More...
 
QgsRectangle visibleExtent
 Returns the actual extent derived from requested extent that takes takes output image size into account. More...
 

Detailed Description

The QgsQuickMapSettings class encapsulates QgsMapSettings class to offer settings of configuration of map rendering via QML properties.

On top of QgsMapSettings functionality, when QgsProject is attached, it automatically loads its default settings from the project. QgsProject should be attached before it is read.

Note
QML Type: MapSettings
See also
QgsMapCanvas
Since
QGIS 3.2

Definition at line 46 of file qgsquickmapsettings.h.

Constructor & Destructor Documentation

◆ QgsQuickMapSettings()

QgsQuickMapSettings::QgsQuickMapSettings ( QObject *  parent = nullptr)

Create new map settings.

Definition at line 25 of file qgsquickmapsettings.cpp.

◆ ~QgsQuickMapSettings()

QgsQuickMapSettings::~QgsQuickMapSettings ( )
default

Member Function Documentation

◆ coordinateToScreen()

QPointF QgsQuickMapSettings::coordinateToScreen ( const QgsPoint point) const

Convert a map coordinate to screen pixel coordinates.

Parameters
pointA coordinate in map coordinates
Returns
A coordinate in pixel / screen space

Definition at line 112 of file qgsquickmapsettings.cpp.

◆ destinationCrs()

QgsCoordinateReferenceSystem QgsQuickMapSettings::destinationCrs ( ) const

returns CRS of destination coordinate reference system

◆ destinationCrsChanged

void QgsQuickMapSettings::destinationCrsChanged ( )
signal

CRS of destination coordinate reference system.

Automatically loaded from project on QgsProject::readProject

◆ extent()

QgsRectangle QgsQuickMapSettings::extent ( ) const

Returns geographical coordinates of the rectangle that should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use visibleExtent() to get the resulting extent.

◆ extentChanged

void QgsQuickMapSettings::extentChanged ( )
signal

Geographical coordinates of the rectangle that should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use QgsQuickMapSettings::visibleExtent to get the resulting extent.

Automatically loaded from project on QgsProject::readProject

◆ layers()

QList<QgsMapLayer *> QgsQuickMapSettings::layers ( ) const

Gets list of layers for map rendering The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)

◆ layersChanged

void QgsQuickMapSettings::layersChanged ( )
signal

Set list of layers for map rendering.

The layers must be registered in QgsProject. The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)

Note
Any non-spatial layers will be automatically stripped from the list (since they cannot be rendered!).

Not loaded automatically from the associated project

◆ mapSettings()

QgsMapSettings QgsQuickMapSettings::mapSettings ( ) const

Clone map settings.

Definition at line 128 of file qgsquickmapsettings.cpp.

◆ mapUnitsPerPixel()

double QgsQuickMapSettings::mapUnitsPerPixel ( ) const

Returns the distance in geographical coordinates that equals to one pixel in the map.

◆ mapUnitsPerPixelChanged

void QgsQuickMapSettings::mapUnitsPerPixelChanged ( )
signal

Returns the distance in geographical coordinates that equals to one pixel in the map.

◆ outputDpi()

double QgsQuickMapSettings::outputDpi ( ) const

Returns DPI used for conversion between real world units (e.g.

mm) and pixels Default value is 96

◆ outputDpiChanged

void QgsQuickMapSettings::outputDpiChanged ( )
signal

Output DPI used for conversion between real world units (e.g.

mm) and pixels

Automatically loaded from project on QgsProject::readProject

◆ outputSize()

QSize QgsQuickMapSettings::outputSize ( ) const

Returns the size of the resulting map image.

◆ outputSizeChanged

void QgsQuickMapSettings::outputSizeChanged ( )
signal

The size of the resulting map image.

Automatically loaded from project on QgsProject::readProject

◆ project()

QgsProject* QgsQuickMapSettings::project ( ) const

A project property should be used as a primary source of project all other components in the application.

QgsProject should be attached to QgsQuickMapSettings before it is read (QgsProject::read)

When project is read, map settings (CRS, extent, ...) are automatically set from its DOM.

◆ projectChanged

void QgsQuickMapSettings::projectChanged ( )
signal

A project property should be used as a primary source of project all other components in the application.

QgsProject should be attached to QgsQuickMapSettings before it is read (QgsProject::read)

When project is read, map settings (CRS, extent, ...) are automatically set from its DOM.

◆ rotation()

double QgsQuickMapSettings::rotation ( ) const

The rotation of the resulting map image, in degrees clockwise.

Map canvas rotation support is not implemented, 0 is used

◆ rotationChanged

void QgsQuickMapSettings::rotationChanged ( )
signal

The rotation of the resulting map image, in degrees clockwise.

Map canvas rotation support is not implemented, 0 is used

◆ screenToCoordinate()

QgsPoint QgsQuickMapSettings::screenToCoordinate ( const QPointF &  point) const

Convert a screen coordinate to a map coordinate.

Parameters
pointA coordinate in pixel / screen coordinates
Returns
A coordinate in map coordinates

Definition at line 119 of file qgsquickmapsettings.cpp.

◆ setCenter()

void QgsQuickMapSettings::setCenter ( const QgsPoint center)

Move current map extent to have center point defined by center.

Definition at line 89 of file qgsquickmapsettings.cpp.

◆ setDestinationCrs()

void QgsQuickMapSettings::setDestinationCrs ( const QgsCoordinateReferenceSystem destinationCrs)

sets destination coordinate reference system

Definition at line 166 of file qgsquickmapsettings.cpp.

◆ setExtent()

void QgsQuickMapSettings::setExtent ( const QgsRectangle extent)

Set coordinates of the rectangle which should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use visibleExtent() to get the resulting extent.

Definition at line 80 of file qgsquickmapsettings.cpp.

◆ setLayers()

void QgsQuickMapSettings::setLayers ( const QList< QgsMapLayer *> &  layers)

Set list of layers for map rendering.

The layers must be registered in QgsProject. The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)

Note
Any non-spatial layers will be automatically stripped from the list (since they cannot be rendered!).

Definition at line 180 of file qgsquickmapsettings.cpp.

◆ setOutputDpi()

void QgsQuickMapSettings::setOutputDpi ( double  outputDpi)

Sets DPI used for conversion between real world units (e.g. mm) and pixels.

Definition at line 152 of file qgsquickmapsettings.cpp.

◆ setOutputSize()

void QgsQuickMapSettings::setOutputSize ( const QSize &  outputSize)

Sets the size of the resulting map image.

Definition at line 138 of file qgsquickmapsettings.cpp.

◆ setProject()

void QgsQuickMapSettings::setProject ( QgsProject project)

A project property should be used as a primary source of project all other components in the application.

QgsProject should be attached to QgsQuickMapSettings before it is read (QgsProject::read)

When project is read, map settings (CRS, extent, ...) are automatically set from its DOM.

Definition at line 37 of file qgsquickmapsettings.cpp.

◆ setRotation()

void QgsQuickMapSettings::setRotation ( double  rotation)

The rotation of the resulting map image, in degrees clockwise.

Map canvas rotation support is not implemented, 0 is used

Definition at line 213 of file qgsquickmapsettings.cpp.

◆ setTransformContext()

void QgsQuickMapSettings::setTransformContext ( const QgsCoordinateTransformContext context)

Sets the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also
transformContext()
Since
QGIS 3.0

◆ transformContext()

QgsCoordinateTransformContext QgsQuickMapSettings::transformContext ( ) const

Returns the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also
setTransformContext()
Since
QGIS 3.0

Definition at line 70 of file qgsquickmapsettings.cpp.

◆ visibleExtent()

QgsRectangle QgsQuickMapSettings::visibleExtent ( ) const

Returns the actual extent derived from requested extent that takes takes output image size into account.

◆ visibleExtentChanged

void QgsQuickMapSettings::visibleExtentChanged ( )
signal

Returns the actual extent derived from requested extent that takes takes output image size into account.

Property Documentation

◆ destinationCrs

QgsCoordinateReferenceSystem QgsQuickMapSettings::destinationCrs
readwrite

CRS of destination coordinate reference system.

Automatically loaded from project on QgsProject::readProject

Definition at line 98 of file qgsquickmapsettings.h.

◆ extent

QgsRectangle QgsQuickMapSettings::extent
readwrite

Geographical coordinates of the rectangle that should be rendered.

The actual visible extent used for rendering could be slightly different since the given extent may be expanded in order to fit the aspect ratio of output size. Use QgsQuickMapSettings::visibleExtent to get the resulting extent.

Automatically loaded from project on QgsProject::readProject

Definition at line 67 of file qgsquickmapsettings.h.

◆ layers

QList< QgsMapLayer * > QgsQuickMapSettings::layers
readwrite

Set list of layers for map rendering.

The layers must be registered in QgsProject. The layers are stored in the reverse order of how they are rendered (layer with index 0 will be on top)

Note
Any non-spatial layers will be automatically stripped from the list (since they cannot be rendered!).

Not loaded automatically from the associated project

Definition at line 108 of file qgsquickmapsettings.h.

◆ mapUnitsPerPixel

double QgsQuickMapSettings::mapUnitsPerPixel
read

Returns the distance in geographical coordinates that equals to one pixel in the map.

Definition at line 71 of file qgsquickmapsettings.h.

◆ outputDpi

double QgsQuickMapSettings::outputDpi
readwrite

Output DPI used for conversion between real world units (e.g.

mm) and pixels

Automatically loaded from project on QgsProject::readProject

Definition at line 91 of file qgsquickmapsettings.h.

◆ outputSize

QSize QgsQuickMapSettings::outputSize
readwrite

The size of the resulting map image.

Automatically loaded from project on QgsProject::readProject

Definition at line 84 of file qgsquickmapsettings.h.

◆ project

QgsProject * QgsQuickMapSettings::project
readwrite

A project property should be used as a primary source of project all other components in the application.

QgsProject should be attached to QgsQuickMapSettings before it is read (QgsProject::read)

When project is read, map settings (CRS, extent, ...) are automatically set from its DOM.

Definition at line 57 of file qgsquickmapsettings.h.

◆ rotation

double QgsQuickMapSettings::rotation
readwrite

The rotation of the resulting map image, in degrees clockwise.

Map canvas rotation support is not implemented, 0 is used

Definition at line 77 of file qgsquickmapsettings.h.

◆ visibleExtent

QgsRectangle QgsQuickMapSettings::visibleExtent
read

Returns the actual extent derived from requested extent that takes takes output image size into account.

Definition at line 69 of file qgsquickmapsettings.h.


The documentation for this class was generated from the following files: