Class: QgsProcessingModelComponent

class qgis.core.QgsProcessingModelComponent(description: str = '')

Bases: sip.wrapper

Only subclasses can be created

QgsProcessingModelComponent(other: QgsProcessingModelComponent) Copies are protected to avoid slicing

Represents a component of a model algorithm.

New in version 3.0: Enums

Methods

description Returns the friendly description text for the component.
position Returns the position of the model component within the graphical modeler.
restoreCommonProperties Restores the component properties from a QVariantMap.
saveCommonProperties Saves the component properties to a QVariantMap.
setDescription Sets the friendly description text for the component.
setPosition Sets the position of the model component within the graphical modeler.

Signals

Attributes

description(self) → str

Returns the friendly description text for the component.

See also

setDescription()

position(self) → QPointF

Returns the position of the model component within the graphical modeler.

See also

setPosition()

restoreCommonProperties(self, map: Dict[str, Any])

Restores the component properties from a QVariantMap.

saveCommonProperties(self, map: Dict[str, Any])

Saves the component properties to a QVariantMap.

setDescription(self, description: str)

Sets the friendly description text for the component.

See also

description()

setPosition(self, position: Union[QPointF, QPoint])

Sets the position of the model component within the graphical modeler.

See also

position()