MapComposer

Classes
class	QgsAtlasComposition
	Class used to render an Atlas, iterating over geometry features. More...
class	QgsComposerItem
	A item that forms part of a map composition. More...
class	QgsComposerItemGroup
	A container for grouping several QgsComposerItems. More...
class	QgsComposerLabel
	A label that can be placed onto a map composition. More...
class	QgsComposerLegend
	A legend that can be placed onto a map composition. More...
class	QgsComposerLegendStyle
	Composer legend components style. More...
class	QgsComposerMap
	Object representing map window. More...
class	QgsComposerMapGrid
	An individual grid which is drawn above the map content in a QgsComposerMap. More...
class	QgsComposerMapGridStack
	A collection of grids which is drawn above the map content in a QgsComposerMap. More...
class	QgsComposerMapItem
	An item which is drawn inside a QgsComposerMap, eg a grid or map overview. More...
class	QgsComposerMapItemStack
	A collection of map items which are drawn above the map content in a QgsComposerMap. More...
class	QgsComposerMapOverview
	An individual overview which is drawn above the map content in a QgsComposerMap, and shows the extent of another QgsComposerMap. More...
class	QgsComposerMapOverviewStack
	A collection of overviews which are drawn above the map content in a QgsComposerMap. More...
class	QgsComposerModel
	A model for items attached to a composition. More...
class	QgsComposerMouseHandles
	Handles drawing of selection outlines and mouse handles. More...
class	QgsComposerObject
	A base class for objects which belong to a map composition. More...
class	QgsComposerPicture
	A composer class that displays svg files or raster format (jpg, png, ...) More...
class	QgsComposerScaleBar
	A scale bar item that can be added to a map composition. More...
class	QgsComposerTableStyle
	Styling option for a composer table cell. More...
class	QgsComposerTableV2
	A class to display a table in the print composer, and allow the table to span over multiple frames. More...
class	QgsComposerUtils
	Utilities for compositions. More...
class	QgsComposerView
	Widget to display the composer items. More...
class	QgsComposition
	Graphics scene for map printing. More...
class	QgsDoubleBoxScaleBarStyle
	Double box with alternating colors. More...
class	QgsLegendModel
	A model that provides group, layer and classification items. More...
class	QgsLegendModelV2
	Item model implementation based on layer tree model for composer legend. More...
class	QgsNumericScaleBarStyle
	A scale bar style that draws text in the form of '1:XXXXX'. More...
class	QgsScaleBarStyle
	Abstraction of composer scale bar style. More...
class	QgsSingleBoxScaleBarStyle
	Scalebar style that draws a single box with alternating color for the segments. More...
class	QgsTicksScaleBarStyle
	A scale bar that draws segments using short ticks. More...

Enumerations
enum	QgsComposerScaleBar::Alignment { QgsComposerScaleBar::Left = 0, QgsComposerScaleBar::Middle, QgsComposerScaleBar::Right }
enum	QgsComposition::AtlasMode { QgsComposition::AtlasOff, QgsComposition::PreviewAtlas, QgsComposition::ExportAtlas }
	Composition atlas modes. More...
enum	QgsComposerTableV2::CellStyleGroup {   QgsComposerTableV2::OddColumns, QgsComposerTableV2::EvenColumns, QgsComposerTableV2::OddRows, QgsComposerTableV2::EvenRows,   QgsComposerTableV2::FirstColumn, QgsComposerTableV2::LastColumn, QgsComposerTableV2::HeaderRow, QgsComposerTableV2::FirstRow,   QgsComposerTableV2::LastRow }
	Row or column groups for cell styling. More...
enum	QgsComposerView::ClipboardMode { QgsComposerView::ClipboardModeCut, QgsComposerView::ClipboardModeCopy }
enum	QgsComposerObject::DataDefinedProperty {   QgsComposerObject::NoProperty = 0, QgsComposerObject::AllProperties, QgsComposerObject::TestProperty, QgsComposerObject::PresetPaperSize,   QgsComposerObject::PaperWidth, QgsComposerObject::PaperHeight, QgsComposerObject::NumPages, QgsComposerObject::PaperOrientation,   QgsComposerObject::PageNumber, QgsComposerObject::PositionX, QgsComposerObject::PositionY, QgsComposerObject::ItemWidth,   QgsComposerObject::ItemHeight, QgsComposerObject::ItemRotation, QgsComposerObject::Transparency, QgsComposerObject::BlendMode,   QgsComposerObject::ExcludeFromExports, QgsComposerObject::MapRotation, QgsComposerObject::MapScale, QgsComposerObject::MapXMin,   QgsComposerObject::MapYMin, QgsComposerObject::MapXMax, QgsComposerObject::MapYMax, QgsComposerObject::MapAtlasMargin,   QgsComposerObject::MapLayers, QgsComposerObject::MapStylePreset, QgsComposerObject::PictureSource, QgsComposerObject::SourceUrl }
	Data defined properties for different item types. More...
