Calculates the floor modulus of field value and the divisor, e.g. 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.

ParameterTypeRequiredDefaultDescription
asstringoptional[a]_mod The name of the output field.
divisornumberrequired  The divisor to use, e.g. x mod divisor.
field[b]stringrequired  The name of the input field.

[a] Optional parameters use their default value unless explicitly set

[b] The argument name field can be omitted.

Omitted Argument Names

The argument name for field can be omitted; the following forms of this function are equivalent:

logscale
math:mod("field",divisor="value")

and:

logscale
math:mod(field="field",divisor="value")

These examples show basic structure only; full examples are provided below.