Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 2.13 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

xy point field type

An xy point field type contains a point in a two-dimensional Cartesian coordinate system, specified by x and y coordinates. It is based on the Lucene XYPoint field type. The xy point field type is similar to the geopoint field type, but does not have the range limitations of geopoint. The coordinates of an xy point are single-precision floating-point values. For information about the range and precision of floating-point values, see Numeric field types.

Example

Create a mapping with an xy point field type:

PUT testindex1
{
  "mappings": {
    "properties": {
      "point": {
        "type": "xy_point"
      }
    }
  }
}

Formats

xy points can be indexed in the following formats:

  • An object with x and y coordinates
PUT testindex1/_doc/1
{
  "point": { 
    "x": 0.5,
    "y": 4.5
  }
}

  • A string in the “x, y” format
PUT testindex1/_doc/2
{
  "point": "0.5, 4.5" 
}

  • An array in the [x, y] format
PUT testindex1/_doc/3
{
  "point": [0.5, 4.5] 
}


PUT testindex1/_doc/4
{
  "point": "POINT (0.5 4.5)"
}

  • GeoJSON format
PUT testindex1/_doc/5
{
  "point" : {
    "type" : "Point",
    "coordinates" : [0.5, 4.5]        
  }
}

In all xy point formats, the coordinates must be specified in the x, y order.

Parameters

The following table lists the parameters accepted by xy point field types. All parameters are optional.

Parameter Description
ignore_malformed A Boolean value that specifies to ignore malformed values and not to throw an exception. Default is false.
ignore_z_value Specific to points with three coordinates. If ignore_z_value is true, the third coordinate is not indexed but is still stored in the _source field. If ignore_z_value is false, an exception is thrown.
null_value A value to be used in place of null. The value must be of the same type as the field. If this parameter is not specified, the field is treated as missing when its value is null. Default is null.
350 characters left

Have a question? .

Want to contribute? or .