The QgsMapSettings class contains configuration for rendering of the map. More...

#include <qgsmapsettings.h>

Public Types
enum	Flag { Antialiasing = 0x01, DrawEditingInfo = 0x02, ForceVectorOutput = 0x04, UseAdvancedEffects = 0x08, DrawLabeling = 0x10, UseRenderingOptimization = 0x20, DrawSelection = 0x40, DrawSymbolBounds = 0x80, RenderMapTile = 0x100, RenderPartialOutput = 0x200 }
	Enumeration of flags that adjust the way the map is rendered. More...

Public Member Functions
	QgsMapSettings ()

QColor	backgroundColor () const
	Get the background color of the map. More...

QString	customRenderFlags () const
	Get custom rendering flags. More...

const QgsDatumTransformStore &	datumTransformStore () const

QgsDatumTransformStore &	datumTransformStore ()

const QgsCoordinateReferenceSystem &	destinationCrs () const
	returns CRS of destination coordinate reference system More...

const QgsExpressionContext &	expressionContext () const
	Gets the expression context. More...

QgsRectangle	extent () const
	Return geographical coordinates of the rectangle that should be rendered. More...

Flags	flags () const
	Return combination of flags used for rendering. More...

QgsRectangle	fullExtent () const
	returns current extent of layer set More...

bool	hasCrsTransformEnabled () const
	returns true if projections are enabled for this layer set More...

bool	hasValidSettings () const
	Check whether the map settings are valid and can be used for rendering. More...

QgsRectangle	layerExtentToOutputExtent (QgsMapLayer *theLayer, QgsRectangle extent) const
	transform bounding box from layer's CRS to output CRS More...

QStringList	layers () const
	Get list of layer IDs 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...

QMap< QString, QString >	layerStyleOverrides () const
	Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one. More...

QgsPoint	layerToMapCoordinates (QgsMapLayer *theLayer, QgsPoint point) const
	transform point coordinates from layer's CRS to output CRS More...

QgsRectangle	layerToMapCoordinates (QgsMapLayer *theLayer, QgsRectangle rect) const
	transform rectangle from layer's CRS to output CRS More...

double	layerToMapUnits (QgsMapLayer *theLayer, const QgsRectangle &referenceExtent=QgsRectangle()) const
	Computes an estimated conversion factor between layer and map units: layerUnits * layerToMapUnits = mapUnits. More...

const QgsCoordinateTransform *	layerTransform (QgsMapLayer *layer) const
	Return coordinate transform from layer's CRS to destination CRS. More...

double	magnificationFactor () const
	Return the magnification factor. More...

QgsPoint	mapToLayerCoordinates (QgsMapLayer *theLayer, QgsPoint point) const
	transform point coordinates from output CRS to layer's CRS More...

QgsRectangle	mapToLayerCoordinates (QgsMapLayer *theLayer, QgsRectangle rect) const
	transform rectangle from output CRS to layer's CRS More...

const QgsMapToPixel &	mapToPixel () const

QGis::UnitType	mapUnits () const
	Get units of map's geographical coordinates - used for scale calculation. More...

double	mapUnitsPerPixel () const
	Return the distance in geographical coordinates that equals to one pixel in the map. More...

double	outputDpi () const
	Return DPI used for conversion between real world units (e.g. More...

QgsRectangle	outputExtentToLayerExtent (QgsMapLayer *theLayer, QgsRectangle extent) const
	transform bounding box from output CRS to layer's CRS More...

QImage::Format	outputImageFormat () const
	format of internal QImage, default QImage::Format_ARGB32_Premultiplied More...

QSize	outputSize () const
	Return the size of the resulting map image. More...

void	readXML (QDomNode &theNode)

double	rotation () const
	Return the rotation of the resulting map image Units are clockwise degrees. More...

double	scale () const
	Return the calculated scale of the map. More...

double	segmentationTolerance () const
	Gets the segmentation tolerance applied when rendering curved geometries. More...

QgsAbstractGeometryV2::SegmentationToleranceType	segmentationToleranceType () const
	Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) More...

QColor	selectionColor () const
	Get color that is used for drawing of selected vector features. More...

void	setBackgroundColor (const QColor &color)
	Set the background color of the map. More...

