Class: QgsProcessingParameterCrs¶
- class qgis.core.QgsProcessingParameterCrs¶
Bases:
QgsProcessingParameterDefinition
A coordinate reference system parameter for processing algorithms.
Added in version 3.0.
QgsProcessingParameterCrs(name: Optional[str], description: Optional[str] = ‘’, defaultValue: Any = None, optional: bool = False) Constructor for QgsProcessingParameterCrs.
QgsProcessingParameterCrs(a0:
QgsProcessingParameterCrs
)Methods
- param input:
- rtype:
Optional[QgsProcessingParameterDefinition]
Default gui value for an algorithm parameter from settings
Creates a new parameter using the definition from a script code.
- rtype:
str
Returns the type name for the parameter class.
- param value:
- param value:
- param value:
- checkValueIsAcceptable(self, input: Any, context: QgsProcessingContext | None = None) bool ¶
- Parameters:
input (Any)
context (Optional[QgsProcessingContext] = None)
- Return type:
bool
- clone(self) QgsProcessingParameterDefinition | None ¶
- Return type:
Optional[QgsProcessingParameterDefinition]
- defaultGuiValueFromSetting(self) Any ¶
Default gui value for an algorithm parameter from settings
- Returns:
default value from settings or invalid QVariant if there is no default value defined in the settings
Added in version 3.34.
- fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) QgsProcessingParameterCrs | None ¶
Creates a new parameter using the definition from a script code.
- Parameters:
name (Optional[str])
description (Optional[str])
isOptional (bool)
definition (Optional[str])
- Return type:
Optional[QgsProcessingParameterCrs]
- type(self) str ¶
- Return type:
str
- typeName() str ¶
Returns the type name for the parameter class.
- Return type:
str
- valueAsJsonObject(self, value: Any, context: QgsProcessingContext) Any ¶
- Parameters:
value (Any)
context (QgsProcessingContext)
- Return type:
Any
- valueAsPythonString(self, value: Any, context: QgsProcessingContext) str ¶
- Parameters:
value (Any)
context (QgsProcessingContext)
- Return type:
str
- valueAsString(self, value: Any, context: QgsProcessingContext)¶
- Parameters:
value (Any)
context (
QgsProcessingContext
) -> (str)