Class: QgsGenericNumericTransformer¶
-
class
qgis.core.
QgsGenericNumericTransformer
(minValue: float = 0, maxValue: float = 1, minOutput: float = 0, maxOutput: float = 1, nullOutput: float = 0, exponent: float = 1)¶ Bases:
QgsPropertyTransformer
Constructor for QgsGenericNumericTransformer.
- Parameters
minValue (float = 0) – minimum expected input value
maxValue (float = 1) – maximum expected input value
minOutput (float = 0) – minimum value to return
maxOutput (float = 1) – maximum value to return
nullOutput (float = 0) – value to return for null inputs
exponent (float = 1) – optional exponential for non-linear scaling
QgsGenericNumericTransformer(
QgsGenericNumericTransformer
)QgsPropertyTransformer
subclass for scaling an input numeric value into an output numeric value.Methods
- rtype
QgsGenericNumericTransformer
Returns the exponent for an exponential expression.
Attempts to parse an expression into a corresponding
QgsSizeScaleTransformer
.- param definition
Returns the maximum calculated size.
Returns the minimum calculated size.
Returns the size value when an expression evaluates to NULL.
Sets the exponent for an exponential expression.
Sets the maximum calculated size.
Sets the minimum calculated size.
Sets the size value for when an expression evaluates to NULL.
- param baseExpression
- rtype
Any
- param context
Applies base class numeric transformations.
- rtype
QgsPropertyTransformer.Type
Calculates the size corresponding to a specific
input
value.-
clone
(self) → QgsGenericNumericTransformer¶ - Return type
-
exponent
(self) → float¶ Returns the exponent for an exponential expression.
See also
- Return type
float
-
fromExpression
(expression: str) → Tuple[QgsGenericNumericTransformer, str, str]¶ Attempts to parse an expression into a corresponding
QgsSizeScaleTransformer
.- Parameters
expression (str) – expression to parse
fieldName – will be set to a field name which is used to calculate the input to the property transformer. This will be set to an empty string if an expression is the transformer input.
- Return type
Tuple[
QgsGenericNumericTransformer
, str, str]- Returns
corresponding
QgsSizeScaleTransformer
, orNone
if expression could notbaseExpression: will be set to the component of the source expression which is used to calculate the input to the property transformer. This will be set to an empty string if a field reference is the transformer input.
be parsed to a size scale transformer.
-
loadVariant
(self, definition: Any) → bool¶ - Parameters
definition (Any) –
- Return type
bool
-
maxOutputValue
(self) → float¶ Returns the maximum calculated size.
See also
- Return type
float
-
minOutputValue
(self) → float¶ Returns the minimum calculated size.
See also
See also
- Return type
float
-
nullOutputValue
(self) → float¶ Returns the size value when an expression evaluates to NULL.
See also
- Return type
float
-
setExponent
(self, exponent: float)¶ Sets the exponent for an exponential expression.
- Parameters
exponent (float) – exponent
See also
-
setMaxOutputValue
(self, size: float)¶ Sets the maximum calculated size.
- Parameters
size (float) – maximum size
See also
See also
-
setMinOutputValue
(self, size: float)¶ Sets the minimum calculated size.
- Parameters
size (float) – minimum size
See also
See also
-
setNullOutputValue
(self, size: float)¶ Sets the size value for when an expression evaluates to NULL.
- Parameters
size (float) – null size
See also
-
toExpression
(self, baseExpression: str) → str¶ - Parameters
baseExpression (str) –
- Return type
str
-
toVariant
(self) → Any¶ - Return type
Any
-
transform
(self, context: QgsExpressionContext, value: Any) → Any¶ - Parameters
context (QgsExpressionContext) –
value (Any) –
- Return type
Any
-
transformNumeric
(self, input: float) → float¶ Applies base class numeric transformations. Derived classes should call this to transform an
input
numeric value before they apply any transform to the result. This applies any curve transforms which may exist on the transformer.
-
transformerType
(self) → QgsPropertyTransformer.Type¶ - Return type
-
value
(self, input: float) → float¶ Calculates the size corresponding to a specific
input
value.- Return type
float
- Returns
calculated size using size scale transformer’s parameters and type
- Parameters
input (float) –