Class: QgsProcessingModelComponent

class qgis.core.QgsProcessingModelComponent

Bases: sip.wrapper

Represents a component of a model algorithm.

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 model designer.
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 model designer.
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 model designer.
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 model designer.
setPosition	Sets the position of the model component within the model designer.
setSize	Sets the size of the model component within the model designer.
size	Returns the size of the model component within the model designer.

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 model designer.

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

See also

setColor()

Added 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.

Added 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.

See also

setLinksCollapsed()

Parameters:

edge (Qt.Edge)

Return type:

bool

position(self) → QPointF

Returns the position of the model component within the model designer.

See also

setPosition()

Return type:

QPointF

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

Restores the component properties from a QVariantMap.

See also

saveCommonProperties()

Parameters:

map (Dict[str)

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

Saves the component properties to a QVariantMap.

See also

restoreCommonProperties()

Parameters:

map (Dict[str)

setColor(self, color: QColor | Qt.GlobalColor | QGradient)

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

See also

color()

Added 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 model designer.

See also

linksCollapsed()

Parameters:

• edge (Qt.Edge)

• collapsed (bool)

setPosition(self, position: QPointF | QPoint | float)

Sets the position of the model component within the model designer.

See also

position()

Parameters:

position (Union[QPointF)

setSize(self, size: QSizeF)

Sets the size of the model component within the model designer.

See also

size()

Added in version 3.14.

Parameters:

size (QSizeF)

size(self) → QSizeF

Returns the size of the model component within the model designer.

See also

setSize()

Added in version 3.14.

Return type:

QSizeF