void	setCrsTransformEnabled (bool enabled)
	sets whether to use projections for this layer set More...

void	setCustomRenderFlags (const QString &customRenderFlags)
	Sets the custom rendering flags. More...

void	setDestinationCrs (const QgsCoordinateReferenceSystem &crs)
	sets destination coordinate reference system More...

void	setExpressionContext (const QgsExpressionContext &context)
	Sets the expression context. More...

void	setExtent (const QgsRectangle &rect, bool magnified=true)
	Set coordinates of the rectangle which should be rendered. More...

void	setFlag (Flag flag, bool on=true)
	Enable or disable a particular flag (other flags are not affected) More...

void	setFlags (const QgsMapSettings::Flags &flags)
	Set combination of flags that will be used for rendering. More...

void	setLayers (const QStringList &layers)
	Set list of layer IDs for map rendering. More...

void	setLayerStyleOverrides (const QMap< QString, QString > &overrides)
	Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one. More...

void	setMagnificationFactor (double factor)
	Set the magnification factor. More...

void	setMapUnits (QGis::UnitType u)
	Set units of map's geographical coordinates - used for scale calculation. More...

void	setOutputDpi (double dpi)
	Set DPI used for conversion between real world units (e.g. mm) and pixels. More...

void	setOutputImageFormat (QImage::Format format)
	sets format of internal QImage More...

void	setOutputSize (QSize size)
	Set the size of the resulting map image. More...

void	setRotation (double degrees)
	Set the rotation of the resulting map image Units are clockwise degrees. More...

void	setSegmentationTolerance (double tolerance)
	Sets the segmentation tolerance applied when rendering curved geometries. More...

void	setSegmentationToleranceType (QgsAbstractGeometryV2::SegmentationToleranceType type)
	Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation) More...

void	setSelectionColor (const QColor &color)
	Set color that is used for drawing of selected vector features. More...

bool	testFlag (Flag flag) const
	Check whether a particular flag is enabled. More...

QgsRectangle	visibleExtent () const
	Return the actual extent derived from requested extent that takes takes output image size into account. More...

QPolygonF	visiblePolygon () const
	Return the visible area as a polygon (may be rotated) More...

void	writeXML (QDomNode &theNode, QDomDocument &theDoc)

Protected Member Functions
void	updateDerived ()

Protected Attributes
QColor	mBackgroundColor

QString	mCustomRenderFlags

QgsDatumTransformStore	mDatumTransformStore

QgsCoordinateReferenceSystem	mDestCRS

double	mDpi

QgsExpressionContext	mExpressionContext

QgsRectangle	mExtent

Flags	mFlags

QImage::Format	mImageFormat

QStringList	mLayers

QMap< QString, QString >	mLayerStyleOverrides

double	mMagnificationFactor

QgsMapToPixel	mMapToPixel

double	mMapUnitsPerPixel

bool	mProjectionsEnabled

double	mRotation

double	mScale

QgsScaleCalculator	mScaleCalculator

double	mSegmentationTolerance

QgsAbstractGeometryV2::SegmentationToleranceType	mSegmentationToleranceType

QColor	mSelectionColor

QSize	mSize

bool	mValid
	whether the actual settings are valid (set in updateDerived()) More...

QgsRectangle	mVisibleExtent
	extent with some additional white space that matches the output aspect ratio More...

Detailed Description

The QgsMapSettings class contains configuration for rendering of the map.

The rendering itself is done by QgsMapRendererJob subclasses.

In order to set up QgsMapSettings instance, it is necessary to set at least few members: extent, output size and layers.

QgsMapSettings and QgsMapRendererJob (+subclasses) are intended to replace QgsMapRenderer class that existed before QGIS 2.4. The advantage of the new classes is that they separate the settings from the rendering and provide asynchronous API for map rendering.

Note: added in 2.4

Definition at line 54 of file qgsmapsettings.h.

Member Enumeration Documentation

◆ Flag

enum QgsMapSettings::Flag

Enumeration of flags that adjust the way the map is rendered.

