Class: QgsProcessingParameterMatrix¶
-
class
qgis.core.
QgsProcessingParameterMatrix
(name: str, description: str = '', numberRows: int = 3, hasFixedNumberRows: bool = False, headers: Iterable[str] = [], defaultValue: Any = None, optional: bool = False)¶ Bases:
qgis._core.QgsProcessingParameterDefinition
Constructor for QgsProcessingParameterMatrix.
QgsProcessingParameterMatrix(QgsProcessingParameterMatrix)
A table (matrix) parameter for processing algorithms.
New in version 3.0: Enums
Methods
Creates a new parameter using the definition from a script code.
Returns whether the table has a fixed number of rows.
Returns a list of column headers (if set).
Returns the fixed number of rows in the table.
Sets whether the table has a fixed number of rows.
Sets the list of column
headers
.Sets the fixed number of
rows
in the table.Returns the type name for the parameter class.
Signals
Attributes
-
asPythonString
(self, outputType: QgsProcessing.PythonOutputType = QgsProcessing.PythonQgsProcessingAlgorithmSubclass) → str¶
-
checkValueIsAcceptable
(self, input: Any, context: QgsProcessingContext = None) → bool¶
-
clone
(self) → QgsProcessingParameterDefinition¶
-
fromScriptCode
(name: str, description: str, isOptional: bool, definition: str) → QgsProcessingParameterMatrix¶ Creates a new parameter using the definition from a script code.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
hasFixedNumberRows
(self) → bool¶ Returns whether the table has a fixed number of rows.
See also
See also
-
headers
(self) → List[str]¶ Returns a list of column headers (if set).
See also
-
numberRows
(self) → int¶ Returns the fixed number of rows in the table. This parameter only has an effect if hasFixedNumberRows() is true.
See also
See also
-
setHasFixedNumberRows
(self, hasFixedNumberRows: bool)¶ Sets whether the table has a fixed number of rows.
See also
See also
-
setNumberRows
(self, rows: int)¶ Sets the fixed number of
rows
in the table. This parameter only has an effect if hasFixedNumberRows() is true.See also
See also
-
toVariantMap
(self) → Dict[str, Any]¶
-
type
(self) → str¶
-
typeName
() → str¶ Returns the type name for the parameter class.
-
valueAsPythonString
(self, value: Any, context: QgsProcessingContext) → str¶
-