QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Stores the settings for rendering of all diagrams for a layer. More...
#include <qgsdiagramrenderer.h>
Public Types | |
enum | LinePlacementFlag { OnLine = 1 , AboveLine = 1 << 1 , BelowLine = 1 << 2 , MapOrientation = 1 << 4 } |
Line placement flags for controlling line based placements. More... | |
enum | Placement { AroundPoint = 0 , OverPoint , Line , Curved , Horizontal , Free } |
enum | Property { BackgroundColor , StrokeColor , StrokeWidth , PositionX , PositionY , Distance , Priority , ZIndex , IsObstacle , Show , AlwaysShow , StartAngle } |
Data definable properties. More... | |
Public Member Functions | |
QgsDiagramLayerSettings () | |
Constructor for QgsDiagramLayerSettings. More... | |
QgsDiagramLayerSettings (const QgsDiagramLayerSettings &rh) | |
Copy constructor. More... | |
~QgsDiagramLayerSettings () | |
QgsCoordinateTransform | coordinateTransform () const |
Returns the coordinate transform associated with the layer, or an invalid transform if no transformation is required. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the diagram's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the diagram's property collection, used for data defined overrides. More... | |
double | distance () const |
Returns the distance between the diagram and the feature (in mm). More... | |
bool | isObstacle () const |
Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. More... | |
LinePlacementFlags | linePlacementFlags () const |
Returns the diagram placement flags. More... | |
QgsDiagramLayerSettings & | operator= (const QgsDiagramLayerSettings &rh) |
Placement | placement () const |
Returns the diagram placement. More... | |
bool | prepare (const QgsExpressionContext &context=QgsExpressionContext()) const |
Prepares the diagrams for a specified expression context. More... | |
int | priority () const |
Returns the diagram priority. More... | |
void | readXml (const QDomElement &elem) |
Reads the diagram settings from a DOM element. More... | |
QSet< QString > | referencedFields (const QgsExpressionContext &context=QgsExpressionContext()) const |
Returns the set of any fields referenced by the layer's diagrams. More... | |
QgsDiagramRenderer * | renderer () |
Returns the diagram renderer associated with the layer. More... | |
const QgsDiagramRenderer * | renderer () const |
Returns the diagram renderer associated with the layer. More... | |
void | setCoordinateTransform (const QgsCoordinateTransform &transform) |
Sets the coordinate transform associated with the layer. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the diagram's property collection, used for data defined overrides. More... | |
void | setDistance (double distance) |
Sets the distance between the diagram and the feature. More... | |
void | setIsObstacle (bool isObstacle) |
Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams. More... | |
void | setLinePlacementFlags (LinePlacementFlags flags) |
Sets the the diagram placement flags. More... | |
void | setPlacement (Placement value) |
Sets the diagram placement. More... | |
void | setPriority (int value) |
Sets the diagram priority. More... | |
void | setRenderer (QgsDiagramRenderer *diagramRenderer) |
Sets the diagram renderer associated with the layer. More... | |
void | setShowAllDiagrams (bool showAllDiagrams) |
Sets whether the layer should show all diagrams, including overlapping diagrams. More... | |
void | setZIndex (double index) |
Sets the diagram z-index. More... | |
bool | showAllDiagrams () const |
Returns whether the layer should show all diagrams, including overlapping diagrams. More... | |
void | writeXml (QDomElement &layerElem, QDomDocument &doc) const |
Writes the diagram settings to a DOM element. More... | |
double | zIndex () const |
Returns the diagram z-index. More... | |
Static Public Member Functions | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the diagram property definitions. More... | |
Stores the settings for rendering of all diagrams for a layer.
QgsDiagramSettings stores the settings related to rendering the individual diagrams themselves, while QgsDiagramLayerSettings stores settings which control how ALL diagrams within a layer are rendered.
Definition at line 61 of file qgsdiagramrenderer.h.
Line placement flags for controlling line based placements.
Enumerator | |
---|---|
OnLine | |
AboveLine | |
BelowLine | |
MapOrientation |
Definition at line 77 of file qgsdiagramrenderer.h.
Enumerator | |
---|---|
AroundPoint | |
OverPoint | |
Line | |
Curved | |
Horizontal | |
Free |
Definition at line 66 of file qgsdiagramrenderer.h.
Data definable properties.
Definition at line 90 of file qgsdiagramrenderer.h.
QgsDiagramLayerSettings::QgsDiagramLayerSettings | ( | ) |
Constructor for QgsDiagramLayerSettings.
Definition at line 68 of file qgsdiagramrenderer.cpp.
QgsDiagramLayerSettings::QgsDiagramLayerSettings | ( | const QgsDiagramLayerSettings & | rh | ) |
Copy constructor.
Definition at line 73 of file qgsdiagramrenderer.cpp.
QgsDiagramLayerSettings::~QgsDiagramLayerSettings | ( | ) |
Definition at line 103 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the coordinate transform associated with the layer, or an invalid transform if no transformation is required.
Definition at line 252 of file qgsdiagramrenderer.h.
|
inline |
Returns a reference to the diagram's property collection, used for data defined overrides.
Definition at line 309 of file qgsdiagramrenderer.h.
|
inline |
Returns a reference to the diagram's property collection, used for data defined overrides.
Definition at line 318 of file qgsdiagramrenderer.h.
|
inline |
Returns the distance between the diagram and the feature (in mm).
Definition at line 213 of file qgsdiagramrenderer.h.
|
inline |
Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
Definition at line 198 of file qgsdiagramrenderer.h.
|
inline |
Returns the diagram placement flags.
These are only used if the diagram placement is set to a line type.
Definition at line 145 of file qgsdiagramrenderer.h.
QgsDiagramLayerSettings & QgsDiagramLayerSettings::operator= | ( | const QgsDiagramLayerSettings & | rh | ) |
Definition at line 88 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the diagram placement.
Definition at line 129 of file qgsdiagramrenderer.h.
bool QgsDiagramLayerSettings::prepare | ( | const QgsExpressionContext & | context = QgsExpressionContext() | ) | const |
Prepares the diagrams for a specified expression context.
Calling prepare before rendering multiple diagrams allows precalculation of expensive setup tasks such as parsing expressions. Returns true
if preparation was successful.
Definition at line 159 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the diagram priority.
Definition at line 164 of file qgsdiagramrenderer.h.
|
static |
Returns the diagram property definitions.
Definition at line 62 of file qgsdiagramrenderer.cpp.
void QgsDiagramLayerSettings::readXml | ( | const QDomElement & | elem | ) |
Reads the diagram settings from a DOM element.
Definition at line 122 of file qgsdiagramrenderer.cpp.
QSet< QString > QgsDiagramLayerSettings::referencedFields | ( | const QgsExpressionContext & | context = QgsExpressionContext() | ) | const |
Returns the set of any fields referenced by the layer's diagrams.
context | expression context the diagrams will be drawn using |
Definition at line 164 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the diagram renderer associated with the layer.
Definition at line 228 of file qgsdiagramrenderer.h.
|
inline |
Returns the diagram renderer associated with the layer.
Definition at line 236 of file qgsdiagramrenderer.h.
void QgsDiagramLayerSettings::setCoordinateTransform | ( | const QgsCoordinateTransform & | transform | ) |
Sets the coordinate transform associated with the layer.
transform | coordinate transform. Ownership is transferred to the object. |
Definition at line 117 of file qgsdiagramrenderer.cpp.
|
inline |
Sets the diagram's property collection, used for data defined overrides.
collection | property collection. Existing properties will be replaced. |
Definition at line 327 of file qgsdiagramrenderer.h.
|
inline |
Sets the distance between the diagram and the feature.
distance | distance in mm |
Definition at line 221 of file qgsdiagramrenderer.h.
|
inline |
Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
isObstacle | set to true for feature to act as obstacle |
Definition at line 206 of file qgsdiagramrenderer.h.
|
inline |
Sets the the diagram placement flags.
These are only used if the diagram placement is set to a line type.
flags | placement value |
Definition at line 154 of file qgsdiagramrenderer.h.
|
inline |
Sets the diagram placement.
value | placement value |
Definition at line 137 of file qgsdiagramrenderer.h.
|
inline |
Sets the diagram priority.
value | priority, where 0 = low and 10 = high |
Definition at line 172 of file qgsdiagramrenderer.h.
void QgsDiagramLayerSettings::setRenderer | ( | QgsDiagramRenderer * | diagramRenderer | ) |
Sets the diagram renderer associated with the layer.
diagramRenderer | diagram renderer. Ownership is transferred to the object. |
Definition at line 108 of file qgsdiagramrenderer.cpp.
|
inline |
Sets whether the layer should show all diagrams, including overlapping diagrams.
showAllDiagrams | set to true to show all diagrams |
Definition at line 275 of file qgsdiagramrenderer.h.
|
inline |
Sets the diagram z-index.
Diagrams (or labels) with a higher z-index are drawn over diagrams with a lower z-index.
index | diagram z-index |
Definition at line 191 of file qgsdiagramrenderer.h.
|
inline |
Returns whether the layer should show all diagrams, including overlapping diagrams.
Definition at line 267 of file qgsdiagramrenderer.h.
void QgsDiagramLayerSettings::writeXml | ( | QDomElement & | layerElem, |
QDomDocument & | doc | ||
) | const |
Writes the diagram settings to a DOM element.
Definition at line 143 of file qgsdiagramrenderer.cpp.
|
inline |
Returns the diagram z-index.
Diagrams (or labels) with a higher z-index are drawn over diagrams with a lower z-index.
Definition at line 182 of file qgsdiagramrenderer.h.