Subgroup: Processing

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: Methods

checkValueIsAcceptable
clone
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).
numberRows Returns the fixed number of rows in the table.
setHasFixedNumberRows Sets whether the table has a fixed number of rows.
setHeaders Sets the list of column headers.
setNumberRows Sets the fixed number of rows in the table.
toVariantMap
type
typeName Returns the type name for the parameter class.
valueAsPythonString

Signals

Attributes

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()

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()

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