Class: QgsDiagramLayerSettings¶
- class qgis.core.QgsDiagramLayerSettings¶
Bases:
sip.wrapper
Stores the settings for rendering of all diagrams for a layer.
QgsDiagramSettings
stores the settings related to rendering the individual diagrams themselves, whileQgsDiagramLayerSettings
stores settings which control how ALL diagrams within a layer are rendered.QgsDiagramLayerSettings() Constructor for QgsDiagramLayerSettings.
QgsDiagramLayerSettings(rh:
QgsDiagramLayerSettings
) Copy constructorMethods
Returns the coordinate transform associated with the layer, or an invalid transform if no transformation is required.
Returns a reference to the diagram's property collection, used for data defined overrides.
Returns the distance between the diagram and the feature (in mm).
Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
Returns the diagram placement flags.
Returns the diagram placement.
Prepares the diagrams for a specified expression context.
Returns the diagram priority.
Returns the diagram property definitions.
Reads the diagram settings from a DOM element.
Returns the set of any fields referenced by the layer's diagrams.
Returns the diagram renderer associated with the layer.
Sets the coordinate transform associated with the layer.
Sets the diagram's property collection, used for data defined overrides.
Sets the distance between the diagram and the feature.
Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
Sets the the diagram placement flags.
Sets the diagram placement.
Sets the diagram priority.
Sets the diagram renderer associated with the layer.
Sets whether the layer should show all diagrams, including overlapping diagrams
Sets the diagram z-index.
Returns whether the layer should show all diagrams, including overlapping diagrams
Writes the diagram settings to a DOM element.
Returns the diagram z-index.
Attributes
- AboveLine = 2¶
- AlwaysShow = 10¶
- AroundPoint = 0¶
- BackgroundColor = 0¶
- BelowLine = 4¶
- Curved = 3¶
- Distance = 5¶
- Free = 5¶
- Horizontal = 4¶
- IsObstacle = 8¶
- Line = 2¶
- class LinePlacementFlag¶
Bases:
int
- class LinePlacementFlags¶
- class LinePlacementFlags(Union[QgsDiagramLayerSettings.LinePlacementFlags, QgsDiagramLayerSettings.LinePlacementFlag])
- class LinePlacementFlags(QgsDiagramLayerSettings.LinePlacementFlags)
Bases:
sip.wrapper
- MapOrientation = 16¶
- OnLine = 1¶
- OverPoint = 1¶
- class Placement¶
Bases:
int
- PositionX = 3¶
- PositionY = 4¶
- Priority = 6¶
- class Property¶
Bases:
int
- Show = 9¶
- StartAngle = 11¶
- StrokeColor = 1¶
- StrokeWidth = 2¶
- ZIndex = 7¶
- coordinateTransform(self) QgsCoordinateTransform ¶
Returns the coordinate transform associated with the layer, or an invalid transform if no transformation is required.
See also
New in version 2.16.
- Return type:
- dataDefinedProperties(self) QgsPropertyCollection ¶
Returns a reference to the diagram’s property collection, used for data defined overrides.
See also
New in version 3.0.
- Return type:
- distance(self) float ¶
Returns the distance between the diagram and the feature (in mm).
See also
New in version 2.16.
- Return type:
float
- isObstacle(self) bool ¶
Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
See also
New in version 2.16.
- Return type:
bool
- linePlacementFlags(self) QgsDiagramLayerSettings.LinePlacementFlags ¶
Returns the diagram placement flags. These are only used if the diagram placement is set to a line type.
See also
New in version 2.16.
- Return type:
- placement(self) QgsDiagramLayerSettings.Placement ¶
Returns the diagram placement.
See also
New in version 2.16.
- Return type:
- prepare(self, context: QgsExpressionContext = QgsExpressionContext()) bool ¶
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.New in version 3.0.
- Parameters:
context (
QgsExpressionContext
= QgsExpressionContext()) –- Return type:
bool
- priority(self) int ¶
Returns the diagram priority.
- Return type:
int
- Returns:
diagram priority, where 0 = low and 10 = high
Note
placement priority is shared with labeling, so diagrams with a high priority may displace labels and vice-versa
See also
New in version 2.16.
- propertyDefinitions() Dict[int, QgsPropertyDefinition] ¶
Returns the diagram property definitions.
New in version 3.0.
- Return type:
Dict[int, QgsPropertyDefinition]
- readXml(self, elem: QDomElement)¶
Reads the diagram settings from a DOM element.
See also
- Parameters:
elem (QDomElement) –
- referencedFields(self, context: QgsExpressionContext = QgsExpressionContext()) Set[str] ¶
Returns the set of any fields referenced by the layer’s diagrams.
- Parameters:
context (
QgsExpressionContext
= QgsExpressionContext()) – expression context the diagrams will be drawn using
New in version 2.16.
- Return type:
Set[str]
- renderer(self) QgsDiagramRenderer ¶
Returns the diagram renderer associated with the layer.
See also
New in version 2.16.
- Return type:
- setCoordinateTransform(self, transform: QgsCoordinateTransform)¶
Sets the coordinate transform associated with the layer.
- Parameters:
transform (QgsCoordinateTransform) – coordinate transform. Ownership is transferred to the object.
See also
New in version 2.16.
- setDataDefinedProperties(self, collection: QgsPropertyCollection)¶
Sets the diagram’s property collection, used for data defined overrides.
- Parameters:
collection (QgsPropertyCollection) – property collection. Existing properties will be replaced.
See also
See also
Property
New in version 3.0.
- setDistance(self, distance: float)¶
Sets the distance between the diagram and the feature.
- Parameters:
distance (float) – distance in mm
See also
New in version 2.16.
- setIsObstacle(self, isObstacle: bool)¶
Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
- Parameters:
isObstacle (bool) – set to
True
for feature to act as obstacle
See also
New in version 2.16.
- setLinePlacementFlags(self, flags: QgsDiagramLayerSettings.LinePlacementFlags | QgsDiagramLayerSettings.LinePlacementFlag)¶
Sets the the diagram placement flags. These are only used if the diagram placement is set to a line type.
- Parameters:
flags (Union[QgsDiagramLayerSettings.LinePlacementFlags) – placement value
See also
New in version 2.16.
- setPlacement(self, value: QgsDiagramLayerSettings.Placement)¶
Sets the diagram placement.
- Parameters:
value (QgsDiagramLayerSettings.Placement) – placement value
See also
New in version 2.16.
- setPriority(self, value: int)¶
Sets the diagram priority.
- Parameters:
value (int) – priority, where 0 = low and 10 = high
See also
New in version 2.16.
- setRenderer(self, diagramRenderer: QgsDiagramRenderer)¶
Sets the diagram renderer associated with the layer.
- Parameters:
diagramRenderer (QgsDiagramRenderer) – diagram renderer. Ownership is transferred to the object.
See also
New in version 2.16.
- setShowAllDiagrams(self, showAllDiagrams: bool)¶
Sets whether the layer should show all diagrams, including overlapping diagrams
- Parameters:
showAllDiagrams (bool) – set to
True
to show all diagrams
See also
New in version 2.16.
- setZIndex(self, index: float)¶
Sets the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams with a lower z-index.
- Parameters:
index (float) – diagram z-index
See also
New in version 2.16.
- showAllDiagrams(self) bool ¶
Returns whether the layer should show all diagrams, including overlapping diagrams
See also
New in version 2.16.
- Return type:
bool
- writeXml(self, layerElem: QDomElement, doc: QDomDocument)¶
Writes the diagram settings to a DOM element.
See also
- Parameters:
layerElem (QDomElement) –
doc (QDomDocument) –
- zIndex(self) float ¶
Returns the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams with a lower z-index.
Note
z-index ordering is shared with labeling, so diagrams with a high z-index may be drawn over labels with a low z-index and vice-versa
See also
New in version 2.16.
- Return type:
float