Add expression function help

This commit is contained in:
Nathan Woodrow 2012-09-04 21:23:44 +10:00
parent 2ef60dadba
commit 72978cf615
3 changed files with 48 additions and 0 deletions

View File

@ -0,0 +1,12 @@
<h3>$scale function</h3>
Returns the current scale of the map canvas.
<br>
Note: This function is only available in some contexts and will be 0 otherwise.
<h4>Syntax</h4>
<code>$scale</code><br>
<h4>Example</h4>
<!-- Show example of function.-->
<code>$scale &rarr; 10000</code><br>

View File

@ -0,0 +1,16 @@
<h3>format_number() function</h3>
Returns a number formatted with the locale separator for thousands.
Also truncates the number to the number of supplied places.
<h4>Syntax</h4>
<code>format_number(number,places)</code><br>
<h4>Arguments</h4>
<code>number</code> - is number. The number to be formatted.
<br>
<code>places</code> - is int. The number of decimal places to truncate the string
to.
<h4>Example</h4>
<!-- Show example of function.-->
<code>format_number(10000000.332,2) &rarr; 10,000,000.33</code>

View File

@ -0,0 +1,20 @@
<h3>round() function</h3>
Rounds a number to number of decimal places.
<br>
This function can take one or two arguments depending on what is needed.
<h4>Syntax</h4>
<code>round(decimal,places)</code><br>
<code>round(decimal)</code><br>
<h4>Arguments</h4>
<code>decimal</code> - is decimal. The decimal number to be rounded.
<br>
<code>places</code> - is int. The number of places to round decimal too. Can be negative.
<h4>Example</h4>
<!-- Show example of function.-->
<code>round(1234.567, 2 ) &rarr; 1234.57</code><br>
use <code>round(decimal)</code> to round to the nearest integer<br>
<code>round(1234.567) &rarr; 1235</code><br>