mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-22 00:06:12 -05:00
31 lines
994 B
Plaintext
31 lines
994 B
Plaintext
{
|
|
"name": "clamp",
|
|
"type": "function",
|
|
"groups": ["Math"],
|
|
"description": "Restricts an input value to a specified range.",
|
|
"arguments": [{
|
|
"arg": "minimum",
|
|
"description": "the smallest value <i>input</i> is allowed to take."
|
|
}, {
|
|
"arg": "input",
|
|
"description": "a value which will be restricted to the range specified by <i>minimum</i> and <i>maximum</i>"
|
|
}, {
|
|
"arg": "maximum",
|
|
"description": "the largest value <i>input</i> is allowed to take"
|
|
}],
|
|
"examples": [{
|
|
"expression": "clamp(1,5,10)",
|
|
"returns": "5",
|
|
"note": "<i>input</i> is between 1 and 10 so is returned unchanged"
|
|
}, {
|
|
"expression": "clamp(1,0,10)",
|
|
"returns": "1",
|
|
"note": "<i>input</i> is less than minimum value of 1, so function returns 1"
|
|
}, {
|
|
"expression": "clamp(1,11,10)",
|
|
"returns": "10",
|
|
"note": "<i>input</i> is greater than maximum value of 10, so function returns 10"
|
|
}],
|
|
"tags": ["specified", "restricts", "input", "range"]
|
|
}
|