enum	QgsComposerTableV2::EmptyTableMode { QgsComposerTableV2::HeadersOnly = 0, QgsComposerTableV2::HideTable, QgsComposerTableV2::ShowMessage }
	Controls how empty tables are displayed. More...
enum	QgsComposition::GridStyle { QgsComposition::Solid, QgsComposition::Dots, QgsComposition::Crosses }
	Style to draw the snapping grid. More...
enum	QgsComposerTableV2::HeaderHAlignment { QgsComposerTableV2::FollowColumn, QgsComposerTableV2::HeaderLeft, QgsComposerTableV2::HeaderCenter, QgsComposerTableV2::HeaderRight }
	Controls how headers are horizontally aligned in a table. More...
enum	QgsComposerTableV2::HeaderMode { QgsComposerTableV2::FirstFrame = 0, QgsComposerTableV2::AllFrames, QgsComposerTableV2::NoHeaders }
	Controls where headers are shown in the table. More...
enum	QgsComposerMouseHandles::ItemPositionMode {   QgsComposerMouseHandles::UpperLeft, QgsComposerMouseHandles::UpperMiddle, QgsComposerMouseHandles::UpperRight, QgsComposerMouseHandles::MiddleLeft,   QgsComposerMouseHandles::Middle, QgsComposerMouseHandles::MiddleRight, QgsComposerMouseHandles::LowerLeft, QgsComposerMouseHandles::LowerMiddle,   QgsComposerMouseHandles::LowerRight }
enum	QgsComposerItem::ItemPositionMode {   QgsComposerItem::UpperLeft, QgsComposerItem::UpperMiddle, QgsComposerItem::UpperRight, QgsComposerItem::MiddleLeft,   QgsComposerItem::Middle, QgsComposerItem::MiddleRight, QgsComposerItem::LowerLeft, QgsComposerItem::LowerMiddle,   QgsComposerItem::LowerRight }
enum	QgsComposerItem::ItemType {   QgsComposerItem::ComposerItem = UserType + 100, QgsComposerItem::ComposerArrow, QgsComposerItem::ComposerItemGroup, QgsComposerItem::ComposerLabel,   QgsComposerItem::ComposerLegend, QgsComposerItem::ComposerMap, QgsComposerItem::ComposerPaper, QgsComposerItem::ComposerPicture,   QgsComposerItem::ComposerScaleBar, QgsComposerItem::ComposerShape, QgsComposerItem::ComposerTable, QgsComposerItem::ComposerAttributeTable,   QgsComposerItem::ComposerTextTable, QgsComposerItem::ComposerFrame }
enum	QgsLegendModel::ItemType { QgsLegendModel::GroupItem = 0, QgsLegendModel::LayerItem, QgsLegendModel::ClassificationItem }
enum	QgsComposerPicture::Mode { QgsComposerPicture::SVG, QgsComposerPicture::RASTER, QgsComposerPicture::Unknown }
	Format of source image. More...
