Class: QgsSimpleLineCallout

A simple direct line callout style.

Added in version 3.10.

Class Hierarchy

Base classes

QgsCallout

Abstract base class for callout renderers.

Subclasses

QgsCurvedLineCallout	Draws curved lines as callouts.
QgsManhattanLineCallout	Draws straight (right angled) lines as callouts.

class qgis.core.QgsSimpleLineCallout

Bases: QgsCallout

static create(properties: Dict[str, Any] = {}, context: QgsReadWriteContext = QgsReadWriteContext()) → QgsCallout | None

Creates a new QgsSimpleLineCallout, using the settings serialized in the properties map (corresponding to the output from QgsSimpleLineCallout.properties() ).

Parameters:

• properties (Dict[str, Any] = {})

• context (QgsReadWriteContext = QgsReadWriteContext())

Return type:

Optional[QgsCallout]

virtual createCalloutLine(self, start: QgsPoint, end: QgsPoint, context: QgsRenderContext, bodyBoundingBox: QRectF, angle: float, anchor: QgsGeometry, calloutContext: QgsCallout.QgsCalloutContext) → QgsCurve | None

Creates a callout line between start and end in the desired style.

The base class method returns a straight line.

Added in version 3.20.

Parameters:

• start (QgsPoint)

• end (QgsPoint)

• context (QgsRenderContext)

• bodyBoundingBox (QRectF)

• angle (float)

• anchor (QgsGeometry)

• calloutContext (QgsCallout.QgsCalloutContext)

Return type:

Optional[QgsCurve]

drawCalloutToAllParts(self) → bool

Returns True if callout lines should be drawn to all feature parts.

See also

setDrawCalloutToAllParts()

Return type:

bool

lineSymbol(self) → QgsLineSymbol | None

Returns the line symbol used to render the callout line.

Ownership is not transferred.

See also

setLineSymbol()

Return type:

Optional[QgsLineSymbol]

minimumLength(self) → float

Returns the minimum length of callout lines. Units are specified through minimumLengthUnits().

See also

setMinimumLength()

See also

minimumLengthUnit()

Return type:

float

minimumLengthMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the minimum callout length.

See also

setMinimumLengthMapUnitScale()

See also

minimumLengthUnit()

See also

minimumLength()

Return type:

QgsMapUnitScale

minimumLengthUnit(self) → Qgis.RenderUnit

Returns the units for the minimum length of callout lines.

See also

setMinimumLengthUnit()

See also

minimumLength()

Return type:

Qgis.RenderUnit

offsetFromAnchor(self) → float

Returns the offset distance from the anchor point at which to start the line. Units are specified through offsetFromAnchorUnit().

See also

setOffsetFromAnchor()

See also

offsetFromAnchorUnit()

Return type:

float

offsetFromAnchorMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the offset from anchor.

See also

setOffsetFromAnchorMapUnitScale()

See also

offsetFromAnchorUnit()

See also

offsetFromAnchor()

Return type:

QgsMapUnitScale

offsetFromAnchorUnit(self) → Qgis.RenderUnit

Returns the units for the offset from anchor point.

See also

setOffsetFromAnchorUnit()

See also

offsetFromAnchor()

Return type:

Qgis.RenderUnit

offsetFromLabel(self) → float

Returns the offset distance from label area at which to end the line. Units are specified through offsetFromLabelUnit().

See also

setOffsetFromLabel()

See also

offsetFromLabelUnit()

Return type:

float

offsetFromLabelMapUnitScale(self) → QgsMapUnitScale

Returns the map unit scale for the minimum callout length.

See also

setOffsetFromLabelMapUnitScale()

See also

offsetFromLabelUnit()

See also

offsetFromLabel()

Return type:

QgsMapUnitScale

offsetFromLabelUnit(self) → Qgis.RenderUnit

Returns the units for the offset from label area.

See also

setOffsetFromLabelUnit()

See also

offsetFromLabel()

Return type:

Qgis.RenderUnit

setDrawCalloutToAllParts(self, drawToAllParts: bool)

Sets whether callout lines should be drawn to all feature parts.

See also

drawCalloutToAllParts()

Parameters:

drawToAllParts (bool)

setLineSymbol(self, symbol: QgsLineSymbol | None)

Sets the line symbol used to render the callout line. Ownership of symbol is transferred to the callout.

See also

lineSymbol()

Parameters:

symbol (Optional[QgsLineSymbol])

setMinimumLength(self, length: float)

Sets the minimum length of callout lines. Units are specified through setMinimumLengthUnit().

See also

minimumLength()

See also

setMinimumLengthUnit()

Parameters:

length (float)

setMinimumLengthMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the minimum callout length.

See also

minimumLengthMapUnitScale()

See also

setMinimumLengthUnit()

See also

setMinimumLength()

Parameters:

scale (QgsMapUnitScale)

setMinimumLengthUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the minimum length of callout lines.

See also

minimumLengthUnit()

See also

setMinimumLength()

Parameters:

unit (Qgis.RenderUnit)

setOffsetFromAnchor(self, distance: float)

Sets the offset distance from the anchor point at which to start the line. Units are specified through setOffsetFromAnchorUnit().

See also

offsetFromAnchor()

See also

setOffsetFromAnchorUnit()

Parameters:

distance (float)

setOffsetFromAnchorMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the offset from anchor.

See also

offsetFromAnchorMapUnitScale()

See also

setOffsetFromAnchorUnit()

See also

setOffsetFromAnchor()

Parameters:

scale (QgsMapUnitScale)

setOffsetFromAnchorUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the offset from anchor distance.

See also

offsetFromAnchor()

See also

setOffsetFromAnchor()

Parameters:

unit (Qgis.RenderUnit)

setOffsetFromLabel(self, distance: float)

Sets the offset distance from label area at which to end the line. Units are specified through setOffsetFromLabelUnit().

See also

offsetFromLabel()

See also

setOffsetFromLabelUnit()

Parameters:

distance (float)

setOffsetFromLabelMapUnitScale(self, scale: QgsMapUnitScale)

Sets the map unit scale for the offset from label area.

See also

offsetFromLabelMapUnitScale()

See also

setOffsetFromLabelUnit()

See also

setOffsetFromLabel()

Parameters:

scale (QgsMapUnitScale)

setOffsetFromLabelUnit(self, unit: Qgis.RenderUnit)

Sets the unit for the offset from label area distance.

See also

offsetFromLabel()

See also

setOffsetFromLabel()

Parameters:

unit (Qgis.RenderUnit)