honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Clarify args for geoshape `orientation` (#64649) (#64698)

This commit is contained in:
James Rodewig 2020-11-06 07:57:22 -05:00 committed by GitHub
parent 33f703ef1f
commit 6c1b650e09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/reference/mapping/types/geo-shape.asciidoc
View File

@ -79,17 +79,32 @@ greater false positives. Note: This parameter is only relevant for `term` and
`recursive` strategies. `recursive` strategies.
| `0.025` | `0.025`
|`orientation` |Optionally define how to interpret vertex order for |`orientation`
polygons / multipolygons. This parameter defines one of two coordinate a|Optional. Vertex order for the shape's coordinates list.
system rules (Right-hand or Left-hand) each of which can be specified in three
different ways. 1. Right-hand rule: `right`, `ccw`, `counterclockwise`, This parameter sets and returns only a `RIGHT` (counterclockwise) or `LEFT`
2. Left-hand rule: `left`, `cw`, `clockwise`. The default orientation (clockwise) value. However, you can specify either value in multiple ways.
(`counterclockwise`) complies with the OGC standard which defines
outer ring vertices in counterclockwise order with inner ring(s) vertices (holes) To set `RIGHT`, use one of the following arguments or its uppercase
in clockwise order. Setting this parameter in the geo_shape mapping explicitly variant:
sets vertex order for the coordinate list of a geo_shape field but can be
overridden in each individual GeoJSON or WKT document. * `right`
| `ccw` * `counterclockwise`
* `ccw`
To set `LEFT`, use one of the following arguments or its uppercase
variant:
* `left`
* `clockwise`
* `cw`
Defaults to `RIGHT` to comply with https://www.ogc.org/docs/is[OGC standards].
OGC standards define outer ring vertices in counterclockwise order with inner
ring (hole) vertices in clockwise order.
Individual GeoJSON or WKT documents can override this parameter.
| `RIGHT`
|`points_only` |deprecated[6.6, PrefixTrees no longer used] Setting this option to |`points_only` |deprecated[6.6, PrefixTrees no longer used] Setting this option to
`true` (defaults to `false`) configures the `geo_shape` field type for point `true` (defaults to `false`) configures the `geo_shape` field type for point