Class: QgsProcessingModelComponent

class qgis.core.QgsProcessingModelComponent

Bases: sip.wrapper

Represents a component of a model algorithm.

New in version 3.0.

QgsProcessingModelComponent(description: str = ‘’) Only subclasses can be created

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

Methods

clone

Clones the component.

color

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

comment

Returns the comment attached to this component (may be None)

copyNonDefinitionProperties

Copies all non-specific definition properties from the other component definition.

description

Returns the friendly description text for the component.

linksCollapsed

Returns True if the link points for the specified edge should be shown collapsed or not.

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.

setColor

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

setComment

Sets the comment attached to this component.

setDescription

Sets the friendly description text for the component.

setLinksCollapsed

Sets whether the link points for the specified edge for this component should be shown collapsed in the graphical modeler.

setPosition

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

setSize

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

size

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

clone(self)QgsProcessingModelComponent

Clones the component.

Ownership is transferred to the caller.

Return type

QgsProcessingModelComponent

color(self)QColor

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

An invalid color indicates that the default color for the component should be used.

See also

setColor()

New in version 3.14.

Return type

QColor

comment(self)QgsProcessingModelComment

Returns the comment attached to this component (may be None)

See also

setComment()

Return type

QgsProcessingModelComment

copyNonDefinitionProperties(self, other: QgsProcessingModelComponent)

Copies all non-specific definition properties from the other component definition.

This includes properties like the size and position of the component, but not properties like the specific algorithm or input details.

New in version 3.14.

Parameters

other (QgsProcessingModelComponent) –

description(self)str

Returns the friendly description text for the component.

See also

setDescription()

Return type

str

linksCollapsed(self, edge: Qt.Edge)bool

Returns True if the link points for the specified edge should be shown collapsed or not.

Parameters

edge (Qt.Edge) –

Return type

bool

position(self)QPointF

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

See also

setPosition()

Return type

QPointF

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

Restores the component properties from a QVariantMap.

Parameters

map (Dict[str) –

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

Saves the component properties to a QVariantMap.

Parameters

map (Dict[str) –

setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the color of the model component within the graphical modeler. An invalid color indicates that the default color for the component should be used.

See also

color()

New in version 3.14.

Parameters

color (Union[QColor) –

setComment(self, comment: QgsProcessingModelComment)

Sets the comment attached to this component.

See also

comment()

Parameters

comment (QgsProcessingModelComment) –

setDescription(self, description: str)

Sets the friendly description text for the component.

See also

description()

Parameters

description (str) –

setLinksCollapsed(self, edge: Qt.Edge, collapsed: bool)

Sets whether the link points for the specified edge for this component should be shown collapsed in the graphical modeler.

See also

linksCollapsed()

Parameters
  • edge (Qt.Edge) –

  • collapsed (bool) –

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

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

See also

position()

Parameters

position (Union[QPointF) –

setSize(self, size: QSizeF)

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

See also

size()

New in version 3.14.

Parameters

size (QSizeF) –

size(self)QSizeF

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

See also

setSize()

New in version 3.14.

Return type

QSizeF