Calculates the floor modulus of field value and the divisor, for
example, x mod y
where
y
is the divisor and
x is a field. Both the
field or divisor are floor rounded before the calculation.
Decimal values are supported.
Parameter | Type | Required | Default Value | Description |
---|---|---|---|---|
as | string | optional[a] | _mod | The name of the output field. |
divisor | number | required | The divisor to use, for example, x mod divisor. | |
field [b] | string | required | The name of the input field. | |
[a] Optional parameters use their default value unless explicitly set. [b] The parameter name |
Hide omitted argument names for this function
Omitted Argument NamesThe argument name for
field
can be omitted; the following forms of this function are equivalent:logscale Syntaxmath:mod("value",divisor="value")
and:
logscale Syntaxmath:mod(field="value",divisor="value")
These examples show basic structure only.