2 #include <QCoreApplication>
12 "Returns the area size of the current feature.\n"
17 "<h4>Arguments</h4>\n"
21 "<pre>$area → 42</pre>\n"
25 "In atlas generation, returns the current feature that is iterated over on the coverage layer. This can be used with the 'attribute' function\n"
26 "to return attribute values from the current atlas feature.\n"
29 "<pre>$atlasfeature</pre>\n"
31 "<h4>Arguments</h4>\n"
35 "<pre>attribute( $atlasfeature, 'name' ) → returns value stored in 'name' attribute for the current atlas feature</pre>\n"
39 "Returns the feature id of the current row while using atlas.\n"
40 "This enables you to use features of atlas in rules \n"
41 "and for example show or hide features based on their id.\n"
44 "<pre>$atlasfeatureid</pre>\n"
46 "<h4>Arguments</h4>\n"
50 "<pre>$atlasfeatureid = $id</pre>\n"
54 "Returns the geometry of the current feature iterated in atlas.\n"
55 "Can be used for rule based display of geometry when using atlas.\n"
56 "For example to only show geometries of other layers when their geometry \n"
57 "intersects the iterated geometry of features using atlas.\n"
60 "<pre>$atlasgeometry</pre>\n"
62 "<h4>Arguments</h4>\n"
66 "<pre> intersects( $atlasgeometry, $geometry ) </pre>\n"
70 "Returns the current feature being evaluated. This can be used with the 'attribute' function\n"
71 "to evaluate attribute values from the current feature.\n"
74 "<pre>$currentfeature</pre>\n"
76 "<h4>Arguments</h4>\n"
80 "<pre>attribute( $currentfeature, 'name' ) → returns value stored in 'name' attribute for the current feature</pre>\n"
84 "In atlas generation, returns the current feature number that is iterated over on the coverage layer.\n"
87 "<pre>$feature</pre>\n"
89 "<h4>Arguments</h4>\n"
93 "<pre>$feature → 2</pre>\n"
97 "Returns the geometry of the current feature. Can be used for processing with other functions.\n"
100 "<pre>$geometry</pre>\n"
102 "<h4>Arguments</h4>\n"
106 "<pre> geomToWKT( $geometry ) → POINT(6 50)</pre>\n"
110 "Returns the feature id of the current row.\n"
115 "<h4>Arguments</h4>\n"
119 "<pre>$id → 42</pre>\n"
123 "Returns the length of the current feature.\n"
126 "<pre>$length</pre>\n"
128 "<h4>Arguments</h4>\n"
132 "<pre>$length → 42.4711</pre>\n"
135 "Returns the id of the current map item if the map is being drawn in a composition, or \"canvas\" if the map is being\n"
136 "drawn within the main QGIS window.\n"
141 "<h4>Arguments</h4>\n"
145 "<!-- Show example of function.-->\n"
146 "<pre>$map → \"overview_map\" (within a composer item)<br />\n"
147 "$map → \"canvas\" (within the main QGIS main canvas)</pre>\n"
152 "In atlas generation, returns the total number of features within the coverage layer.\n"
155 "<pre>$numfeatures</pre>\n"
157 "<h4>Arguments</h4>\n"
161 "<pre>$numfeatures → 42</pre>\n"
165 "Returns the total number of pages in the composition.\n"
168 "<pre>$numpages</pre>\n"
170 "<h4>Arguments</h4>\n"
174 "<pre>$numpages → 42</pre>\n"
178 "Returns the current page number within a composition.\n"
183 "<h4>Arguments</h4>\n"
187 "<pre>$page → 2</pre>\n"
191 "Returns the perimeter length of the current feature.\n"
194 "<pre>$perimeter</pre>\n"
196 "<h4>Arguments</h4>\n"
200 "<pre>$perimeter → 42</pre>\n"
204 "Returns the number of the current row.\n"
207 "<pre>$rownum</pre>\n"
209 "<h4>Arguments</h4>\n"
213 "<pre>$rownum → 4711</pre>\n"
217 "Returns the current scale of the map canvas.\n"
219 "Note: This function is only available in some contexts and will be 0 otherwise. \n"
221 "<code>$scale</code><br>\n"
224 "<!-- Show example of function.-->\n"
225 "<code>$scale → 10000</code><br>\n"
230 "Returns the x coordinate of the current feature.\n"
235 "<h4>Arguments</h4>\n"
239 "<pre>$x → 42</pre>\n"
243 "Returns the y coordinate of the current feature.\n"
248 "<h4>Arguments</h4>\n"
252 "<pre>$y → 42</pre>\n"
256 "Returns 1 when condition a and b are true.\n"
259 "<pre> condition a AND condition b </pre>\n"
261 "<h4>Arguments</h4>\n"
265 "<pre> 4 = 2+2 AND 1 = 1 → returns 1 </pre>\n"
266 "<pre> 4 = 2+2 AND 1 = 2 → returns 0 </pre>\n"
270 "A conditional expression that can be used to evaluate multiple expressions and\n"
276 " WHEN <i>condition</i> THEN <i>result</i>\n"
278 " [ ELSE <i>result</i> ]\n"
281 "[ ] marks optional components\n"
283 "<h4>Arguments</h4>\n"
284 "<!-- List args for functions here-->\n"
285 "<i> WHEN condition</i> - The condition expression to evaluate. <br>\n"
286 "<i> THEN result</i> - If <i>condition</i> evaluates to True then <i>result</i> is evaluated and returned. <br>\n"
287 "<i> ELSE result</i> - If none of the above conditions evaluated to True then <i>result</i> is evaluated and returned. <br>\n"
290 "<!-- Show example of function.-->\n"
293 " WHEN <i>\"column\" IS NULL</i> THEN <i>'None'</i>\n"
298 "A conditional expression that can be used to evaluate multiple expressions and\n"
304 " WHEN <i>condition</i> THEN <i>result</i>\n"
306 " [ ELSE <i>result</i> ]\n"
309 "[ ] marks optional components\n"
311 "<h4>Arguments</h4>\n"
312 "<!-- List args for functions here-->\n"
313 "<i> WHEN condition</i> - The condition expression to evaluate. <br>\n"
314 "<i> THEN result</i> - If <i>condition</i> evaluates to True then <i>result</i> is evaluated and returned. <br>\n"
315 "<i> ELSE result</i> - If none of the above conditions evaluated to True then <i>result</i> is evaluated and returned. <br>\n"
318 "<!-- Show example of function.-->\n"
321 " WHEN <i>\"column\" IS NULL</i> THEN <i>'None'</i>\n"
322 " ELSE <i>\"column\"</i>\n"
327 "<h3>Color Group</h3>\n"
328 "This group contains functions for manipulating colors\n"
331 "This group contains functions to handle conditional checks in expressions.\n"
334 "This group contains functions that operate on condition.\n"
337 "This group contains functions to convert on data type to another e.g string to integer, integer to string.\n"
340 "This group contains functions for handling date and time data.\n"
343 "Double click to add field name to expression string.\n"
345 "Right-Click on field name to open context menu sample value loading options.\n"
347 "<p><h4>Note:</h4>\n"
348 "Loading field values from WFS layers isn't supported, before the layer is\n"
349 "actually inserted, ie. when building queries.\n"
353 "Contains a list of fields from the layer. Sample values can also be accessed via right-click.\n"
355 "Select the field name from the list then right-click to access context menu with options to load sample values from the selected field.\n"
357 "<p><h4>Note:</h4>\n"
358 "Loading field values from WFS layers isn't supported, before the layer is\n"
359 "actually inserted, ie. when building queries.\n"
363 "This group contains functions that operate on geometry objects e.g length, area.\n"
366 "Returns 1 if the first parameter matches case-insensitive the supplied pattern. LIKE can be used instead of ILIKE to make the match case-sensitive. Works with numbers also.\n"
369 "<pre>string/number ILIKE pattern</pre>\n"
371 "<h4>Arguments</h4>\n"
375 "<pre> 'A' ILIKE 'A' → returns 1 </pre>\n"
376 "<pre> 'A' ILIKE 'a' → returns 1 </pre>\n"
377 "<pre> 'A' ILIKE 'B' → returns 0 </pre>\n"
378 "<pre> 'ABC' ILIKE 'b' → returns 0 </pre>\n"
379 "<pre> 'ABC' ILIKE 'B' → returns 0 </pre>\n"
380 "<pre> 'ABC' ILIKE '%b%' → returns 1 </pre>\n"
381 "<pre> 'ABC' ILIKE '%B%' → returns 1 </pre>\n"
384 "Returns 1 if value is found within a list of values\n"
387 "<pre>'a' IN ('a', 'b')</pre>\n"
389 "<h4>Arguments</h4>\n"
393 "<pre> 'A' IN ('A','B\") → returns 1 </pre>\n"
394 "<pre> 'A' IN ('C','B\") → returns 0 </pre>\n"
398 "Returns 1 if a is the same as b.\n"
401 "<pre>a IS b</pre>\n"
403 "<h4>Arguments</h4>\n"
407 "<pre> 'A' IS 'A' → returns 1 </pre>\n"
408 "<pre> 'A' IS 'a' → returns 0 </pre>\n"
409 "<pre> 4 IS 4 → returns 1 </pre>\n"
410 "<pre> 4 IS 2+2 → returns 1 </pre>\n"
411 "<pre> 4 IS 2 → returns 0 </pre>\n"
412 "<pre> $geometry IS NULL → returns 0, if your geometry is not NULL</pre>\n"
416 "Returns 1 if the first parameter matches the supplied pattern. Works with numbers also.\n"
419 "<pre>string/number LIKE pattern</pre>\n"
421 "<h4>Arguments</h4>\n"
425 "<pre> 'A' LIKE 'A' → returns 1 </pre>\n"
426 "<pre> 'A' LIKE 'a' → returns 0 </pre>\n"
427 "<pre> 'A' LIKE 'B' → returns 0 </pre>\n"
428 "<pre> 'ABC' LIKE 'B' → returns 0 </pre>\n"
429 "<pre> 'ABC' LIKE '%B%' → returns 1 </pre>\n"
432 "This group contains math functions e.g square root, sin and cos\n"
435 "Returns 1 if a is not the same as b.\n"
438 "<pre> a NOT b </pre>\n"
440 "<h4>Arguments</h4>\n"
444 "<pre> 'a' IS NOT 'b' → returns 1 </pre>\n"
445 "<pre> 'a' IS NOT 'a' → returns 0 </pre>\n"
446 "<pre> 4 IS NOT 2+2 → returns 0 </pre>\n"
450 "Equates to a null value.\n"
455 "<h4>Arguments</h4>\n"
459 "<pre> NULL → returns a null value </pre>\n"
462 "<p>To test for NULL use an <pre>IS NULL</pre> or <pre>IS NOT NULL</pre> expression.</p>\n"
465 "Returns 1 when condition a or b is true.\n"
468 "<pre> condition a OR condition b </pre>\n"
470 "<h4>Arguments</h4>\n"
474 "<pre> 4 = 2+2 OR 1 = 1 → returns 1 </pre>\n"
475 "<pre> 4 = 2+2 OR 1 = 2 → returns 1 </pre>\n"
476 "<pre> 4 = 2 OR 1 = 2 → returns 0 </pre>\n"
479 "This group contains operators e.g + - * \n"
482 "This group contains functions that operate on record identifiers.\n"
485 "This group contains functions that operate on strings e.g replace, convert to upper case.\n"
488 "Returns the absolute value of a number.<br>\n"
492 "abs(<i>value</i>)<br>\n"
494 "<h4>Arguments</h4>\n"
495 "<code>value</code> - a number.<br>\n"
498 "<code>abs(-2) → 2</code><br>\n"
501 "Returns arcuscosinus of a value in radians.\n"
504 "<p><h4>Syntax</h4>\n"
505 " acos(<i>real</i>)</p>\n"
507 "<p><h4>Arguments</h4>\n"
508 "<i>real</i> → cos of an angle.</p>\n"
510 "<p><h4>Example</h4>\n"
511 " acos(0.5) → 1.0471975511966</p>\n"
514 "Returns the difference between two dates.\n"
516 "The difference is returned as a <code>Interval</code> \n"
517 "and needs to be used with one of the following functions\n"
518 "in order to extract useful information:\n"
520 "<li><code>year</code>\n"
521 "<li><code>month</code>\n"
522 "<li><code>week</code>\n"
523 "<li><code>day</code>\n"
524 "<li><code>hour</code>\n"
525 "<li><code>minute</code>\n"
526 "<li><code>second</code>\n"
529 "<code>age(string,string)</code><br>\n"
530 "<code>age(datetime,datetime)</code><br>\n"
531 "<code>age(string,datetime)</code><br>\n"
532 "<code>age(datetime,string)</code><br>\n"
534 "<h4>Arguments</h4>\n"
535 "<code>string</code> - is string. A string in date format.\n"
537 "<code>datetime</code> - is date or datetime. A date or datetime type.\n"
540 "<!-- Show example of function.-->\n"
541 "<code>age('2012-05-12','2012-05-2') → Interval</code><br>\n"
542 "use <code>day</code> to extract number of days<br>\n"
543 "<code>day(age('2012-05-12','2012-05-2')) → 10</code><br>\n"
547 "Returns arcussinus of a value in radians.\n"
550 "<p><h4>Syntax</h4>\n"
551 " asin(<i>real</i>)</p>\n"
553 "<p><h4>Arguments</h4>\n"
554 "<i>real</i> → sin of an angle.</p>\n"
556 "<p><h4>Example</h4>\n"
557 " asin(1.0) → 1.5707963267949</p>\n"
560 "Returns arcustanget of a value in radians.\n"
563 "<p><h4>Syntax</h4>\n"
564 " atan(<i>real</i>)</p>\n"
566 "<p><h4>Arguments</h4>\n"
567 "<i>real</i> → tan of an angle.</p>\n"
569 "<p><h4>Example</h4>\n"
570 " atan(0.5) → 0.463647609000806</p>\n"
573 "Returns arcustangens of y/x using the signs of the two \n"
574 "arguments to determine the quadrant of the result\n"
578 "<p><h4>Syntax</h4>\n"
579 " atan2(<i>real</i>, <i>real</i>)</p>\n"
581 "<p><h4>Arguments</h4>\n"
582 "<i>real</i> → y coordinate difference<br>\n"
583 "<i>real</i> → x coordinate difference</p>\n"
585 "<p><h4>Example</h4>\n"
586 " atan2(1.0, 1.732) → 0.523611477769969</p>\n"
589 "Returns the value of a specified attribute from a feature.\n"
592 "<pre>attribute( feature, attribute_name )</pre>\n"
594 "<h4>Arguments</h4>\n"
595 "feature → a feature<br />\n"
596 "attribute_name → name of attribute to be returned\n"
599 "<pre>attribute( $currentfeature, 'name' ) → returns value stored in 'name' attribute for the current feature</pre>\n"
603 "Returns a geometry which represents the bounding box of an input geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
606 "<pre>bounds(geom)</pre>\n"
608 "<h4>Arguments</h4>\n"
609 "geom → a geometry\n"
612 "<pre> bounds($geometry) → returns bounding box of $geometry</pre>\n"
616 "Returns the height of the bounding box of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
619 "<pre>bounds_height(geom)</pre>\n"
621 "<h4>Arguments</h4>\n"
622 "geom → a geometry\n"
625 "<pre> bounds_height($geometry) → returns height of bounding box of $geometry</pre>\n"
629 "Returns the width of the bounding box of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
632 "<pre>bounds_width(geom)</pre>\n"
634 "<h4>Arguments</h4>\n"
635 "geom → a geometry\n"
638 "<pre> bounds_width($geometry) → returns width of bounding box of $geometry</pre>\n"
642 "Returns a geometry that represents all points whose distance from this geometry is less than or equal to distance. Calculations are in the Spatial Reference System of this Geometry. \n"
645 "<pre>buffer(a, b)</pre>\n"
647 "<h4>Arguments</h4>\n"
648 "a → geometry\n"
649 "b → distance for the buffer\n"
652 "<pre> buffer($geometry, 10.5 ) → returns a polygon</pre>\n"
656 "Rounds a number upwards.\n"
659 "<code>ceil(value)</code><br>\n"
661 "<h4>Arguments</h4>\n"
662 "<code>value</code> - a number.\n"
666 "<!-- Show example of function.-->\n"
667 "<code>ceil(4.9) → 5</code><br>\n"
668 "<code>ceil(-4.9) → -4</code><br>\n"
671 "Returns the geometric center of a geometry.\n"
674 "<pre>centroid(a)</pre>\n"
676 "<h4>Arguments</h4>\n"
677 "b → geometry\n"
680 "<pre> centroid($geometry) → returns a point geometry</pre>\n"
684 "Restricts an input value to a specified range.\n"
686 "<p><h4>Syntax</h4>\n"
687 " clamp(<i>minimum</i>,<i>input</i>,<i>maximum</i>)</p>\n"
689 "<p><h4>Arguments</h4>\n"
690 "<!-- List args for functions here-->\n"
691 "<i> minimum</i> → The smallest value <i>input</i> is allowed to take.<br>\n"
692 "<i> input</i> → a value which will be restricted to the range specified by <i>minimum</i> and <i>maximum</i>.<br>\n"
693 "<i> maximum</i> → The largest value <i>input</i> is allowed to take.<br>\n"
696 "<!-- Show example of function.-->\n"
697 " clamp(1,5,10) → 5 (<i>input</i> is between 1 and 10 so is returned unchanged)<br>\n"
698 " clamp(1,0,10) → 1 (<i>input</i> is less than minimum value of 1, so function returns 1)<br>\n"
699 " clamp(1,11,10) → 10 (<i>input</i> is greater than maximum value of 10, so function returns 10)<br>\n"
704 "Returns the first non-NULL value from the expression list.\n"
706 "This function can take any number of arguments.\n"
708 "<code>coalesce(expression1, expression2 ...)</code><br>\n"
710 "<h4>Arguments</h4>\n"
711 "<code>expression</code> - any valid expression or value, irregardless of type.\n"
715 "<!-- Show example of function.-->\n"
716 "<code>coalesce(NULL, 2) → 2</code><br>\n"
717 "<code>coalesce(NULL, 2, 3) → 2</code><br>\n"
718 "<code>coalesce(7, NULL, 3*2) → 7</code><br><br>\n"
719 "<code>coalesce(\"fieldA\", \"fallbackField\", 'ERROR') → value of fieldA if it is non-NULL\n"
720 " else the value of \"fallbackField\" or the string 'ERROR' if both are NULL</code><br>\n"
724 "<h3>color_cmyk() function</h3>\n"
725 "Returns a string representation of a color based on its cyan, magenta, yellow and black components\n"
727 "<p><h4>Syntax</h4>\n"
728 " color_cmyk(<i>cyan, magenta, yellow, black</i>)</p>\n"
730 "<p><h4>Arguments</h4>\n"
731 "<!-- List args for functions here-->\n"
732 "<i> cyan</i> → the cyan component of the color, as a percentage integer value from 0 to 100.<br>\n"
733 "<i> magenta</i> → the magenta component of the color, as a percentage integer value from 0 to 100.<br>\n"
734 "<i> yellow</i> → the yellow component of the color, as a percentage integer value from 0 to 100.<br>\n"
735 "<i> black</i> → the black component of the color, as a percentage integer value from 0 to 100.<br>\n"
737 "<p><h4>Example</h4>\n"
738 "<!-- Show example of function.-->\n"
739 " color_cmyk(100,50,0,10) → '0,115,230'</p>\n"
742 "<h3>color_cmyka() function</h3>\n"
743 "Returns a string representation of a color based on its cyan, magenta, yellow, black and alpha (transparency) components\n"
745 "<p><h4>Syntax</h4>\n"
746 " color_cmyka(<i>cyan, magenta, yellow, black, alpha</i>)</p>\n"
748 "<p><h4>Arguments</h4>\n"
749 "<!-- List args for functions here-->\n"
750 "<i> cyan</i> → the cyan component of the color, as a percentage integer value from 0 to 100.<br>\n"
751 "<i> magenta</i> → the magenta component of the color, as a percentage integer value from 0 to 100.<br>\n"
752 "<i> yellow</i> → the yellow component of the color, as a percentage integer value from 0 to 100.<br>\n"
753 "<i> black</i> → the black component of the color, as a percentage integer value from 0 to 100.<br>\n"
754 "<i> alpha</i> → the alpha component as an integer value from 0 (completely transparent) to 255 (opaque).<br>\n"
756 "<p><h4>Example</h4>\n"
757 "<!-- Show example of function.-->\n"
758 " color_cmyka(100,50,0,10,200) → '0,115,230,200'</p>\n"
761 "Returns a string representation of a color based on its hue, saturation, and lightness attributes\n"
763 "<p><h4>Syntax</h4>\n"
764 " color_hsl(<i>hue, saturation, lightness</i>)</p>\n"
766 "<p><h4>Arguments</h4>\n"
767 "<!-- List args for functions here-->\n"
768 "<i> hue</i> → the hue of the color, as an integer value from 0 to 360.<br>\n"
769 "<i> saturation</i> → the saturation percentage of the color as an integer value from 0 to 100.<br>\n"
770 "<i> lightness</i> → the lightness percentage of the color as an integer value from 0 to 100.<br>\n"
772 "<p><h4>Example</h4>\n"
773 "<!-- Show example of function.-->\n"
774 " color_hsl(100,50,70) → '166,217,140'</p>\n"
777 "Returns a string representation of a color based on its hue, saturation, lightness and alpha (transparency) attributes\n"
779 "<p><h4>Syntax</h4>\n"
780 " color_hsla(<i>hue, saturation, lightness, alpha</i>)</p>\n"
782 "<p><h4>Arguments</h4>\n"
783 "<!-- List args for functions here-->\n"
784 "<i> hue</i> → the hue of the color, as an integer value from 0 to 360.<br>\n"
785 "<i> saturation</i> → the saturation percentage of the color as an integer value from 0 to 100.<br>\n"
786 "<i> lightness</i> → the lightness percentage of the color as an integer value from 0 to 100.<br>\n"
787 "<i> alpha</i> → the alpha component as an integer value from 0 (completely transparent) to 255 (opaque).<br>\n"
789 "<p><h4>Example</h4>\n"
790 "<!-- Show example of function.-->\n"
791 " color_hsla(100,50,70,200) → '166,217,140,200'</p>\n"
794 "Returns a string representation of a color based on its hue, saturation, and value attributes\n"
796 "<p><h4>Syntax</h4>\n"
797 " color_hsv(<i>hue, saturation, value</i>)</p>\n"
799 "<p><h4>Arguments</h4>\n"
800 "<!-- List args for functions here-->\n"
801 "<i> hue</i> → the hue of the color, as an integer value from 0 to 360.<br>\n"
802 "<i> saturation</i> → the saturation percentage of the color as an integer value from 0 to 100.<br>\n"
803 "<i> value</i> → the value percentage of the color as an integer from 0 to 100.<br>\n"
805 "<p><h4>Example</h4>\n"
806 "<!-- Show example of function.-->\n"
807 " color_hsv(40,100,100) → '255,170,0'</p>\n"
810 "Returns a string representation of a color based on its hue, saturation, value and alpha (transparency) attributes\n"
812 "<p><h4>Syntax</h4>\n"
813 " color_hsva(<i>hue, saturation, value, alpha</i>)</p>\n"
815 "<p><h4>Arguments</h4>\n"
816 "<!-- List args for functions here-->\n"
817 "<i> hue</i> → the hue of the color, as an integer value from 0 to 360.<br>\n"
818 "<i> saturation</i> → the saturation percentage of the color as an integer value from 0 to 100.<br>\n"
819 "<i> value</i> → the value percentage of the color as an integer from 0 to 100.<br>\n"
820 "<i> alpha</i> → the alpha component as an integer value from 0 (completely transparent) to 255 (opaque).<br>\n"
822 "<p><h4>Example</h4>\n"
823 "<!-- Show example of function.-->\n"
824 " color_hsva(40,100,100,200) → '255,170,0,200'</p>\n"
827 "<h3>color_rgb() function</h3>\n"
828 "Returns a string representation of a color based on its red, green, and blue components\n"
830 "<p><h4>Syntax</h4>\n"
831 " color_rgb(<i>red, green, blue</i>)</p>\n"
833 "<p><h4>Arguments</h4>\n"
834 "<!-- List args for functions here-->\n"
835 "<i> red</i> → the red component as an integer value from 0 to 255.<br>\n"
836 "<i> green</i> → the green component as an integer value from 0 to 255.<br>\n"
837 "<i> blue</i> → the blue component as an integer value from 0 to 255.<br>\n"
839 "<p><h4>Example</h4>\n"
840 "<!-- Show example of function.-->\n"
841 " color_rgb(255,127,0) → '255,127,0'</p>\n"
844 "<h3>color_rgba() function</h3>\n"
845 "Returns a string representation of a color based on its red, green, blue, and alpha (transparency) components\n"
847 "<p><h4>Syntax</h4>\n"
848 " color_rgba(<i>red, green, blue, alpha</i>)</p>\n"
850 "<p><h4>Arguments</h4>\n"
851 "<!-- List args for functions here-->\n"
852 "<i> red</i> → the red component as an integer value from 0 to 255.<br>\n"
853 "<i> green</i> → the green component as an integer value from 0 to 255.<br>\n"
854 "<i> blue</i> → the blue component as an integer value from 0 to 255.<br>\n"
855 "<i> alpha</i> → the alpha component as an integer value from 0 (completely transparent) to 255 (opaque).<br>\n"
857 "<p><h4>Example</h4>\n"
858 "<!-- Show example of function.-->\n"
859 " color_rgba(255,127,0,200) → '255,127,0,200'</p>\n"
862 "Returns the combination of geometry a and geometry b.\n"
865 "<pre>combine( geometry a , geometry b)</pre>\n"
867 "<h4>Arguments</h4>\n"
868 "geometry → geometry\n"
869 "geometry → geometry\n"
872 "<pre> geomToWKT( combine( geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5 )' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4, 2 1 )' )) ) → returns MULTILINESTRING((4 4, 2 1), (3 3, 4 4), (4 4, 5 5)) </pre>\n"
873 "<pre> geomToWKT( combine( geomFromWKT( 'LINESTRING(3 3 , 4 4 )' ) , geomFromWKT( 'LINESTRING(3 3 , 6 6, 2 1 )' )) ) → returns LINESTRING(3 3, 4 4, 6 6, 2 1) </pre>\n"
876 "Concatenates several strings to one.\n"
879 " concat(<i>string<i>[,<i>string</i>...])\n"
881 "<h4>Arguments</h4>\n"
882 "<!-- List args for functions here-->\n"
883 "<i> string</i> → is string. a string.<br>\n"
886 "<!-- Show example of function.-->\n"
887 " concat('a','b','c','d','e') → 'abcde'\n"
890 "Returns true if and only if no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a. \n"
893 "<pre>contains( geometry a , geometry b)</pre>\n"
895 "<h4>Arguments</h4>\n"
896 "geometry → geometry\n"
897 "geometry → geometry\n"
900 "<pre> contains( geomFromWKT( 'POLYGON((0 0 , 0 1 , 1 1 , 1 0 , 0 0 ))' ) , geomFromWKT( 'POINT( 0.5 0.5 )' )) → returns 1</pre>\n"
901 "<pre> contains( geomFromWKT( 'POLYGON((0 0 , 0 1 , 1 1 , 1 0 , 0 0 ))' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 0</pre>\n"
904 "Returns the convex hull of a geometry. It represents the minimum convex geometry that encloses all geometries within the set.\n"
907 "<pre>convex_hull( a, b )</pre>\n"
909 "<h4>Arguments</h4>\n"
910 "a → geometry\n"
911 "a → geometry\n"
914 "<pre> geom_to_wkt( convex_hull( geom_from_wkt( 'LINESTRING(3 3 , 4 4 , 4 10)' )) ) → returns POLYGON((3 3,4 10,4 4,3 3)) </pre>\n"
917 "Returns cosinus of an angle.\n"
920 "<p><h4>Syntax</h4>\n"
921 " cos(<i>real</i>)</p>\n"
923 "<p><h4>Arguments</h4>\n"
924 "<i>real</i> → angle in radians.</p>\n"
926 "<p><h4>Example</h4>\n"
927 " cos(1.571) → 0.000796326710733263</p>\n"
930 "Returns 1 if the supplied geometries have some, but not all, interior points in common.\n"
933 "<pre>crosses( $geometry , $geometry)</pre>\n"
935 "<h4>Arguments</h4>\n"
936 "geometry → geometry\n"
937 "geometry → geometry\n"
940 "<pre> crosses( geomFromWKT( 'LINESTRING(3 5 , 4 4 , 5 3)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
941 "<pre> crosses( geomFromWKT( 'POINT(4 5)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 0</pre>\n"
944 "Extract the day from a date, or the number of days\n"
945 "from a <code>Interval</code>\n"
948 "<code>day(date)</code><br>\n"
949 "<code>day(Interval)</code><br>\n"
951 "<h4>Arguments</h4>\n"
952 "<code>date</code> - is date or datetime. The date to extract the day from.\n"
954 "<code>Interval</code> - is Interval. The Interval to return the number of days from.\n"
957 "<!-- Show example of function.-->\n"
958 "<code>day('2012-05-12') → 12</code><br>\n"
959 "<code>day(tointerval('3 days')) → 3</code><br>\n"
960 "<code>day(age('2012-01-01','2010-01-01')) → 730</code><br>\n"
964 "Returns a geometry that represents that part of geometry a that does not intersect with geometry b.\n"
967 "<pre>difference( a, b )</pre>\n"
969 "<h4>Arguments</h4>\n"
970 "geometry → geometry\n"
971 "geometry → geometry\n"
974 "<pre> geomToWKT( difference( geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4)' )) ) → returns LINESTRING(4 4, 5 5)</pre>\n"
977 "Returns 1 if the geometries do not \"spatially intersect\" - if they do not share any space together. \n"
980 "<pre>disjoint( a, b )</pre>\n"
982 "<h4>Arguments</h4>\n"
983 "a → geometry\n"
984 "b → geometry\n"
987 "<pre> disjoint( geomFromWKT( 'POLYGON((0 0 , 0 1 , 1 1 , 1 0 , 0 0 ))' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
988 "<pre> disjoint( geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' ) , geomFromWKT( 'POINT(4 4)' )) → returns 0</pre>\n"
991 " Returns the minimum distance (based on spatial ref) between two geometries in projected units.\n"
994 "<pre>distance( a, b )</pre>\n"
996 "<h4>Arguments</h4>\n"
997 "a → geometry\n"
998 "b → geometry\n"
1000 "<h4>Example</h4>\n"
1001 "<pre> distance( geomFromWKT( 'POINT(4 4)' ) , geomFromWKT( 'POINT(4 8)' )) → returns 4</pre>\n"
1004 "Returns exponential of an value.\n"
1007 "<p><h4>Syntax</h4>\n"
1008 " exp(<i>real</i>)</p>\n"
1010 "<p><h4>Arguments</h4>\n"
1011 "<i>real</i> → number.</p>\n"
1013 "<p><h4>Example</h4>\n"
1014 " exp(1.0) → 2.71828182845905</p>\n"
1017 "Rounds a number downwards.\n"
1020 "<code>floor(value)</code><br>\n"
1022 "<h4>Arguments</h4>\n"
1023 "<code>value</code> - a number.\n"
1026 "<h4>Example</h4>\n"
1027 "<!-- Show example of function.-->\n"
1028 "<code>floor(4.9) → 4</code><br>\n"
1029 "<code>floor(-4.9) → -5</code><br>\n"
1032 "Format a string using supplied arguments. \n"
1035 "<code>format('string', arg, [arg...n])</code><br>\n"
1037 "<h4>Arguments</h4>\n"
1038 "<code>string</code> - is string. String with Qt QString place holders. Use %1, %2, etc for placeholders. Placeholders can be repeated. \n"
1040 "<code>arg [arg...n]</code> - any type. Any number of args. \n"
1042 "<h4>Example</h4>\n"
1043 "<!-- Show example of function.-->\n"
1044 "<code>format('This %1 a %2','is', 'test') → This is a test</code><br>") );
1046 "Format a date type or string into a custom string format. Uses Qt data time format strings. See <a href='http://qt-project.org/doc/qt-4.8/qdatetime.html#toString'>QDateTime::toString</a>\n"
1049 "<code>format_date('string', 'format_string')</code><br>\n"
1051 "<h4>Arguments</h4>\n"
1052 "<code>string</code> - is string. Date/Time/DateTime string.\n"
1054 "<code>format_string</code> - is string. String template used to format the string.\n"
1059 " <th>Expression</th>\n"
1061 " <th>Output</th>\n"
1065 " <tr valign=\"top\">\n"
1068 " <td>the day as number without a leading zero (1 to 31)</td>\n"
1071 " <tr valign=\"top\">\n"
1074 " <td>the day as number with a leading zero (01 to 31)</td>\n"
1077 " <tr valign=\"top\">\n"
1080 " <td>the abbreviated localized day name (e.g. 'Mon' to 'Sun'). Uses <a href=\n"
1081 " \"qdate.html#shortDayName\">QDate::shortDayName</a>().</td>\n"
1084 " <tr valign=\"top\">\n"
1087 " <td>the long localized day name (e.g. 'Monday' to 'Sunday'). Uses <a href=\n"
1088 " \"qdate.html#longDayName\">QDate::longDayName</a>().</td>\n"
1091 " <tr valign=\"top\">\n"
1094 " <td>the month as number without a leading zero (1-12)</td>\n"
1097 " <tr valign=\"top\">\n"
1100 " <td>the month as number with a leading zero (01-12)</td>\n"
1103 " <tr valign=\"top\">\n"
1106 " <td>the abbreviated localized month name (e.g. 'Jan' to 'Dec'). Uses <a href=\n"
1107 " \"qdate.html#shortMonthName\">QDate::shortMonthName</a>().</td>\n"
1110 " <tr valign=\"top\">\n"
1113 " <td>the long localized month name (e.g. 'January' to 'December'). Uses <a href=\n"
1114 " \"qdate.html#longMonthName\">QDate::longMonthName</a>().</td>\n"
1117 " <tr valign=\"top\">\n"
1120 " <td>the year as two digit number (00-99)</td>\n"
1123 " <tr valign=\"top\">\n"
1126 " <td>the year as four digit number</td>\n"
1130 " <p>These expressions may be used for the time part of the format string:</p>\n"
1135 " <th>Expression</th>\n"
1137 " <th>Output</th>\n"
1141 " <tr valign=\"top\">\n"
1144 " <td>the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)</td>\n"
1147 " <tr valign=\"top\">\n"
1150 " <td>the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)</td>\n"
1153 " <tr valign=\"top\">\n"
1156 " <td>the hour without a leading zero (0 to 23, even with AM/PM display)</td>\n"
1159 " <tr valign=\"top\">\n"
1162 " <td>the hour with a leading zero (00 to 23, even with AM/PM display)</td>\n"
1165 " <tr valign=\"top\">\n"
1168 " <td>the minute without a leading zero (0 to 59)</td>\n"
1171 " <tr valign=\"top\">\n"
1174 " <td>the minute with a leading zero (00 to 59)</td>\n"
1177 " <tr valign=\"top\">\n"
1180 " <td>the second without a leading zero (0 to 59)</td>\n"
1183 " <tr valign=\"top\">\n"
1186 " <td>the second with a leading zero (00 to 59)</td>\n"
1189 " <tr valign=\"top\">\n"
1192 " <td>the milliseconds without leading zeroes (0 to 999)</td>\n"
1195 " <tr valign=\"top\">\n"
1198 " <td>the milliseconds with leading zeroes (000 to 999)</td>\n"
1201 " <tr valign=\"top\">\n"
1202 " <td>AP or A</td>\n"
1204 " <td>interpret as an AM/PM time. <i>AP</i> must be either \"AM\" or \"PM\".</td>\n"
1207 " <tr valign=\"top\">\n"
1208 " <td>ap or a</td>\n"
1210 " <td>Interpret as an AM/PM time. <i>ap</i> must be either \"am\" or \"pm\".</td>\n"
1216 "<h4>Example</h4>\n"
1217 "<!-- Show example of function.-->\n"
1218 "<code>format_date('2012-05-15','dd.MM.yyyy') → 15.05.2012</code><br>\n"
1221 "Returns a number formatted with the locale separator for thousands. \n"
1222 "Also truncates the number to the number of supplied places. \n"
1224 "<code>format_number(number,places)</code><br>\n"
1226 "<h4>Arguments</h4>\n"
1227 "<code>number</code> - is number. The number to be formatted.\n"
1229 "<code>places</code> - is int. The number of decimal places to truncate the string\n"
1232 "<h4>Example</h4>\n"
1233 "<!-- Show example of function.-->\n"
1234 "<code>format_number(10000000.332,2) → 10,000,000.33</code>\n"
1238 "Returns a geometry from a GML representation of geometry\n"
1241 "<pre>geom_from_gml(text)</pre>\n"
1243 "<h4>Arguments</h4>\n"
1244 "text → GML representation of a geometry\n"
1246 "<h4>Example</h4>\n"
1247 "<pre> geom_from_gml( '<gml:LineString srsName=\"EPSG:4326\"><gml:coordinates>4,4 5,5 6,6</gml:coordinates></gml:LineString>') → returns a geometry</pre>\n"
1251 "Returns a geometry created from a Well-Known Text (WKT) representation.\n"
1254 "<pre>geom_from_wkt(text)</pre>\n"
1256 "<h4>Arguments</h4>\n"
1257 "text → Well-Known Text (WKT) representation of a geometry\n"
1259 "<h4>Example</h4>\n"
1260 "<pre> geom_from_wkt( 'POINT(4 5)' ) → returns a geometry</pre>\n"
1264 "Returns the Well-Known Text (WKT) representation of the geometry without SRID metadata.\n"
1267 "<pre>geom_to_wkt(a)</pre>\n"
1269 "<h4>Arguments</h4>\n"
1270 "a → geometry\n"
1272 "<h4>Example</h4>\n"
1273 "<pre> geom_to_wkt( $geometry ) → POINT(6 50)</pre>\n"
1276 "Returns the feature's geometry\n"
1279 "<pre>geometry( f )</pre>\n"
1281 "<h4>Arguments</h4>\n"
1282 "f → QgsFeature\n"
1284 "<h4>Example</h4>\n"
1285 "<pre> geomToWKT( geometry( getFeature( layer, attributeField, value ) ) ) → POINT(6 50)</pre>\n"
1286 "<pre> intersects( $geometry, geometry( getFeature( layer, attributeField, value ) ) ) → 1</pre>\n"
1289 "Returns the first feature of a layer matching a given attribute value\n"
1292 "<pre>get_feature( layer, attributeField, value )</pre>\n"
1296 "Extract the hour from a datetime or time, or the number of hours\n"
1297 "from a <code>Interval</code>\n"
1300 "<code>hour(datetime)</code><br>\n"
1301 "<code>hour(Interval)</code><br>\n"
1303 "<h4>Arguments</h4>\n"
1304 "<code>date</code> - is datetime or time. The date to extract the hour from.\n"
1306 "<code>Interval</code> - is Interval. The Interval to return the number of hours from.\n"
1308 "<h4>Example</h4>\n"
1309 "<!-- Show example of function.-->\n"
1310 "<code>hour('2012-07-22T13:24:57') → 13</code><br>\n"
1311 "<code>hour(tointerval('3 hours')) → 3</code><br>\n"
1312 "<code>hour(age('2012-07-22T13:00:00','2012-07-22T10:00:00')) → 3</code><br>\n"
1313 "<code>hour(age('2012-01-01','2010-01-01')) → 17520</code><br>\n"
1317 "Returns a geometry that represents the shared portion of geometry a and geometry b.\n"
1320 "<pre>intersection( geometry a , geometry b)</pre>\n"
1322 "<h4>Arguments</h4>\n"
1323 "geometry → geometry\n"
1324 "geometry → geometry\n"
1326 "<h4>Example</h4>\n"
1327 "<pre> geomToWKT( intersection( geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 )' )) ) → returns LINESTRING(3 3, 4 4)</pre>\n"
1330 "Returns 1 if the geometries spatially intersect (share any portion of space) and 0 if they don't.\n"
1333 "<pre>intersects( a, b )</pre>\n"
1335 "<h4>Arguments</h4>\n"
1336 "a → geometry\n"
1337 "b → geometry\n"
1339 "<h4>Example</h4>\n"
1340 "<pre> intersects( geomFromWKT( 'POINT(4 4)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
1341 "<pre> intersects( geomFromWKT( 'POINT(4 5)' ) , geomFromWKT( 'POINT(5 5)' )) → returns 0</pre>\n"
1344 "Returns 1 if the geometries spatially intersect the bounding box defined and 0 if they don't.\n"
1347 "<pre>intersects_bbox( a, b )</pre>\n"
1349 "<h4>Arguments</h4>\n"
1350 "a → geometry\n"
1351 "b → geometry\n"
1353 "<h4>Example</h4>\n"
1354 "<pre>intersects_bbox( geomFromWKT( 'POINT(4 5)' ) , geom_from_wkt( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
1355 "<pre>intersects_bbox( geomFromWKT( 'POINT(6 5)' ) , geom_from_wkt( 'POLYGON((3 3 , 4 4 , 5 5, 3 3))' )) → returns 0</pre>\n"
1358 "Returns a substring that contains the <i>n</i> leftmost characters of the string.\n"
1361 "<code>left(string, length)</code><br>\n"
1363 "<h4>Arguments</h4>\n"
1364 "<code>string</code> - is string. The string.\n"
1366 "<code>length</code> - is int. The number of characters from the left to return.\n"
1368 "<h4>Example</h4>\n"
1369 "<!-- Show example of function.-->\n"
1370 "<code>left('Hello World',5) → 'Hello'</code><br>\n"
1374 "Returns the length of a string.\n"
1376 "<p><h4>Syntax</h4>\n"
1377 " length(<i>string</i>)</p>\n"
1379 "<p><h4>Arguments</h4>\n"
1380 "<!-- List args for functions here-->\n"
1381 "<i> string</i> → is string. The String to count the length of.</p>\n"
1383 "<p><h4>Example</h4>\n"
1384 "<!-- Show example of function.-->\n"
1385 " length('HELLO') → 5</p>\n"
1388 "Returns the value of the natural logarithm of the passed expression.\n"
1390 "This function takes one argument.\n"
1392 "<code>ln(value)</code><br>\n"
1394 "<h4>Arguments</h4>\n"
1395 "<code>value</code> - any positive number.\n"
1398 "<h4>Example</h4>\n"
1399 "<!-- Show example of function.-->\n"
1400 "<code>ln(1) → 0</code><br>\n"
1401 "<code>ln(2.7182818284590452354) → 1</code><br>\n"
1404 "Returns the value of the logarithm of the passed value and base.\n"
1406 "This function takes two arguments.\n"
1408 "<code>log(base, value)</code><br>\n"
1410 "<h4>Arguments</h4>\n"
1411 "<code>base</code> - any positive number.<br>\n"
1412 "<code>value</code> - any positive number.\n"
1415 "<h4>Example</h4>\n"
1416 "<!-- Show example of function.-->\n"
1417 "<code>log(2, 32) → 5</code><br>\n"
1418 "<code>log(0.5, 32) → -5</code><br>\n"
1421 "Returns the value of the base 10 logarithm of the passed expression.\n"
1423 "This function takes one argument.\n"
1425 "<code>log10(value)</code><br>\n"
1427 "<h4>Arguments</h4>\n"
1428 "<code>value</code> - any positive number.\n"
1431 "<h4>Example</h4>\n"
1432 "<!-- Show example of function.-->\n"
1433 "<code>log10(1) → 0</code><br>\n"
1434 "<code>log10(100) → 2</code><br>\n"
1437 "Converts a string to lower case letters.\n"
1439 "<p><h4> Syntax</h4>\n"
1440 " lower(<i>string</i>)</p>\n"
1442 "<p><h4> Arguments</h4>\n"
1443 "<i> string</i> → is string. The String to convert to lower case.</p>\n"
1445 "<p><h4> Example</h4>\n"
1446 " lower('HELLO World') → 'hello world'</p>\n"
1449 "Returns a string with supplied width padded\n"
1450 "using the fill character.\n"
1453 "<code>lpad(string, length, fill)</code><br>\n"
1455 "<h4>Arguments</h4>\n"
1456 "<code>string</code> - is string. The string.\n"
1458 "<code>length</code> - is int. The length of the new string.\n"
1460 "<code>fill</code> - is char. The character to padd the remaining space with. \n"
1462 "<h4>Example</h4>\n"
1463 "<!-- Show example of function.-->\n"
1464 "<code>lpad('Hello', 10, 'x') → 'Helloxxxxx'</code><br>\n"
1467 "Returns the largest value in a set of values.\n"
1470 " max(<i>value<i>[,<i>value</i>...])\n"
1472 "<h4>Arguments</h4>\n"
1473 "<!-- List args for functions here-->\n"
1474 "<i> value</i> → a number.<br>\n"
1476 "<h4>Example</h4>\n"
1477 "<!-- Show example of function.-->\n"
1478 " max(2,10.2,5.5) → 10.2\n"
1481 "Returns the smallest value in a set of values.\n"
1484 " min(<i>value<i>[,<i>value</i>...])\n"
1486 "<h4>Arguments</h4>\n"
1487 "<!-- List args for functions here-->\n"
1488 "<i> value</i> → a number.<br>\n"
1490 "<h4>Example</h4>\n"
1491 "<!-- Show example of function.-->\n"
1492 " min(20.5,10,6.2) → 6.2\n"
1495 "Extract the minute from a datetime or time, or the number of minutes\n"
1496 "from a <code>Interval</code>\n"
1499 "<code>minute(datetime)</code><br>\n"
1500 "<code>minute(Interval)</code><br>\n"
1502 "<h4>Arguments</h4>\n"
1503 "<code>date</code> - is datetime or time. The date to extract the minute from.\n"
1505 "<code>Interval</code> - is Interval. The Interval to return the number of minutes from.\n"
1507 "<h4>Example</h4>\n"
1508 "<!-- Show example of function.-->\n"
1509 "<code>minute('2012-07-22T13:24:57') → 24</code><br>\n"
1510 "<code>minute(tointerval('3 minutes')) → 3</code><br>\n"
1511 "<code>minute(age('2012-07-22T00:20:00','2012-07-22T00:00:00')) → 20</code><br>\n"
1512 "<code>minute(age('2012-01-01','2010-01-01')) → 1051200</code><br>\n"
1516 "Extract the month part from a date, or the number of months\n"
1517 "from a <code>Interval</code>\n"
1520 "<code>month(date)</code><br>\n"
1521 "<code>month(Interval)</code><br>\n"
1523 "<h4>Arguments</h4>\n"
1524 "<code>date</code> - is date or datetime. The date to extract the month from.\n"
1526 "<code>Interval</code> - is Interval. The Interval to return the number of months from.\n"
1528 "<h4>Example</h4>\n"
1529 "<!-- Show example of function.-->\n"
1530 "<code>month('2012-05-12') → 05</code><br>\n"
1531 "<code>month(tointerval('3 months')) → 3</code><br>\n"
1532 "<code>month(age('2012-01-01','2010-01-01')) → 4.033...</code><br>\n"
1536 "Returns the current date and time\n"
1539 "<pre>now()</pre>\n"
1541 "<h4>Arguments</h4>\n"
1544 "<h4>Example</h4>\n"
1545 "<pre>now() → 2012-07-22T13:24:57</pre>\n"
1549 "Returns 1 if the geometries share space, are of the same dimension, but are not completely contained by each other.\n"
1552 "<pre>overlaps( a, b )</pre>\n"
1554 "<h4>Arguments</h4>\n"
1555 "a → geometry\n"
1556 "b → geometry\n"
1558 "<h4>Example</h4>\n"
1559 "<pre> overlaps( geomFromWKT( 'LINESTRING(3 5 , 4 4 , 5 5 , 5 3)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
1560 "<pre> overlaps( geomFromWKT( 'LINESTRING(0 0 , 1 1)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 0</pre>\n"
1563 "Returns pi as value for calculations\n"
1568 "<h4>Arguments</h4>\n"
1571 "<h4>Example</h4>\n"
1572 "<pre>pi() → 3.14159265358979</pre>\n"
1575 "<h3>ramp_color() function</h3>\n"
1576 "Returns a string representing a color from a color ramp. \n"
1578 "<p><h4>Syntax</h4>\n"
1579 " ramp_color(<i>ramp_name,value</i>)</p>\n"
1581 "<p><h4>Arguments</h4>\n"
1582 "<!-- List args for functions here-->\n"
1583 "<i> ramp_name</i> → the name of the color ramp as a string, for example 'Spectral'.<br>\n"
1584 "<i> value</i> → the position on the ramp to select the color from as a real number between 0 and 1.<br>\n"
1586 "<p><h4>Example</h4>\n"
1587 "<!-- Show example of function.-->\n"
1588 " ramp_color('Spectral',0.3) → '253,190,115,255'</p>\n"
1590 "<p><h4>Note:</h4>\n"
1591 "The color ramps available vary between QGIS installations. This function\n"
1592 "may not give the expected results if you move your Quantum project.\n"
1596 "Returns a random integer within the range specified by the minimum and \n"
1597 "maximum argument (inclusive).\n"
1599 "This function takes two arguments.\n"
1601 "<code>rand(min, max)</code><br>\n"
1603 "<h4>Arguments</h4>\n"
1604 "<code>min</code> - an integer representing the smallest possible random number desired.<br>\n"
1605 "<code>max</code> - an integer representing the largest possible random number desired.\n"
1608 "<h4>Example</h4>\n"
1609 "<!-- Show example of function.-->\n"
1610 "<code>rand(1, 10) → 8</code><br>\n"
1613 "Returns a random float within the range specified by the minimum and \n"
1614 "maximum argument (inclusive).\n"
1616 "This function takes two arguments.\n"
1618 "<code>randf(min, max)</code><br>\n"
1620 "<h4>Arguments</h4>\n"
1621 "<code>min</code> - a float representing the smallest possible random number desired.<br>\n"
1622 "<code>max</code> - a float representing the largest possible random number desired.\n"
1625 "<h4>Example</h4>\n"
1626 "<!-- Show example of function.-->\n"
1627 "<code>randf(1, 10) → 4.59258286403147</code><br>\n"
1630 "Returns true if any part of a string matches the supplied regular expression.\n"
1632 "<p><h4>Syntax</h4>\n"
1633 " regexp_match(<i>string,regex</i>)</p>\n"
1635 "<p><h4>Arguments</h4>\n"
1636 "<!-- List args for functions here-->\n"
1637 "<i> string</i> → is string. The string to test against the regular expression.<br>\n"
1638 "<i> regex</i> → is string. The regular expression to test against. Backslash characters must be double escaped (eg \"\\s\" to match a white space character). Non-greedy regular expressions are not supported.<br>\n"
1640 "<p><h4>Example</h4>\n"
1641 "<!-- Show example of function.-->\n"
1642 " regexp_match('QGIS ROCKS','\\sROCKS') → 1</p>\n"
1645 "Returns a string with the supplied regular expression replaced.\n"
1647 "<p><h4>Syntax</h4>\n"
1648 " regexp_replace(<i>string,regex,after</i>)</p>\n"
1650 "<p><h4>Arguments</h4>\n"
1651 "<!-- List args for functions here-->\n"
1652 "<i> string</i> → is string. The start string.<br>\n"
1653 "<i> regex</i> → is string. The regular expression to replace. Backslash characters must be double escaped (eg \"\\s\" to match a white space character). Non-greedy regular expressions are not supported.<br>\n"
1654 "<i> after</i> → is string. The string that will replace any matching occurences of the supplied regular expression. Captured groups can be inserted into the replacement string using \\1, \\2, etc. <br></p>\n"
1656 "<p><h4>Example</h4>\n"
1657 "<!-- Show example of function.-->\n"
1658 " regexp_replace('QGIS SHOULD ROCK','\\sSHOULD\\s',' DOES ') → 'QGIS DOES ROCK'</p>\n"
1661 "Returns the portion of a string which matches a supplied regular expression.\n"
1663 "<p><h4>Syntax</h4>\n"
1664 " regexp_substr(<i>string,regex</i>)</p>\n"
1666 "<p><h4>Arguments</h4>\n"
1667 "<!-- List args for functions here-->\n"
1668 "<i> string</i> → is string. The input string.<br>\n"
1669 "<i> regex</i> → is string. The regular expression to match against. Backslash characters must be double escaped (eg \"\\s\" to match a white space character). Non-greedy regular expressions are not supported.<br>\n"
1671 "<p><h4>Example</h4>\n"
1672 "<!-- Show example of function.-->\n"
1673 " regexp_substr('abc123','(\\d+)') → '123'</p>\n"
1676 "Returns a string with the the supplied string replaced.\n"
1678 "<p><h4>Syntax</h4>\n"
1679 " replace(<i>string,before,after</i>)</p>\n"
1681 "<p><h4>Arguments</h4>\n"
1682 "<!-- List args for functions here-->\n"
1683 "<i> string</i> → is string. The start string.<br>\n"
1684 "<i> before</i> → is string. The string to replace.<br>\n"
1685 "<i> after</i> → is string. The string that will replace <i>before</i><br></p>\n"
1687 "<p><h4>Example</h4>\n"
1688 "<!-- Show example of function.-->\n"
1689 " replace('QGIS SHOULD ROCK','SHOULD','DOES') → 'QGIS DOES ROCK'</p>\n"
1692 "Returns a substring that contains the <i>n</i> rightmost characters of the string.\n"
1695 "<code>right(string, pos)</code><br>\n"
1697 "<h4>Arguments</h4>\n"
1698 "<code>string</code> - is string. The string.\n"
1700 "<code>length</code> - is int. The number of characters from the right to return.\n"
1702 "<h4>Example</h4>\n"
1703 "<!-- Show example of function.-->\n"
1704 "<code>right('Hello World',5) → 'World'</code><br>\n"
1708 "Rounds a number to number of decimal places.\n"
1710 "This function can take one or two arguments depending on what is needed.\n"
1712 "<code>round(decimal,places)</code><br>\n"
1713 "<code>round(decimal)</code><br>\n"
1715 "<h4>Arguments</h4>\n"
1716 "<code>decimal</code> - is decimal. The decimal number to be rounded.\n"
1718 "<code>places</code> - is int. The number of places to round decimal too. Can be negative.\n"
1720 "<h4>Example</h4>\n"
1721 "<!-- Show example of function.-->\n"
1722 "<code>round(1234.567, 2 ) → 1234.57</code><br>\n"
1723 "use <code>round(decimal)</code> to round to the nearest integer<br>\n"
1724 "<code>round(1234.567) → 1235</code><br>\n"
1729 "Returns a string with supplied width padded\n"
1730 "using the fill character.\n"
1733 "<code>rpad(string, width, fill)</code><br>\n"
1735 "<h4>Arguments</h4>\n"
1736 "<code>string</code> - is string. The string.\n"
1738 "<code>width</code> - is int. The length of the new string.\n"
1740 "<code>fill</code> - is char. The character to padd the remaining space with. \n"
1742 "<h4>Example</h4>\n"
1743 "<!-- Show example of function.-->\n"
1744 "<code>rpad('Hello', 10, 'x') → 'xxxxxHello'</code><br>\n"
1748 "Transforms a given value from an input domain to an output range using an exponential curve. This function can be used to ease values in or out \n"
1749 "of the specified output range. \n"
1751 "<p><h4>Syntax</h4>\n"
1752 " scale_exp(<i>val</i>,<i>domain_min</i>,<i>domain_max</i>,<i>range_min</i>,<i>range_max</i>,<i>exponent</i>)</p>\n"
1754 "<p><h4>Arguments</h4>\n"
1755 "<!-- List args for functions here-->\n"
1756 "<i> val</i> → is a value in the input domain. The function will return a corresponding scaled value in the output range.<br>\n"
1757 "<i> domain_min, domain_max</i> → specify the input domain, the smallest and largest values the input <i>val</i> should take.<br>\n"
1758 "<i> range_min, range_max</i> → specify the output range, the smallest and largest values which should be output by the function.<br>\n"
1759 "<i> exponent</i> → a positive value (greater than 0), which dictates the way input values are mapped to the output range. Large exponents will cause the output values to 'ease in', starting slowly before\n"
1760 "accelerating as the input values approach the domain maximum. Smaller exponents (less than 1) will cause output values to 'ease out', where the mapping starts quickly but slows as it approaches the domain maximum.<br>\n"
1762 "<h4>Example</h4>\n"
1763 "<!-- Show example of function.-->\n"
1764 "<b>Easing in, using an exponent of 2:</b><br>\n"
1765 " scale_exp(5,0,10,0,100,2) → 25<br>\n"
1766 " scale_exp(7.5,0,10,0,100,2) → 56.25<br>\n"
1767 " scale_exp(9.5,0,10,0,100,2) → 90.25<br> \n"
1769 "<b>Easing out, using an exponent of 0.5:</b><br> \n"
1770 " scale_exp(3,0,10,0,100,0.5) → 54.772<br>\n"
1771 " scale_exp(6,0,10,0,100,0.5) → 77.459<br>\n"
1772 " scale_exp(9,0,10,0,100,0.5) → 94.868<br> \n"
1777 "Transforms a given value from an input domain to an output range using linear interpolation. \n"
1779 "<p><h4>Syntax</h4>\n"
1780 " scale_linear(<i>val</i>,<i>domain_min</i>,<i>domain_max</i>,<i>range_min</i>,<i>range_max</i>)</p>\n"
1782 "<p><h4>Arguments</h4>\n"
1783 "<!-- List args for functions here-->\n"
1784 "<i> val</i> → is a value in the input domain. The function will return a corresponding scaled value in the output range.<br>\n"
1785 "<i> domain_min, domain_max</i> → specify the input domain, the smallest and largest values the input <i>val</i> should take.<br>\n"
1786 "<i> range_min, range_max</i> → specify the output range, the smallest and largest values which should be output by the function.<br>\n"
1788 "<h4>Example</h4>\n"
1789 "<!-- Show example of function.-->\n"
1790 " scale_linear(5,0,10,0,100) → 50<br>\n"
1791 " scale_linear(0.2,0,1,0,360) → 72 <i>(eg, scaling a value between 0 and 1 to an angle between 0 and 360)</i><br>\n"
1792 " scale_linear(1500,1000,10000,9,20) → 10.22 <i>(eg, scaling a population which varies between 1000 and 10000 to a font size between 9 and 20)</i><br>\n"
1797 "Extract the seconds from a datetime or time, or the number of seconds\n"
1798 "from a <code>Interval</code>\n"
1801 "<code>second(datetime)</code><br>\n"
1802 "<code>second(Interval)</code><br>\n"
1804 "<h4>Arguments</h4>\n"
1805 "<code>date</code> - is datetime or time. The date to extract the second from.\n"
1807 "<code>Interval</code> - is Interval. The Interval to return the number of seconds from.\n"
1809 "<h4>Example</h4>\n"
1810 "<!-- Show example of function.-->\n"
1811 "<code>second('2012-07-22T13:24:57') → 57</code><br>\n"
1812 "<code>second(tointerval('3 seconds')) → 3</code><br>\n"
1813 "<code>second(age('2012-07-22T00:20:00','2012-07-22T00:00:00')) → 1200</code><br>\n"
1814 "<code>second(age('2012-01-01','2010-01-01')) → 63072000</code><br>\n"
1818 "Returns sinus of an angle.\n"
1821 "<p><h4>Syntax</h4>\n"
1822 " sin(<i>real</i>)</p>\n"
1824 "<p><h4>Arguments</h4>\n"
1825 "<i>real</i> → angle in radians.</p>\n"
1827 "<p><h4>Example</h4>\n"
1828 " sin(1.571) → 0.999999682931835</p>\n"
1831 "Returns square root of a value\n"
1834 "<p><h4>Syntax</h4>\n"
1835 " sqrt(<i>real</i>)</p>\n"
1837 "<p><h4>Arguments</h4>\n"
1838 "<i>real</i> → number.</p>\n"
1840 "<p><h4>Example</h4>\n"
1841 " sqrt(9) → 3</p>\n"
1844 "Return the index of a regular expression in a string.\n"
1847 " strpos(<i>haystack</i>, <i>needle</i>)\n"
1849 "Returns -1 if the expression isn't found.\n"
1851 "<p><h4>Arguments</h4>\n"
1852 "<!-- List args for functions here-->\n"
1853 "<i> haystack</i> → is string. The string that is to be searched.<br>\n"
1854 "<i> needle</i> → is string. The regular expression to look for.<br>\n"
1856 "<h4>Example</h4>\n"
1857 "<!-- Show example of function.-->\n"
1858 " strpos('HELLO WORLD','WORLD') → 6<br>\n"
1859 " strpos('HELLO WORLD','GOODBYE') → -1<br>\n"
1862 "Return a part of a string\n"
1864 "<p><h4>Syntax</h4>\n"
1865 " substr(<i>string,startpos,length</i>)</p>\n"
1867 "<p><h4>Arguments</h4>\n"
1868 "<!-- List args for functions here-->\n"
1869 "<i> string</i> → is string. The full string.<br>\n"
1870 "<i> startpos</i> → is number. The start position to extract from.<br>\n"
1871 "<i> length</i> → is number. The length of the string to extract.<br></p>\n"
1873 "<p><h4>Example</h4>\n"
1874 "<!-- Show example of function.-->\n"
1875 " substr('HELLO WORLD',3,5) → 'LLO W'</p>\n"
1878 "Returns a geometry that represents the portions of a and b that do not intersect.\n"
1881 "<pre>sym_difference( geometry a, geometry b)</pre>\n"
1883 "<h4>Arguments</h4>\n"
1884 "geometry → geometry\n"
1885 "geometry → geometry\n"
1887 "<h4>Example</h4>\n"
1888 "<pre> geom_to_wkt( sym_difference( geom_from_wkt( 'LINESTRING(3 3 , 4 4 , 5 5)' ) , geom_from_wkt( 'LINESTRING(3 3 , 8 8)' )) ) → returns LINESTRING(5 5, 8 8)</pre>\n"
1891 "Returns tangent of an angle.\n"
1894 "<p><h4>Syntax</h4>\n"
1895 " tan(<i>real</i>)</p>\n"
1897 "<p><h4>Arguments</h4>\n"
1898 "<i>real</i> → angle in radians.</p>\n"
1900 "<p><h4>Example</h4>\n"
1901 " tan(1.0) → 1.5574077246549</p>\n"
1904 "Converts all words of a string to title case (all words lower case with leading\n"
1905 "capital letter).\n"
1907 "<p><h4>Syntax</h4>\n"
1908 " title(<i>string</i>)</p>\n"
1910 "<p><h4>Arguments</h4>\n"
1911 "<!-- List args for functions here-->\n"
1912 "<i> string</i> → is string. The string to convert to title case.</p>\n"
1914 "<p><h4>Example</h4>\n"
1915 "<!-- Show example of function.-->\n"
1916 " upper('hello WOrld') → 'Hello World'</p>\n"
1919 "Convert a string into Qt data type.\n"
1922 "<code>to_date('string')</code><br>\n"
1924 "<h4>Arguments</h4>\n"
1925 "<code>string</code> - is string in Qt date format.\n"
1928 "<h4>Example</h4>\n"
1929 "<!-- Show example of function.-->\n"
1930 "<code>to_date('2012-05-04') → 2012-05-04</code><br>\n"
1933 "Convert a string into Qt data time type.\n"
1936 "<code>to_datetime('string')</code><br>\n"
1938 "<h4>Arguments</h4>\n"
1939 "<code>string</code> - is string in Qt date time format.\n"
1942 "<h4>Example</h4>\n"
1943 "<!-- Show example of function.-->\n"
1944 "<code>to_datetime('2012-05-04 12:50:00') → 2012-05-04T12:50:00</code><br>\n"
1947 "Converts a string to integer number. Nothing changed if a value cannot be converted to integer (e.g '123asd' is invalid).\n"
1949 "<p><h4>Syntax</h4>\n"
1950 " to_int(<i>string</i>)</p>\n"
1952 "<p><h4>Arguments</h4>\n"
1953 "<!-- List args for functions here-->\n"
1954 "<i> string</i> → is string. The String to convert to integer number.</p>\n"
1956 "<p><h4>Example</h4>\n"
1957 "<!-- Show example of function.-->\n"
1958 " to_int('123') → 123</p>\n"
1961 "Converts a string to a interval type. Can be used to take days, hours, month, etc off a date. \n"
1964 "<code>to_interval('string')</code><br>\n"
1966 "<h4>Arguments</h4>\n"
1967 "<code>string</code> - is string. Format {n} days {n} hours {n} months\n"
1970 "<h4>Example</h4>\n"
1971 "<!-- Show example of function.-->\n"
1972 "<code>todatetime('2012-05-05 12:00:00') - to_interval('1 day 2 hours') → 2012-05-04T10:00:00</code><br>\n"
1975 "Converts a string to real number. Nothing changed if a value cannot be converted to real (e.g '123.56asd' is invalid). Numbers are rounded after saving changes if the precision is smaller than the result of the conversion.\n"
1977 "<p><h4>Syntax</h4>\n"
1978 " to_real(<i>string</i>)</p>\n"
1980 "<p><h4>Arguments</h4>\n"
1981 "<!-- List args for functions here-->\n"
1982 "<i> string</i> → is string. The String to convert to real number.</p>\n"
1984 "<p><h4>Example</h4>\n"
1985 "<!-- Show example of function.-->\n"
1986 " to_real('123.45') → 123.45</p>\n"
1989 "Converts a number to string.\n"
1991 "<p><h4>Syntax</h4>\n"
1992 " to_string(<i>number</i>)</p>\n"
1994 "<p><h4>Arguments</h4>\n"
1995 "<!-- List args for functions here-->\n"
1996 "<i>number</i> → is integer or real. The number to convert to string.</p>\n"
1998 "<p><h4>Example</h4>\n"
1999 "<!-- Show example of function.-->\n"
2000 " to_string(123) → '123'</p>\n"
2003 "Convert a string into Qt time type.\n"
2006 "<code>to_time('string')</code><br>\n"
2008 "<h4>Arguments</h4>\n"
2009 "<code>string</code> - is string in Qt time format.\n"
2012 "<h4>Example</h4>\n"
2013 "<!-- Show example of function.-->\n"
2014 "<code>to_time('12:30:01') → 12:30:01</code><br>\n"
2017 "Returns 1 if the geometries have at least one point in common, but their interiors do not intersect.\n"
2020 "<pre>touches( a, b )</pre>\n"
2022 "<h4>Arguments</h4>\n"
2023 "a → geometry\n"
2024 "b → geometry\n"
2026 "<h4>Example</h4>\n"
2027 "<pre> touches( geomFromWKT( 'LINESTRING(5 3 , 4 4)' ) , geomFromWKT( 'LINESTRING(3 3 , 4 4 , 5 5)' )) → returns 1</pre>\n"
2028 "<pre> touches( geomFromWKT( 'POINT(4 4)' ) , geomFromWKT( 'POINT(5 5)' )) → returns 0</pre>\n"
2031 "Returns the geometry transformed from the source CRS to the dest CRS.\n"
2034 "<pre>transform( geom, sAuthId, dAuthId )</pre>\n"
2036 "<h4>Arguments</h4>\n"
2037 "geom → QgsGeometry\n"
2039 "sCrsId → the Source Auth CRS Id\n"
2041 "dCrsId → the Dest Auth CRS Id\n"
2043 "<h4>Example</h4>\n"
2044 "<pre> geomToWKT( transform( $geometry, 'EPSG:2154', 'EPSG:4326' ) ) → POINT(0 51)</pre>\n"
2047 "Removes all leading and trailing whitespace (spaces, tabs, etc) from a string.\n"
2049 "<p><h4>Syntax</h4>\n"
2050 " trim(<i>string</i>)</p>\n"
2052 "<p><h4>Arguments</h4>\n"
2053 "<!-- List args for functions here-->\n"
2054 "<i> string</i> → is string. The string to trim.</p>\n"
2056 "<p><h4>Example</h4>\n"
2057 "<!-- Show example of function.-->\n"
2058 " trim(' hello world ') → 'hello world'</p>\n"
2061 "Returns a geometry that represents the point set union of the geometries.\n"
2064 "<pre>union( a, b )</pre>\n"
2066 "<h4>Arguments</h4>\n"
2067 "a → geometry\n"
2068 "b → geometry\n"
2070 "<h4>Example</h4>\n"
2071 "<pre> geomToWKT( union( geomFromWKT( 'POINT(4 4)' ) , geomFromWKT( 'POINT(5 5)' )) ) → returns MULTIPOINT(4 4, 5 5)</pre>\n"
2074 "Converts a string to upper case letters.\n"
2076 "<p><h4>Syntax</h4>\n"
2077 " upper(<i>string</i>)</p>\n"
2079 "<p><h4>Arguments</h4>\n"
2080 "<!-- List args for functions here-->\n"
2081 "<i> string</i> → is string. The String to convert to upper case.</p>\n"
2083 "<p><h4>Example</h4>\n"
2084 "<!-- Show example of function.-->\n"
2085 " upper('hello WOrld') → 'HELLO WORLD'</p>\n"
2088 "Generates a Universally Unique Identifier (UUID) for each row using the Qt\n"
2089 "<a href='http://qt-project.org/doc/qt-4.8/quuid.html#createUuid'>QUuid::createUuid</a>\n"
2090 "method. Each UUID is 38 characters long.\n"
2093 "<pre>uuid()</pre>\n"
2095 "<h4>Arguments</h4>\n"
2098 "<h4>Example</h4>\n"
2099 "<pre>uuid() → {0bd2f60f-f157-4a6d-96af-d4ba4cb366a1}</pre>\n"
2102 "Extract the week number from a date, or the number of weeks\n"
2103 "from a <code>Interval</code>\n"
2106 "<code>week(date)</code><br>\n"
2107 "<code>week(Interval)</code><br>\n"
2109 "<h4>Arguments</h4>\n"
2110 "<code>date</code> - is date or datetime. The date to extract the week from.\n"
2112 "<code>Interval</code> - is Interval. The Interval to return the number of weeks from.\n"
2114 "<h4>Example</h4>\n"
2115 "<!-- Show example of function.-->\n"
2116 "<code>week('2012-05-12') → 19</code><br>\n"
2117 "<code>week(tointerval('3 weeks')) → 3</code><br>\n"
2118 "<code>week(age('2012-01-01','2010-01-01')) → 104.285...</code><br>\n"
2122 "Returns 1 if the geometry a is completely inside geometry b\n"
2125 "<pre>within( geometry a , geometry b)</pre>\n"
2127 "<h4>Arguments</h4>\n"
2128 "geometry → geometry\n"
2129 "geometry → geometry\n"
2131 "<h4>Example</h4>\n"
2132 "<pre> within( geomFromWKT( 'POINT( 0.5 0.5 )') , geomFromWKT('POLYGON((0 0 , 0 1 , 1 1 , 1 0 , 0 0 ))' ) ) → returns 1</pre>\n"
2133 "<pre> within( geomFromWKT( 'POINT( 5 5 )') , geomFromWKT('POLYGON((0 0 , 0 1 , 1 1 , 1 0 , 0 0 ))' ) ) → returns 0</pre>\n"
2136 "Returns a string wrapped to a maximum/minimum number of characters.\n"
2138 "<p><h4>Syntax</h4>\n"
2139 " wordwrap(<i>string,wrap_length[,delimiter_string]</i>)</p>\n"
2141 "<p><h4>Arguments</h4>\n"
2142 "<!-- List args for functions here-->\n"
2143 "<i> string</i> → is string. The string to be wrapped.<br>\n"
2144 "<i> wrap_length</i> → is number. If positive, the number represents the ideal maximum number of characters to wrap; if negative, the number represents the minimum number of characters to wrap.<br>\n"
2145 "<i> delimiter_string</i> → is string. The delimiter string to wrap to a new line (<u>optional</u>).<br></p>\n"
2147 "<p><h4>Example</h4>\n"
2148 "<!-- Show example of function.-->\n"
2149 " wordwrap('UNIVERSITY OF QGIS',13) → 'UNIVERSITY OF\nQGIS'<br>\n"
2150 " wordwrap('UNIVERSITY OF QGIS',-3) → 'UNIVERSITY\nOF QGIS'</p>\n"
2153 "Retrieves a x coordinate of the current feature\n"
2156 "<code>x_at(i)</code>\n"
2158 "<h4>Arguments</h4>\n"
2159 "<code>i<code> - is int. index of point of a line (indices start at 0; negative values apply to the last index).\n"
2161 "<h4>Example</h4>\n"
2162 "<pre>x_at(1) → 5</pre>\n"
2165 "Returns the maximum x coordinate of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
2168 "<pre>x_max(geom)</pre>\n"
2170 "<h4>Arguments</h4>\n"
2171 "geom → a geometry\n"
2173 "<h4>Example</h4>\n"
2174 "<pre> x_max($geometry) → returns maximum x coordinate of $geometry</pre>\n"
2178 "Returns the minimum x coordinate of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
2181 "<pre>x_min(geom)</pre>\n"
2183 "<h4>Arguments</h4>\n"
2184 "geom → a geometry\n"
2186 "<h4>Example</h4>\n"
2187 "<pre> x_min($geometry) → returns minimum x coordinate of $geometry</pre>\n"
2191 "Retrieves a y coordinate of the current feature\n"
2194 "<code>y_at(i)</code>\n"
2196 "<h4>Arguments</h4>\n"
2197 "<code>i<code> - is int. index of point of a line (indices start at 0; negative values apply to the last index).\n"
2199 "<h4>Example</h4>\n"
2200 "<pre>y_at(1) → 5</pre>\n"
2203 "Returns the maximum y coordinate of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
2206 "<pre>y_max(geom)</pre>\n"
2208 "<h4>Arguments</h4>\n"
2209 "geom → a geometry\n"
2211 "<h4>Example</h4>\n"
2212 "<pre> y_max($geometry) → returns maximum y coordinate of $geometry</pre>\n"
2216 "Returns the minimum y coordinate of a geometry. Calculations are in the Spatial Reference System of this Geometry. \n"
2219 "<pre>y_min(geom)</pre>\n"
2221 "<h4>Arguments</h4>\n"
2222 "geom → a geometry\n"
2224 "<h4>Example</h4>\n"
2225 "<pre> y_min($geometry) → returns minimum y coordinate of $geometry</pre>\n"
2229 "Extract the year part from a date, or the number of years\n"
2230 "from a <code>Interval</code>\n"
2233 "<code>year(date)</code><br>\n"
2234 "<code>year(Interval)</code><br>\n"
2236 "<h4>Arguments</h4>\n"
2237 "<code>date</code> - is date or datetime. The date to extract the year from.\n"
2239 "<code>Interval</code> - is Interval. The Interval to return the number of years from.\n"
2241 "<h4>Example</h4>\n"
2242 "<!-- Show example of function.-->\n"
2243 "<code>year('2012-05-12') → 2012</code><br>\n"
2244 "<code>year(tointerval('3 Years')) → 3</code><br>\n"
2245 "<code>year(age('2012-01-01','2010-01-01')) → 1.9986..</code><br>\n"
iterator insert(const Key &key, const T &value)
static QHash< QString, QString > gFunctionHelpTexts
QString translate(const char *context, const char *sourceText, const char *disambiguation, Encoding encoding)
static void initFunctionHelp()
1.8.6