Class: QgsProcessingParameterExtent

class qgis.core.QgsProcessingParameterExtent

Bases: QgsProcessingParameterDefinition

A rectangular map extent parameter for processing algorithms.

New in version 3.0.

QgsProcessingParameterExtent(name: str, description: str = ‘’, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterExtent.

QgsProcessingParameterExtent(QgsProcessingParameterExtent)

Methods

checkValueIsAcceptable

param input

clone

rtype

QgsProcessingParameterDefinition

fromScriptCode

Creates a new parameter using the definition from a script code.

type

rtype

str

typeName

Returns the type name for the parameter class.

valueAsPythonString

param value

checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext = None)bool
Parameters
Return type

bool

clone(self)QgsProcessingParameterDefinition
Return type

QgsProcessingParameterDefinition

fromScriptCode(name: str, description: str, isOptional: bool, definition: str)QgsProcessingParameterExtent

Creates a new parameter using the definition from a script code.

Parameters
  • name (str) –

  • description (str) –

  • isOptional (bool) –

  • definition (str) –

Return type

QgsProcessingParameterExtent

type(self)str
Return type

str

typeName()str

Returns the type name for the parameter class.

Return type

str

valueAsPythonString(self, value: Any, context: QgsProcessingContext)str
Parameters
Return type

str