Enumerator
Antialiasing	Enable anti-aliasing for map rendering.
DrawEditingInfo	Enable drawing of vertex markers for layers in editing mode.
ForceVectorOutput	Vector graphics should not be cached and drawn as raster images.
UseAdvancedEffects	Enable layer transparency and blending effects.
DrawLabeling	Enable drawing of labels on top of the map.
UseRenderingOptimization	Enable vector simplification and other rendering optimizations.
DrawSelection	Whether vector selections should be shown in the rendered map.
DrawSymbolBounds	Draw bounds of symbols (for debugging/testing)
RenderMapTile	Draw map such that there are no problems between adjacent tiles.
RenderPartialOutput	Whether to make extra effort to update map image with partially rendered layers (better for interactive map canvas). Added in QGIS 2.18.

Definition at line 157 of file qgsmapsettings.h.

Constructor & Destructor Documentation

◆ QgsMapSettings()

QgsMapSettings::QgsMapSettings ( )

Definition at line 33 of file qgsmapsettings.cpp.

Member Function Documentation

◆ backgroundColor()

QColor QgsMapSettings::backgroundColor ( ) const

inline

Get the background color of the map.

Definition at line 149 of file qgsmapsettings.h.

◆ customRenderFlags()

QString QgsMapSettings::customRenderFlags ( ) const

inline

Get custom rendering flags.

Layers might honour these to alter their rendering.

Returns: custom flags strings, separated by ';'

Note: added in QGIS 2.16

See also: setCustomRenderFlags()

Definition at line 122 of file qgsmapsettings.h.

◆ datumTransformStore() [1/2]

const QgsDatumTransformStore& QgsMapSettings::datumTransformStore ( ) const

inline

Note: not available in python bindings

Definition at line 216 of file qgsmapsettings.h.

◆ datumTransformStore() [2/2]

QgsDatumTransformStore& QgsMapSettings::datumTransformStore ( )

inline

Definition at line 217 of file qgsmapsettings.h.

◆ destinationCrs()

const QgsCoordinateReferenceSystem & QgsMapSettings::destinationCrs ( ) const

returns CRS of destination coordinate reference system

Definition at line 294 of file qgsmapsettings.cpp.

◆ expressionContext()

const QgsExpressionContext& QgsMapSettings::expressionContext ( ) const

inline

Gets the expression context.

This context should be used for all expression evaluation associated with this map settings.

See also: setExpressionContext()

Note: added in QGIS 2.12

Definition at line 211 of file qgsmapsettings.h.

◆ extent()

QgsRectangle QgsMapSettings::extent ( ) const

Return 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.

Definition at line 85 of file qgsmapsettings.cpp.

◆ flags()

QgsMapSettings::Flags QgsMapSettings::flags ( ) const

Return combination of flags used for rendering.

Definition at line 321 of file qgsmapsettings.cpp.

◆ fullExtent()

QgsRectangle QgsMapSettings::fullExtent ( ) const

returns current extent of layer set

Definition at line 529 of file qgsmapsettings.cpp.

◆ hasCrsTransformEnabled()

bool QgsMapSettings::hasCrsTransformEnabled ( ) const

returns true if projections are enabled for this layer set

Definition at line 282 of file qgsmapsettings.cpp.

◆ hasValidSettings()

bool QgsMapSettings::hasValidSettings ( ) const

Check whether the map settings are valid and can be used for rendering.

Definition at line 337 of file qgsmapsettings.cpp.

◆ layerExtentToOutputExtent()

QgsRectangle QgsMapSettings::layerExtentToOutputExtent	(	QgsMapLayer *	theLayer,
		QgsRectangle	extent
	)		const

transform bounding box from layer's CRS to output CRS

See also: layerToMapCoordinates( QgsMapLayer* theLayer, QgsRectangle rect ) if you want to transform a rectangle

Returns: a bounding box (aligned rectangle) containing the transformed extent

Definition at line 392 of file qgsmapsettings.cpp.

◆ layers()

QStringList QgsMapSettings::layers ( ) const

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

Definition at line 257 of file qgsmapsettings.cpp.

◆ layerStyleOverrides()

QMap< QString, QString > QgsMapSettings::layerStyleOverrides ( ) const

Get map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one.

Note: added in 2.8

Definition at line 267 of file qgsmapsettings.cpp.

◆ layerToMapCoordinates() [1/2]

