Skip to content

Commit

Permalink
Update expression functions help
Browse files Browse the repository at this point in the history
  • Loading branch information
DelazJ committed Dec 27, 2024
1 parent 2c57e5c commit 5261b0a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Converts a given value to a boolean. The function will return false if the value
* - Examples
- * ``to_bool('')`` → false
* ``to_bool('123')`` → true
* ``to_bool('false')`` → true
* ``to_bool(0)`` → false
* ``to_bool(1)`` → true
* ``to_bool(null)`` → false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2408,7 +2408,7 @@ Read more on the underlying GEOS "Intersects" predicate, as described in PostGIS
Read more on the underlying GEOS predicate, as described in PostGIS `ST_MaximumInscribedCircle <https://postgis.net/docs/ST_MaximumInscribedCircle.html>`_ function.

This argument requires GEOS >= 3.9.
* **return_details** - Set this to true to return a list of maps containing (key names in quotes) the feature 'id', the expression 'result' and the 'overlap' value. The 'radius' of the maximum inscribed circle is also returned when the target layer is a polygon. Only valid when used with the expression parameter
* **return_details** - Set this to true to return a list of maps containing (key names in quotes) the feature 'id', the expression 'result' and the 'overlap' value (of the largest element in case of multipart). The 'radius' of the maximum inscribed circle is also returned when the target layer is a polygon. Only valid when used with the expression parameter
* **sort_by_intersection_size** - only valid when used with an expression, set this to 'des' to return the results ordered by the overlap value in descending order or set this to 'asc' for ascending order.
* - Examples
- * ``overlay_intersects('regions')`` → TRUE if the current feature spatially intersects a region
Expand Down
4 changes: 2 additions & 2 deletions docs/user_manual/expressions/expression_help/Math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -478,10 +478,10 @@ Transforms a given value from an input domain to an output range using an expone
* **range_max** - Specifies the maximum value in the output range, the largest value which should be output by the function.
* **exponent** - 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 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.
* - Examples
- * ``scale_exp(5,0,10,0,100,2)`` → 25
- * ``scale_exponential(5,0,10,0,100,2)`` → 3.030

easing in, using an exponent of 2
* ``scale_exp(3,0,10,0,100,0.5)`` → 54.772
* ``scale_exponential(3,0,10,0,100,0.5)`` → 87.585

easing out, using an exponent of 0.5

Expand Down

0 comments on commit 5261b0a

Please sign in to comment.