Skip to content

Commit eaff28c

Browse files
committed
Added details get_bbox() documentation
1 parent d34b7a2 commit eaff28c

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
@@ -141,8 +141,12 @@ The parameter table (`object`) has the following fields:
141141
tag from the list of tags. (Example: `local name = object:grab_tag('name')`)
142142
This is often used when you want to store some tags in special columns and
143143
the rest of the tags in an hstore column.
144-
* `get_bbox()`: Get the bounding box of the current node or way. (It doesn't
145-
work for relations currently.)
144+
* `get_bbox()`: Get the bounding box of the current node or way.
145+
This function returns four result values: the lot/lat values for the
146+
bottom left corner of the bounding box, followed by the lon/lat values
147+
of the top right corner. Both lon/lat values are identical in case of nodes.
148+
Example: `lon, lat, dummy, dummy = object.get_bbox()`
149+
(This function doesn't work for relations currently.)
146150

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

0 commit comments

Comments
 (0)