QgsPoint QgsMapSettings::layerToMapCoordinates	(	QgsMapLayer *	theLayer,
		QgsPoint	point
	)		const

transform point coordinates from layer's CRS to output CRS

Returns: the transformed point

Definition at line 444 of file qgsmapsettings.cpp.

◆ layerToMapCoordinates() [2/2]

QgsRectangle QgsMapSettings::layerToMapCoordinates	(	QgsMapLayer *	theLayer,
		QgsRectangle	rect
	)		const

transform rectangle from layer's CRS to output CRS

See also: layerExtentToOutputExtent() if you want to transform a bounding box

Returns: the transformed rectangle

Definition at line 466 of file qgsmapsettings.cpp.

◆ layerToMapUnits()

double QgsMapSettings::layerToMapUnits	(	QgsMapLayer *	theLayer,
		const QgsRectangle &	referenceExtent = `QgsRectangle()`
	)		const

Computes an estimated conversion factor between layer and map units: layerUnits * layerToMapUnits = mapUnits.

Parameters

theLayer	The layer
referenceExtent	A reference extent based on which to perform the computation. If not specified, the layer extent is used

Note: added in QGIS 2.12

Definition at line 379 of file qgsmapsettings.cpp.

◆ layerTransform()

const QgsCoordinateTransform * QgsMapSettings::layerTransform ( QgsMapLayer * layer ) const

Return coordinate transform from layer's CRS to destination CRS.

Parameters

layer

Returns: transform - may be null if the transform is not needed

Definition at line 373 of file qgsmapsettings.cpp.

◆ magnificationFactor()

double QgsMapSettings::magnificationFactor ( ) const

Return the magnification factor.

Note: added in 2.16

See also: setMagnificationFactor()

Definition at line 80 of file qgsmapsettings.cpp.

◆ mapToLayerCoordinates() [1/2]

QgsPoint QgsMapSettings::mapToLayerCoordinates	(	QgsMapLayer *	theLayer,
		QgsPoint	point
	)		const

transform point coordinates from output CRS to layer's CRS

Returns: the transformed point

Definition at line 488 of file qgsmapsettings.cpp.

◆ mapToLayerCoordinates() [2/2]

QgsRectangle QgsMapSettings::mapToLayerCoordinates	(	QgsMapLayer *	theLayer,
		QgsRectangle	rect
	)		const

transform rectangle from output CRS to layer's CRS

See also: outputExtentToLayerExtent() if you want to transform a bounding box

Returns: the transformed rectangle

Definition at line 510 of file qgsmapsettings.cpp.

◆ mapToPixel()

const QgsMapToPixel& QgsMapSettings::mapToPixel ( ) const

inline

Definition at line 219 of file qgsmapsettings.h.

◆ mapUnits()

QGis::UnitType QgsMapSettings::mapUnits ( ) const

Get units of map's geographical coordinates - used for scale calculation.

Definition at line 331 of file qgsmapsettings.cpp.

◆ mapUnitsPerPixel()

double QgsMapSettings::mapUnitsPerPixel ( ) const

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

Definition at line 362 of file qgsmapsettings.cpp.

◆ outputDpi()

double QgsMapSettings::outputDpi ( ) const

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

mm) and pixels Default value is 96

Definition at line 244 of file qgsmapsettings.cpp.

◆ outputExtentToLayerExtent()

QgsRectangle QgsMapSettings::outputExtentToLayerExtent	(	QgsMapLayer *	theLayer,
		QgsRectangle	extent
	)		const

transform bounding box from output CRS to layer's CRS

See also: mapToLayerCoordinates( QgsMapLayer* theLayer,QgsRectangle rect ) if you want to transform a rectangle

Returns: a bounding box (aligned rectangle) containing the transformed extent

Definition at line 418 of file qgsmapsettings.cpp.

◆ outputImageFormat()

QImage::Format QgsMapSettings::outputImageFormat ( ) const

inline

format of internal QImage, default QImage::Format_ARGB32_Premultiplied

Definition at line 185 of file qgsmapsettings.h.

◆ outputSize()

QSize QgsMapSettings::outputSize ( ) const

Return the size of the resulting map image.

Definition at line 232 of file qgsmapsettings.cpp.

