mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-22 00:06:12 -05:00
26 lines
914 B
Plaintext
26 lines
914 B
Plaintext
{
|
|
"name": "wordwrap",
|
|
"type": "function",
|
|
"groups": ["String"],
|
|
"description": "Returns a string wrapped to a maximum/minimum number of characters.",
|
|
"arguments": [{
|
|
"arg": "string",
|
|
"description": "the string to be wrapped"
|
|
}, {
|
|
"arg": "wrap_length",
|
|
"description": "an integer. If wrap_length is positive the number represents the ideal maximum number of characters to wrap; if negative, the number represents the minimum number of characters to wrap."
|
|
}, {
|
|
"arg": "delimiter_string",
|
|
"optional": true,
|
|
"description": "Optional delimiter string to wrap to a new line."
|
|
}],
|
|
"examples": [{
|
|
"expression": "wordwrap('UNIVERSITY OF QGIS',13)",
|
|
"returns": "'UNIVERSITY OF<br>QGIS'"
|
|
}, {
|
|
"expression": "wordwrap('UNIVERSITY OF QGIS',-3)",
|
|
"returns": "'UNIVERSITY<br>OF QGIS'"
|
|
}],
|
|
"tags": ["maximum", "minimum", "wrapped", "characters", "multiline"]
|
|
}
|