QGIS API Documentation
2.12.0-Lyon
|
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... | |
Enumerator | |
---|---|
Left | |
Middle | |
Right |
Definition at line 36 of file qgscomposerscalebar.h.
Composition atlas modes.
Enumerator | |
---|---|
AtlasOff | |
PreviewAtlas | |
ExportAtlas |
Definition at line 112 of file qgscomposition.h.
Row or column groups for cell styling.
Definition at line 132 of file qgscomposertablev2.h.
Enumerator | |
---|---|
ClipboardModeCut | |
ClipboardModeCopy |
Definition at line 74 of file qgscomposerview.h.
Data defined properties for different item types.
Definition at line 40 of file qgscomposerobject.h.
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.
Style to draw the snapping grid.
Enumerator | |
---|---|
Solid | |
Dots | |
Crosses |
Definition at line 88 of file qgscomposition.h.
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.
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.
Enumerator | |
---|---|
UpperLeft | |
UpperMiddle | |
UpperRight | |
MiddleLeft | |
Middle | |
MiddleRight | |
LowerLeft | |
LowerMiddle | |
LowerRight |
Definition at line 52 of file qgscomposermousehandles.h.
Enumerator | |
---|---|
UpperLeft | |
UpperMiddle | |
UpperRight | |
MiddleLeft | |
Middle | |
MiddleRight | |
LowerLeft | |
LowerMiddle | |
LowerRight |
Definition at line 80 of file qgscomposeritem.h.
Definition at line 44 of file qgscomposeritem.h.
Enumerator | |
---|---|
GroupItem | |
LayerItem | |
ClassificationItem |
Definition at line 46 of file qgslegendmodel.h.
Format of source image.
Enumerator | |
---|---|
SVG | |
RASTER | |
Unknown |
Definition at line 49 of file qgscomposerpicture.h.
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.
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.
Enumerator | |
---|---|
Portrait | |
Landscape |
Definition at line 101 of file qgscomposition.h.
Enumerator | |
---|---|
PasteModeCursor | |
PasteModeCenter | |
PasteModeInPlace |
Definition at line 80 of file qgscomposerview.h.
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.
Controls how pictures are scaled within the item's frame.
Definition at line 38 of file qgscomposerpicture.h.
Enumerator | |
---|---|
MapUnits | |
Meters | |
Feet | |
NauticalMiles |
Definition at line 43 of file qgscomposerscalebar.h.
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.
Enumerator | |
---|---|
Top | |
Bottom | |
Left | |
Right |
Definition at line 43 of file qgscomposerlegendstyle.h.
Enumerator | |
---|---|
Item | |
Point |
Definition at line 65 of file qgscomposermousehandles.h.
Enumerator | |
---|---|
Undefined | |
Hidden | |
Title | |
Group | |
Subgroup | |
Symbol | |
SymbolLabel |
Definition at line 33 of file qgscomposerlegendstyle.h.
Enumerator | |
---|---|
TicksUp | |
TicksDown | |
TicksMiddle |
Definition at line 28 of file qgsticksscalebarstyle.h.
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.
Enumerator | |
---|---|
Inactive | |
Active | |
ActiveUntilMouseRelease |
Definition at line 87 of file qgscomposerview.h.
Controls how long strings in the table are handled.
Definition at line 124 of file qgscomposertablev2.h.
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.
Enumerator | |
---|---|
ZValueBelow | |
ZValueAbove |
Definition at line 95 of file qgscomposition.h.