◆ readXML()

void QgsMapSettings::readXML ( QDomNode & theNode )

Definition at line 601 of file qgsmapsettings.cpp.

◆ rotation()

double QgsMapSettings::rotation ( ) const

Return the rotation of the resulting map image Units are clockwise degrees.

Note: added in 2.8

Definition at line 102 of file qgsmapsettings.cpp.

◆ scale()

double QgsMapSettings::scale ( ) const

Return the calculated scale of the map.

Definition at line 367 of file qgsmapsettings.cpp.

◆ segmentationTolerance()

double QgsMapSettings::segmentationTolerance ( ) const

inline

Gets the segmentation tolerance applied when rendering curved geometries.

Definition at line 288 of file qgsmapsettings.h.

◆ segmentationToleranceType()

QgsAbstractGeometryV2::SegmentationToleranceType QgsMapSettings::segmentationToleranceType ( ) const

inline

Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

Definition at line 293 of file qgsmapsettings.h.

◆ selectionColor()

QColor QgsMapSettings::selectionColor ( ) const

inline

Get color that is used for drawing of selected vector features.

Definition at line 154 of file qgsmapsettings.h.

◆ setBackgroundColor()

void QgsMapSettings::setBackgroundColor ( const QColor & color )

inline

Set the background color of the map.

Definition at line 147 of file qgsmapsettings.h.

◆ setCrsTransformEnabled()

void QgsMapSettings::setCrsTransformEnabled ( bool enabled )

sets whether to use projections for this layer set

Definition at line 277 of file qgsmapsettings.cpp.

◆ setCustomRenderFlags()

void QgsMapSettings::setCustomRenderFlags ( const QString & customRenderFlags )

inline

Sets the custom rendering flags.

Layers might honour these to alter their rendering.

Parameters

customRenderFlags custom flags strings, separated by ';'

Note: added in QGIS 2.16

See also: customRenderFlags()

Definition at line 129 of file qgsmapsettings.h.

◆ setDestinationCrs()

void QgsMapSettings::setDestinationCrs ( const QgsCoordinateReferenceSystem & crs )

sets destination coordinate reference system

Definition at line 288 of file qgsmapsettings.cpp.

◆ setExpressionContext()

void QgsMapSettings::setExpressionContext ( const QgsExpressionContext & context )

inline

Sets the expression context.

This context is used for all expression evaluation associated with this map settings.

See also: expressionContext()

Note: added in QGIS 2.12

Definition at line 204 of file qgsmapsettings.h.

◆ setExtent()

void QgsMapSettings::setExtent	(	const QgsRectangle &	rect,
		bool	magnified = `true`
	)

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 90 of file qgsmapsettings.cpp.

◆ setFlag()

void QgsMapSettings::setFlag	(	QgsMapSettings::Flag	flag,
		bool	on = `true`
	)

Enable or disable a particular flag (other flags are not affected)

Definition at line 313 of file qgsmapsettings.cpp.

◆ setFlags()

void QgsMapSettings::setFlags ( const QgsMapSettings::Flags & flags )

Set combination of flags that will be used for rendering.

Definition at line 308 of file qgsmapsettings.cpp.

◆ setLayers()

void QgsMapSettings::setLayers ( const QStringList & layers )

Set list of layer IDs for map rendering.

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

Definition at line 262 of file qgsmapsettings.cpp.

◆ setLayerStyleOverrides()

void QgsMapSettings::setLayerStyleOverrides ( const QMap< QString, QString > & overrides )

Set map of map layer style overrides (key: layer ID, value: style name) where a different style should be used instead of the current one.

Note: added in 2.8

Definition at line 272 of file qgsmapsettings.cpp.

◆ setMagnificationFactor()

void QgsMapSettings::setMagnificationFactor ( double factor )

Set the magnification factor.

Parameters

factor the factor of magnification

Note: added in 2.16

See also: magnificationFactor()

Definition at line 59 of file qgsmapsettings.cpp.

◆ setMapUnits()

void QgsMapSettings::setMapUnits ( QGis::UnitType u )

Set units of map's geographical coordinates - used for scale calculation.

Definition at line 300 of file qgsmapsettings.cpp.

◆ setOutputDpi()

