Class: QgsCalloutAbstractMetadata

class qgis.core.QgsCalloutAbstractMetadata(name: str, visibleName: str, icon: QIcon = QIcon())

Bases: sip.wrapper

Constructor for QgsCalloutAbstractMetadata, with the specified name.

The visibleName argument gives a translated, user friendly string identifying the callout type.

The icon argument can be used to specify an icon representing the callout.

QgsCalloutAbstractMetadata(QgsCalloutAbstractMetadata)

Stores metadata about one callout renderer class.

Note

It’s necessary to implement createCallout() function. In C++ you can use QgsCalloutMetadata convenience class.

New in version 3.10.

Parameters
  • name (str) –

  • visibleName (str) –

  • icon

createCallout(self, properties: Dict[str, Any], context: QgsReadWriteContext) → QgsCallout

Create a callout of this type given the map of properties.

Ownership of the callout is transferred to the caller.

Parameters
Return type

QgsCallout

createCalloutWidget(self, QgsVectorLayer) → QgsCalloutWidget

Creates a widget for configuring callouts of this type. Can return None if there’s no GUI required.

Ownership of the widget is transferred to the caller.

Return type

QgsCalloutWidget

icon(self) → QIcon

Returns an icon representing the callout.

See also

setIcon()

Return type

QIcon

name(self) → str

Returns the unique name of the callout type. This value is not translated.

See also

visibleName()

Return type

str

setIcon(self, icon: QIcon)

Sets an icon representing the callout.

See also

icon()

Parameters

icon (QIcon) –

visibleName(self) → str

Returns a friendly display name of the callout type. This value is translated.

See also

name()

Return type

str