enum	QgsComposerMouseHandles::MouseAction {   QgsComposerMouseHandles::MoveItem, QgsComposerMouseHandles::ResizeUp, QgsComposerMouseHandles::ResizeDown, QgsComposerMouseHandles::ResizeLeft,   QgsComposerMouseHandles::ResizeRight, QgsComposerMouseHandles::ResizeLeftUp, QgsComposerMouseHandles::ResizeRightUp, QgsComposerMouseHandles::ResizeLeftDown,   QgsComposerMouseHandles::ResizeRightDown, QgsComposerMouseHandles::SelectItem, QgsComposerMouseHandles::NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...
enum	QgsComposerItem::MouseMoveAction {   QgsComposerItem::MoveItem, QgsComposerItem::ResizeUp, QgsComposerItem::ResizeDown, QgsComposerItem::ResizeLeft,   QgsComposerItem::ResizeRight, QgsComposerItem::ResizeLeftUp, QgsComposerItem::ResizeRightUp, QgsComposerItem::ResizeLeftDown,   QgsComposerItem::ResizeRightDown, QgsComposerItem::NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...
enum	QgsComposition::PaperOrientation { QgsComposition::Portrait, QgsComposition::Landscape }
enum	QgsComposerView::PasteMode { QgsComposerView::PasteModeCursor, QgsComposerView::PasteModeCenter, QgsComposerView::PasteModeInPlace }
enum	QgsComposition::PlotStyle { QgsComposition::Preview = 0, QgsComposition::Print, QgsComposition::Postscript }
	Plot type. More...
enum	QgsComposerObject::PropertyValueType { QgsComposerObject::EvaluatedValue = 0, QgsComposerObject::OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...
enum	QgsComposerPicture::ResizeMode {   QgsComposerPicture::Zoom, QgsComposerPicture::Stretch, QgsComposerPicture::Clip, QgsComposerPicture::ZoomResizeFrame,   QgsComposerPicture::FrameToImageSize }
	Controls how pictures are scaled within the item's frame. More...
enum	QgsComposerScaleBar::ScaleBarUnits { QgsComposerScaleBar::MapUnits = 0, QgsComposerScaleBar::Meters, QgsComposerScaleBar::Feet, QgsComposerScaleBar::NauticalMiles }
enum	QgsComposerScaleBar::SegmentSizeMode { QgsComposerScaleBar::SegmentSizeFixed = 0, QgsComposerScaleBar::SegmentSizeFitWidth = 1 }
	Modes for setting size for scale bar segments. More...
enum	QgsComposerLegendStyle::Side { QgsComposerLegendStyle::Top = 0, QgsComposerLegendStyle::Bottom = 1, QgsComposerLegendStyle::Left = 2, QgsComposerLegendStyle::Right = 3 }
enum	QgsComposerMouseHandles::SnapGuideMode { QgsComposerMouseHandles::Item, QgsComposerMouseHandles::Point }
enum	QgsComposerLegendStyle::Style {   QgsComposerLegendStyle::Undefined, QgsComposerLegendStyle::Hidden, QgsComposerLegendStyle::Title, QgsComposerLegendStyle::Group,   QgsComposerLegendStyle::Subgroup, QgsComposerLegendStyle::Symbol, QgsComposerLegendStyle::SymbolLabel }
enum	QgsTicksScaleBarStyle::TickPosition { QgsTicksScaleBarStyle::TicksUp, QgsTicksScaleBarStyle::TicksDown, QgsTicksScaleBarStyle::TicksMiddle }
enum	QgsComposerView::Tool {   QgsComposerView::Select = 0, QgsComposerView::AddArrow, QgsComposerView::AddHtml, QgsComposerView::AddMap,   QgsComposerView::AddLegend, QgsComposerView::AddLabel, QgsComposerView::AddScalebar, QgsComposerView::AddPicture,   QgsComposerView::AddRectangle, QgsComposerView::AddEllipse, QgsComposerView::AddTriangle, QgsComposerView::AddTable,   QgsComposerView::AddAttributeTable, QgsComposerView::MoveItemContent, QgsComposerView::Pan, QgsComposerView::Zoom }
	Current tool. More...
enum	QgsComposerView::ToolStatus { QgsComposerView::Inactive, QgsComposerView::Active, QgsComposerView::ActiveUntilMouseRelease }
enum	QgsComposerTableV2::WrapBehaviour { QgsComposerTableV2::TruncateText = 0, QgsComposerTableV2::WrapText }
	Controls how long strings in the table are handled. More...
enum	QgsComposerItem::ZoomMode { QgsComposerItem::Zoom = 0, QgsComposerItem::ZoomRecenter, QgsComposerItem::ZoomToPoint, QgsComposerItem::NoZoom }
	Modes for zooming item content. More...
enum	QgsComposition::ZValueDirection { QgsComposition::ZValueBelow, QgsComposition::ZValueAbove }

Detailed Description

Enumeration Type Documentation

enum QgsComposerScaleBar::Alignment

Enumerator
Left
Middle
Right

Definition at line 36 of file qgscomposerscalebar.h.

enum QgsComposition::AtlasMode

Composition atlas modes.

Enumerator
AtlasOff
PreviewAtlas
ExportAtlas

Definition at line 112 of file qgscomposition.h.

enum QgsComposerTableV2::CellStyleGroup

Row or column groups for cell styling.

Enumerator
OddColumns	Style odd numbered columns
EvenColumns	Style even numbered columns
OddRows	Style odd numbered rows
EvenRows	Style even numbered rows
FirstColumn	Style first column only
LastColumn	Style last column only
HeaderRow	Style header row
FirstRow	Style first row only
LastRow	Style last row only

Definition at line 132 of file qgscomposertablev2.h.

enum QgsComposerView::ClipboardMode

Enumerator
ClipboardModeCut
ClipboardModeCopy

Definition at line 74 of file qgscomposerview.h.

enum QgsComposerObject::DataDefinedProperty

Data defined properties for different item types.

Enumerator
NoProperty	no property
AllProperties	all properties for item
TestProperty	dummy property with no effect on item
PresetPaperSize	preset paper size for composition
PaperWidth	paper width
PaperHeight	paper height
NumPages	number of pages in composition
PaperOrientation	paper orientation
PageNumber	page number for item placement
PositionX	x position on page
PositionY	y position on page
ItemWidth	width of item
ItemHeight	height of item
ItemRotation	rotation of item
Transparency	item transparency
BlendMode	item blend mode
ExcludeFromExports	exclude item from exports
MapRotation	map rotation
MapScale	map scale
MapXMin	map extent x minimum
MapYMin	map extent y minimum
MapXMax	map extent x maximum
MapYMax	map extent y maximum
MapAtlasMargin	map atlas margin
MapLayers	map layer set
MapStylePreset	layer and style visibility preset
PictureSource	picture source url
SourceUrl	html source url

Definition at line 40 of file qgscomposerobject.h.

enum QgsComposerTableV2::EmptyTableMode

Controls how empty tables are displayed.

Enumerator
HeadersOnly	show header rows only
HideTable	hides entire table if empty
ShowMessage	shows preset message instead of table contents

Definition at line 115 of file qgscomposertablev2.h.

enum QgsComposition::GridStyle

Style to draw the snapping grid.

Enumerator
Solid
Dots
Crosses

Definition at line 88 of file qgscomposition.h.

enum QgsComposerTableV2::HeaderHAlignment

Controls how headers are horizontally aligned in a table.

Enumerator
FollowColumn	header uses the same alignment as the column
HeaderLeft	align headers left
HeaderCenter	align headers to center
HeaderRight	align headers right

Definition at line 96 of file qgscomposertablev2.h.

enum QgsComposerTableV2::HeaderMode

Controls where headers are shown in the table.

Enumerator
FirstFrame	header shown on first frame only
AllFrames	headers shown on all frames
NoHeaders	no headers shown for table

Definition at line 106 of file qgscomposertablev2.h.

enum QgsComposerMouseHandles::ItemPositionMode

Enumerator
UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 52 of file qgscomposermousehandles.h.

enum QgsComposerItem::ItemPositionMode

Enumerator
UpperLeft
UpperMiddle
UpperRight
MiddleLeft
Middle
MiddleRight
LowerLeft
LowerMiddle
LowerRight

Definition at line 80 of file qgscomposeritem.h.

enum QgsComposerItem::ItemType

Enumerator
ComposerItem
ComposerArrow
ComposerItemGroup
ComposerLabel
ComposerLegend
ComposerMap
ComposerPaper
ComposerPicture
ComposerScaleBar
ComposerShape
ComposerTable
ComposerAttributeTable
ComposerTextTable
ComposerFrame

Definition at line 44 of file qgscomposeritem.h.

enum QgsLegendModel::ItemType

Enumerator
GroupItem
LayerItem
ClassificationItem

Definition at line 46 of file qgslegendmodel.h.

enum QgsComposerPicture::Mode

Format of source image.

Enumerator
SVG
RASTER
Unknown

Definition at line 49 of file qgscomposerpicture.h.

enum QgsComposerMouseHandles::MouseAction

Describes the action (move or resize in different directon) to be done during mouse move.

Enumerator
MoveItem
ResizeUp
ResizeDown
ResizeLeft
ResizeRight
ResizeLeftUp
ResizeRightUp
ResizeLeftDown
ResizeRightDown
SelectItem
NoAction

Definition at line 37 of file qgscomposermousehandles.h.

enum QgsComposerItem::MouseMoveAction

Describes the action (move or resize in different directon) to be done during mouse move.

Enumerator
MoveItem
ResizeUp
ResizeDown
ResizeLeft
ResizeRight
ResizeLeftUp
ResizeRightUp
ResizeLeftDown
ResizeRightDown
NoAction

Definition at line 66 of file qgscomposeritem.h.

enum QgsComposition::PaperOrientation

Enumerator
Portrait
Landscape

Definition at line 101 of file qgscomposition.h.

enum QgsComposerView::PasteMode

Enumerator
PasteModeCursor
PasteModeCenter
PasteModeInPlace

Definition at line 80 of file qgscomposerview.h.

enum QgsComposition::PlotStyle

Plot type.

Enumerator
Preview
Print
Postscript

Definition at line 80 of file qgscomposition.h.

enum QgsComposerObject::PropertyValueType

Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property.

This may differ if a property has a data defined expression active.

Enumerator
EvaluatedValue	return the current evaluated value for the property
OriginalValue	return the original, user set value

Definition at line 81 of file qgscomposerobject.h.

enum QgsComposerPicture::ResizeMode

Controls how pictures are scaled within the item's frame.

Enumerator
Zoom	enlarges image to fit frame while maintaining aspect ratio of picture
Stretch	stretches image to fit frame, ignores aspect ratio
Clip	draws image at original size and clips any portion which falls outside frame
ZoomResizeFrame	enlarges image to fit frame, then resizes frame to fit resultant image
FrameToImageSize	sets size of frame to match original size of image without scaling

Definition at line 38 of file qgscomposerpicture.h.

enum QgsComposerScaleBar::ScaleBarUnits

Enumerator
MapUnits
Meters
Feet
NauticalMiles

Definition at line 43 of file qgscomposerscalebar.h.

enum QgsComposerScaleBar::SegmentSizeMode

Modes for setting size for scale bar segments.

Enumerator
SegmentSizeFixed	Scale bar segment size is fixed to a map unit
SegmentSizeFitWidth	Scale bar segment size is calculated to fit a size range

Definition at line 53 of file qgscomposerscalebar.h.

enum QgsComposerLegendStyle::Side

Enumerator
Top
Bottom
Left
Right

Definition at line 43 of file qgscomposerlegendstyle.h.

enum QgsComposerMouseHandles::SnapGuideMode

Enumerator
Item
Point

Definition at line 65 of file qgscomposermousehandles.h.

enum QgsComposerLegendStyle::Style

Enumerator
Undefined
Hidden
Title
Group
Subgroup
Symbol
SymbolLabel

Definition at line 33 of file qgscomposerlegendstyle.h.

enum QgsTicksScaleBarStyle::TickPosition

Enumerator
TicksUp
TicksDown
TicksMiddle

Definition at line 28 of file qgsticksscalebarstyle.h.

enum QgsComposerView::Tool

Current tool.

Enumerator
Select
AddArrow
AddHtml
AddMap
AddLegend
AddLabel
AddScalebar
AddPicture
AddRectangle
AddEllipse
AddTriangle
AddTable
AddAttributeTable
MoveItemContent
Pan
Zoom

Definition at line 54 of file qgscomposerview.h.

enum QgsComposerView::ToolStatus

Enumerator
Inactive
Active
ActiveUntilMouseRelease

Definition at line 87 of file qgscomposerview.h.

enum QgsComposerTableV2::WrapBehaviour

Controls how long strings in the table are handled.

Enumerator
TruncateText	text which doesn't fit inside the cell is truncated
WrapText	text which doesn't fit inside the cell is wrapped. Note that this only applies to text in columns with a fixed width.

Definition at line 124 of file qgscomposertablev2.h.

enum QgsComposerItem::ZoomMode

Modes for zooming item content.

Enumerator
Zoom	Zoom to center of content
ZoomRecenter	Zoom and recenter content to point
ZoomToPoint	Zoom while maintaining relative position of point
NoZoom	No zoom

Definition at line 97 of file qgscomposeritem.h.

enum QgsComposition::ZValueDirection

Enumerator
ZValueBelow
ZValueAbove

Definition at line 95 of file qgscomposition.h.