Skip to content

GEO helper docs correction #9352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ZbyszekMM wants to merge 1 commit into
base: staging
Choose a base branch
from
Open

GEO helper docs correction #9352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/scenariosAuthoring/functionsAndMethods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,10 +258,11 @@ Some useful constants are also available:

### GEO - simple distance measurements

- `#GEO.distanceInKm(Number,Number,Number,Number)` - calculate distance in km between two points (with decimal coordinates), using haversine algorithm
- `#GEO.distanceInKm(pl.touk.nussknacker.engine.util.functions.Point,pl.touk.nussknacker.engine.util.functions.Point)` - calculate distance in km between two points (with decimal coordinates), using haversine algorithm
- `#GEO.toPoint(Number,Number)` -> pl.touk.nussknacker.engine.util.functions.Point

- `#GEO.azimuth(Number latitude1, Number longitude1, latitude2 Number, Number longitude2)` -> `Double` - calculate initial bearing (azimuth) in degrees from the first point to the second point. Result in range [0, 360).
- `#GEO.closestPointOnLine(Number latitudeA, Number longitudeA, Number latitudeB, Number longitudeB, Number latitudeC, Number longitudeC)` -> `List[Double]` - calculate the closest point on the line segment AB to point C. Returns [latitude, longitude].
- `#GEO.distanceInKm(Number latitude1, Number longitude1, Number latitude2, Number longitude2)` -> `Double` - calculate distance in km between two points (with decimal coordinates), using haversine algorithm
- `#GEO.midpoint(Number latitude1, Number longitude1, Number latitude2, Number longitude2)` -> `List[Double]` - calculate geographic midpoint between two points on Earth. Returns [latitude, longitude].

### NUMERIC - number parsing

- `#NUMERIC.abs(Number)` - returns the absolute value of a value.
Expand Down
7 changes: 4 additions & 3 deletions docs/scenariosAuthoring/functionsAndMethodsListing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords: ["functions", "methods", "SpEL", "expressions"]

# Functions and Methods Listing

<!-- This document is for Assistant only -->
<!-- This document is for Assistant only - it is more more comprehensive that the document for humans, however more repetitive -->

Functions and methods can be used in all [expression types](/docs/scenariosAuthoring/introduction.mdx#ways-of-providing-parameter-values) that support SpEL evaluation.

Expand Down Expand Up @@ -127,9 +127,10 @@ Functions and methods can be used in all [expression types](/docs/scenariosAutho
```
### GEO
```
.azimuth(Number latitude1, Number longitude1, latitude2 Number, Number longitude2)` -> Double - calculate initial bearing (azimuth) in degrees from the first point to the second point. Result in range [0, 360).
.distanceInKm(Number,Number,Number,Number) -> Double - calculate distance in km between two points (with decimal coordinates), using haversine algorithm
.distanceInKm(pl.touk.nussknacker.engine.util.functions.Point,pl.touk.nussknacker.engine.util.functions.Point) -> Double - calculate distance in km between two points (with decimal coordinates), using haversine algorithm
.toPoint(Number,Number) -> pl.touk.nussknacker.engine.util.functions.Point
.closestPointOnLine(Number latitudeA, Number longitudeA, Number latitudeB, Number longitudeB, Number latitudeC, Number longitudeC)` -> List[Double] - calculate the closest point on the line segment AB to point C. Returns [latitude, longitude].
.midpoint(Number latitude1, Number longitude1, Number latitude2, Number longitude2)` -> List[Double] - calculate geographic midpoint between two points on Earth. Returns [latitude, longitude].
```
### NUMERIC
```
Expand Down