void QgsMapSettings::setOutputDpi ( double dpi )

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

Definition at line 249 of file qgsmapsettings.cpp.

◆ setOutputImageFormat()

void QgsMapSettings::setOutputImageFormat ( QImage::Format format )

inline

sets format of internal QImage

Definition at line 183 of file qgsmapsettings.h.

◆ setOutputSize()

void QgsMapSettings::setOutputSize ( QSize size )

Set the size of the resulting map image.

Definition at line 237 of file qgsmapsettings.cpp.

◆ setRotation()

void QgsMapSettings::setRotation ( double degrees )

Set the rotation of the resulting map image Units are clockwise degrees.

Note: added in 2.8

Definition at line 107 of file qgsmapsettings.cpp.

◆ setSegmentationTolerance()

void QgsMapSettings::setSegmentationTolerance ( double tolerance )

inline

Sets the segmentation tolerance applied when rendering curved geometries.

Parameters

tolerance the segmentation tolerance

Definition at line 286 of file qgsmapsettings.h.

◆ setSegmentationToleranceType()

void QgsMapSettings::setSegmentationToleranceType ( QgsAbstractGeometryV2::SegmentationToleranceType type )

inline

Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)

Parameters

type	the segmentation tolerance typename

Definition at line 291 of file qgsmapsettings.h.

◆ setSelectionColor()

void QgsMapSettings::setSelectionColor ( const QColor & color )

inline

Set color that is used for drawing of selected vector features.

Definition at line 152 of file qgsmapsettings.h.

◆ testFlag()

bool QgsMapSettings::testFlag ( QgsMapSettings::Flag flag ) const

Check whether a particular flag is enabled.

Definition at line 326 of file qgsmapsettings.cpp.

◆ updateDerived()

void QgsMapSettings::updateDerived ( )

protected

Definition at line 118 of file qgsmapsettings.cpp.

◆ visibleExtent()

QgsRectangle QgsMapSettings::visibleExtent ( ) const

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

Definition at line 342 of file qgsmapsettings.cpp.

◆ visiblePolygon()

QPolygonF QgsMapSettings::visiblePolygon ( ) const

Return the visible area as a polygon (may be rotated)

Note: added in 2.8

Definition at line 347 of file qgsmapsettings.cpp.

◆ writeXML()

void QgsMapSettings::writeXML	(	QDomNode &	theNode,
		QDomDocument &	theDoc
	)

Definition at line 644 of file qgsmapsettings.cpp.

Member Data Documentation

◆ mBackgroundColor

QColor QgsMapSettings::mBackgroundColor

protected

Definition at line 315 of file qgsmapsettings.h.

◆ mCustomRenderFlags

QString QgsMapSettings::mCustomRenderFlags

protected

Definition at line 308 of file qgsmapsettings.h.

◆ mDatumTransformStore

QgsDatumTransformStore QgsMapSettings::mDatumTransformStore

protected

Definition at line 313 of file qgsmapsettings.h.

◆ mDestCRS

QgsCoordinateReferenceSystem QgsMapSettings::mDestCRS

protected

Definition at line 312 of file qgsmapsettings.h.

◆ mDpi

double QgsMapSettings::mDpi

protected

Definition at line 297 of file qgsmapsettings.h.

◆ mExpressionContext

QgsExpressionContext QgsMapSettings::mExpressionContext

protected

Definition at line 309 of file qgsmapsettings.h.

◆ mExtent

QgsRectangle QgsMapSettings::mExtent

protected

Definition at line 301 of file qgsmapsettings.h.

◆ mFlags

Flags QgsMapSettings::mFlags

protected

Definition at line 318 of file qgsmapsettings.h.

◆ mImageFormat

QImage::Format QgsMapSettings::mImageFormat

protected

Definition at line 320 of file qgsmapsettings.h.

◆ mLayers

QStringList QgsMapSettings::mLayers

protected

Definition at line 306 of file qgsmapsettings.h.

◆ mLayerStyleOverrides

QMap<QString, QString> QgsMapSettings::mLayerStyleOverrides

protected

Definition at line 307 of file qgsmapsettings.h.

◆ mMagnificationFactor

double QgsMapSettings::mMagnificationFactor

protected

