Class: QgsProcessingParameterCoordinateOperation¶
A coordinate operation parameter for processing algorithms.
This parameter allows selection between available coordinate operations to use when projecting between a source and destination coordinate reference system.
QgsProcessingParameterCoordinateOperation
should be
evaluated by calling
QgsProcessingAlgorithm.parameterAsString()
.
Added in version 3.12.
Class Hierarchy¶
Base classes¶
Base class for the definition of processing parameters. |
Methods
Returns the static destination CRS, or an invalid value if this is not set. |
|
Returns the name of the destination CRS parameter, or an empty string if this is not set. |
|
Sets the static destination crs. |
|
Sets the name of the destination CRS parameter. |
|
Sets the static source crs. |
|
Sets the name of the source CRS parameter. |
|
Returns the static source CRS, or an invalid value if this is not set. |
|
Returns the name of the source CRS parameter, or an empty string if this is not set. |
Static Methods
Creates a new parameter using the definition from a script code. |
|
Returns the type name for the parameter class. |
- class qgis.core.QgsProcessingParameterCoordinateOperation[source]¶
Bases:
QgsProcessingParameterDefinition
- __init__(name: str | None, description: str | None = '', defaultValue: Any = None, sourceCrsParameterName: str | None = '', destinationCrsParameterName: str | None = '', staticSourceCrs: Any = None, staticDestinationCrs: Any = None, optional: bool = False)
Constructor for QgsProcessingParameterCoordinateOperation.
- Parameters:
name (Optional[str])
description (Optional[str] = '')
defaultValue (Any = None)
sourceCrsParameterName (Optional[str] = '')
destinationCrsParameterName (Optional[str] = '')
staticSourceCrs (Any = None)
staticDestinationCrs (Any = None)
optional (bool = False)
- __init__(a0: QgsProcessingParameterCoordinateOperation)
- Parameters:
- destinationCrs(self) Any [source]¶
Returns the static destination CRS, or an invalid value if this is not set.
See also
See also
- Return type:
Any
- destinationCrsParameterName(self) str [source]¶
Returns the name of the destination CRS parameter, or an empty string if this is not set.
See also
See also
- Return type:
str
- static fromScriptCode(name: str | None, description: str | None, isOptional: bool, definition: str | None) QgsProcessingParameterCoordinateOperation | None [source]¶
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:
- setDestinationCrs(self, crs: Any)[source]¶
Sets the static destination
crs
.See also
See also
- Parameters:
crs (Any)
- setDestinationCrsParameterName(self, name: str | None)[source]¶
Sets the
name
of the destination CRS parameter. Use an empty string if this is not required.See also
See also
- Parameters:
name (Optional[str])
- setSourceCrs(self, crs: Any)[source]¶
Sets the static source
crs
.See also
See also
- Parameters:
crs (Any)
- setSourceCrsParameterName(self, name: str | None)[source]¶
Sets the
name
of the source CRS parameter. Use an empty string if this is not required.See also
See also
- Parameters:
name (Optional[str])
- sourceCrs(self) Any [source]¶
Returns the static source CRS, or an invalid value if this is not set.
See also
See also
- Return type:
Any