Subgroup: Processing

Class: QgsProcessingParameterMatrix¶

class qgis.core.QgsProcessingParameterMatrix¶

Bases: qgis._core.QgsProcessingParameterDefinition

An table (matrix) parameter for processing algorithms.

New in version 3.0: Methods

`algorithm`	Returns a pointer to the algorithm which owns this parameter.
`asScriptCode`	Returns the parameter definition encoded in a string which can be used within a Python processing script.
`checkValueIsAcceptable`
`clone`
`defaultValue`	Returns the default value for the parameter.
`dependsOnOtherParameters`	Returns a list of other parameter names on which this parameter is dependent (e.g.
`description`	Returns the description for the parameter.
`dynamicLayerParameterName`	Returns the name of the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`dynamicPropertyDefinition`	Returns the property definition for dynamic properties.
`flags`	Returns any flags associated with the parameter.
`fromScriptCode`	Creates a new parameter using the definition from a script code.
`fromVariantMap`
`hasFixedNumberRows`	Returns whether the table has a fixed number of rows.
`headers`	Returns a list of column headers (if set).
`isDestination`	Returns true if this parameter represents a file or layer destination, e.g.
`isDynamic`	Returns true if the parameter supports is dynamic, and can support data-defined values (i.e.
`metadata`	Returns the parameter’s freeform metadata.
`name`	Returns the name of the parameter.
`numberRows`	Returns the fixed number of rows in the table.
`provider`	Returns a pointer to the provider for the algorithm which owns this parameter.
`setDefaultValue`	Sets the default `value` for the parameter.
`setDescription`	Sets the `description` for the parameter.
`setDynamicLayerParameterName`	Sets the `name` for the parameter for a layer linked to a dynamic parameter, or an empty string if this is not set.
`setDynamicPropertyDefinition`	Sets the property `definition` for dynamic properties.
`setFlags`	Sets the `flags` associated with the parameter.
`setHasFixedNumberRows`	Sets whether the table has a fixed number of rows.
`setHeaders`	Sets the list of column `headers`.
`setIsDynamic`	Sets whether the parameter is `dynamic`, and can support data-defined values (i.e.
`setMetadata`	Sets the parameter’s freeform `metadata`.
`setName`	Sets the `name` of the parameter.
`setNumberRows`	Sets the fixed number of `rows` in the table.
`toVariantMap`
`toolTip`	Returns a formatted tooltip for use with the parameter, which gives helpful information like parameter description, ID, and extra content like default values (depending on parameter type).
`type`
`typeName`	Returns the type name for the parameter class.
`valueAsPythonString`

Attributes

`FlagAdvanced`
`FlagHidden`
`FlagOptional`

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

numberRows()

See also

setHasFixedNumberRows()

headers(self) → List[str]¶: Returns a list of column headers (if set).

See also

setHeaders()

numberRows(self) → int¶: Returns the fixed number of rows in the table. This parameter only has an effect if hasFixedNumberRows() is true.

See also

setNumberRows()

See also

setFixedNumberRows()

setHasFixedNumberRows(self, hasFixedNumberRows: bool)¶: Sets whether the table has a fixed number of rows.

See also

setNumberRows()

See also

hasFixedNumberRows()

setHeaders(self, headers: Iterable[str])¶: Sets the list of column headers.

See also

headers()

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

numberRows()

See also

setFixedNumberRows()

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¶