Skip to content

Commit 49f9c13

Browse files
authored
Merge pull request #1188 from mmd-osm/patch/issue_1178
Added details get_bbox() documentation
2 parents 7980d08 + eaff28c commit 49f9c13

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/flex.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,12 @@ The parameter table (`object`) has the following fields:
143143
tag from the list of tags. (Example: `local name = object:grab_tag('name')`)
144144
This is often used when you want to store some tags in special columns and
145145
the rest of the tags in an hstore column.
146-
* `get_bbox()`: Get the bounding box of the current node or way. (It doesn't
147-
work for relations currently.)
146+
* `get_bbox()`: Get the bounding box of the current node or way.
147+
This function returns four result values: the lot/lat values for the
148+
bottom left corner of the bounding box, followed by the lon/lat values
149+
of the top right corner. Both lon/lat values are identical in case of nodes.
150+
Example: `lon, lat, dummy, dummy = object.get_bbox()`
151+
(This function doesn't work for relations currently.)
148152

149153
Ways have the following additional fields:
150154
* `is_closed`: A boolean telling you whether the way geometry is closed, ie

0 commit comments

Comments
 (0)