Definition at line 304 of file qgsmapsettings.h.

◆ mMapToPixel

QgsMapToPixel QgsMapSettings::mMapToPixel

protected

Definition at line 334 of file qgsmapsettings.h.

◆ mMapUnitsPerPixel

double QgsMapSettings::mMapUnitsPerPixel

protected

Definition at line 329 of file qgsmapsettings.h.

◆ mProjectionsEnabled

bool QgsMapSettings::mProjectionsEnabled

protected

Definition at line 311 of file qgsmapsettings.h.

◆ mRotation

double QgsMapSettings::mRotation

protected

Definition at line 303 of file qgsmapsettings.h.

◆ mScale

double QgsMapSettings::mScale

protected

Definition at line 330 of file qgsmapsettings.h.

◆ mScaleCalculator

QgsScaleCalculator QgsMapSettings::mScaleCalculator

protected

Definition at line 333 of file qgsmapsettings.h.

◆ mSegmentationTolerance

double QgsMapSettings::mSegmentationTolerance

protected

Definition at line 322 of file qgsmapsettings.h.

◆ mSegmentationToleranceType

QgsAbstractGeometryV2::SegmentationToleranceType QgsMapSettings::mSegmentationToleranceType

protected

Definition at line 323 of file qgsmapsettings.h.

◆ mSelectionColor

QColor QgsMapSettings::mSelectionColor

protected

Definition at line 316 of file qgsmapsettings.h.

◆ mSize

QSize QgsMapSettings::mSize

protected

Definition at line 299 of file qgsmapsettings.h.

◆ mValid

bool QgsMapSettings::mValid

protected

whether the actual settings are valid (set in updateDerived())

Definition at line 327 of file qgsmapsettings.h.

◆ mVisibleExtent

QgsRectangle QgsMapSettings::mVisibleExtent

protected

extent with some additional white space that matches the output aspect ratio

Definition at line 328 of file qgsmapsettings.h.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmapsettings.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/qgsmapsettings.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Flag

Constructor & Destructor Documentation

◆ QgsMapSettings()

Member Function Documentation

◆ backgroundColor()

◆ customRenderFlags()

◆ datumTransformStore() [1/2]

◆ datumTransformStore() [2/2]

◆ destinationCrs()

◆ expressionContext()

◆ extent()

◆ flags()

◆ fullExtent()

◆ hasCrsTransformEnabled()

◆ hasValidSettings()

◆ layerExtentToOutputExtent()

◆ layers()

◆ layerStyleOverrides()

◆ layerToMapCoordinates() [1/2]

◆ layerToMapCoordinates() [2/2]

◆ layerToMapUnits()

◆ layerTransform()

◆ magnificationFactor()

◆ mapToLayerCoordinates() [1/2]

◆ mapToLayerCoordinates() [2/2]

◆ mapToPixel()

◆ mapUnits()

◆ mapUnitsPerPixel()

◆ outputDpi()

◆ outputExtentToLayerExtent()

◆ outputImageFormat()

◆ outputSize()

◆ readXML()

◆ rotation()

◆ scale()

◆ segmentationTolerance()

◆ segmentationToleranceType()

◆ selectionColor()

◆ setBackgroundColor()

◆ setCrsTransformEnabled()

◆ setCustomRenderFlags()

◆ setDestinationCrs()

◆ setExpressionContext()

◆ setExtent()

◆ setFlag()

◆ setFlags()

◆ setLayers()

◆ setLayerStyleOverrides()

◆ setMagnificationFactor()

◆ setMapUnits()

◆ setOutputDpi()

◆ setOutputImageFormat()

◆ setOutputSize()

◆ setRotation()

◆ setSegmentationTolerance()

◆ setSegmentationToleranceType()

◆ setSelectionColor()

◆ testFlag()

◆ updateDerived()

◆ visibleExtent()

◆ visiblePolygon()

◆ writeXML()

Member Data Documentation

◆ mBackgroundColor

◆ mCustomRenderFlags

◆ mDatumTransformStore

◆ mDestCRS

◆ mDpi

◆ mExpressionContext

◆ mExtent

◆ mFlags

◆ mImageFormat

◆ mLayers

◆ mLayerStyleOverrides