Class: QgsManhattanLineCallout¶
- class qgis.core.QgsManhattanLineCallout¶
Bases:
QgsSimpleLineCallout
Draws straight (right angled) lines as callouts.
Added in version 3.10:
Methods
Returns the anchor point geometry for a label with the given bounding box and
anchor
point mode.Calculates the direct line from a label geometry to an anchor geometry part, respecting the various callout settings which influence how the callout end should be placed in the anchor geometry.
- rtype:
QgsManhattanLineCallout
Creates a new
QgsManhattanLineCallout
, using the settings serialized in theproperties
map (corresponding to the output fromQgsManhattanLineCallout.properties()
).- param start:
Returns the anchor point geometry for a label with the given bounding box and
anchor
point mode.- rtype:
str
- calloutLabelPoint(self, bodyBoundingBox: QRectF, angle: float, anchor: QgsCallout.LabelAnchorPoint, context: QgsRenderContext, calloutContext: QgsCallout.QgsCalloutContext) Tuple[QgsGeometry, bool] ¶
Returns the anchor point geometry for a label with the given bounding box and
anchor
point mode.The
pinned
argument will be set toTrue
if the callout label point is pinned (manually placed).Added in version 3.20.
- calloutLineToPart(self, labelGeometry: QgsGeometry, partGeometry: QgsAbstractGeometry, context: QgsRenderContext, calloutContext: QgsCallout.QgsCalloutContext) Tuple[QgsGeometry, bool] ¶
Calculates the direct line from a label geometry to an anchor geometry part, respecting the various callout settings which influence how the callout end should be placed in the anchor geometry.
Returns a null geometry if the callout line cannot be calculated.
The
pinned
argument will be set toTrue
if the callout anchor point is pinned (manually placed).Added in version 3.20.
- clone(self) QgsManhattanLineCallout ¶
- Return type:
- create(properties: Dict[str, Any] = {}, context: QgsReadWriteContext = QgsReadWriteContext()) QgsCallout ¶
Creates a new
QgsManhattanLineCallout
, using the settings serialized in theproperties
map (corresponding to the output fromQgsManhattanLineCallout.properties()
).- Parameters:
properties (Dict[str)
context (
QgsReadWriteContext
= QgsReadWriteContext())
- Return type:
- createCalloutLine(self, start: QgsPoint, end: QgsPoint, context: QgsRenderContext, bodyBoundingBox: QRectF, angle: float, anchor: QgsGeometry, calloutContext: QgsCallout.QgsCalloutContext) QgsCurve ¶
- Parameters:
start (QgsPoint)
end (QgsPoint)
context (QgsRenderContext)
bodyBoundingBox (QRectF)
angle (float)
anchor (QgsGeometry)
calloutContext (QgsCallout.QgsCalloutContext)
- Return type:
- draw(self, context: QgsRenderContext, bodyBoundingBox: QRectF, angle: float, anchor: QgsGeometry, calloutContext: QgsCallout.QgsCalloutContext)¶
- labelAnchorGeometry(self, bodyBoundingBox: QRectF, angle: float, anchor: QgsCallout.LabelAnchorPoint) QgsGeometry ¶
Returns the anchor point geometry for a label with the given bounding box and
anchor
point mode.Deprecated since version QGIS: 3.20 use
calloutLabelPoint()
instead
- type(self) str ¶
- Return type:
str