API Reference / API Parameters / insidePolygon

Nov. 25, 2021

insidePolygon

Type: list of floats

Engine default: null

Parameter syntax

insidePolygon => [
  [
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  ],
  [ ... ] // you can search in multiple polygons
]

insidePolygon: [
  [
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  ],
  [ ... ] # you can search in multiple polygons
]

insidePolygon: [
  [
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  ],
  [ ... ] // you can search in multiple polygons
]

insidePolygon: [
  [
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  ],
  [ ... ] # you can search in multiple polygons
]

insidePolygon = [
   Polygon(
     point1: Point,
     point2: Point,
     point3: Point,
     ...
   ),
   Polygon(// you can search in multiple polygons)
]

insidePolygon {
    +Polygon(
        [Point(46.650828100116044f, 7.123046875f),
        Point(45.17210966999772f, 1.009765625f),
        Point(49.62625916704081f, 4.6181640625f),
        ...]
    )
    +... // you can search in multiple polygon
}

index.Search<T>(new Query("query")
{
  InsidePolygon = new List<List<float>>
  {
      new List<float>
      {
          point1_lat,
          point1_lng,
          point2_lat,
          point2_lng,
          point3_lat,
          point3_lng
      },
      new List<float>
      {
          ...  // you can search in multiple polygons
      }
  }
});

.setInsidePolygon(
  Arrays.asList(
    Arrays.asList(p1_lat, p1_lng, p2_lat, p2_lng, p3_lat, p3_lng),
    ... // you can search in multiple polygons
  )
)

opt.InsidePolygon([][]float64{
  {
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  },
  { ... }, // you can search in multiple polygons
})

insidePolygon = Some(Seq(
  InsidePolygon(
    p1_lat,
    p1_lng,
    p2_lat,
    p2_lng,
    p3_lat,
    p3_lng,
    ...
  ),
  InsidePolygon( // you can search in multiple polygons
    ...
  )
))

Can be used in these methods:
search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, delete_by, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, deleteObjectBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, DeleteBy, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, deleteBy, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, DeleteBy, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, delete by, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Search inside a polygon (in geo coordinates).

A polygon is an unlimited series of points, with a minimum of 3.

A point is a set of 2 floats: latitude, longitude.

The polygon therefore needs an even number of float values: p1Lat, p1Lng, p2Lat, p2Lng, p3Lat, p3Long.

For example: insidePolygon=47.3165,4.9665,47.3424,5.0201,47.32,4.98

Usage notes

You can plot points that are 1 meter apart or 1000s of meters apart. This all depends on the oddness of the shape and its geographical size.
multiple polygons You may specify multiple polygons, in which case the search will use the union (OR) of the polygons. To specify multiple polygons, pass an list of lists of floats (each inner array must contain an even number of values, with a minimum of 6); example: [[47.3165, 4.9665, 47.3424, 5.0201, 47.32, 4.9], [40.9234, 2.1185, 38.6430, 1.9916, 39.2587, 2.0104]].
Keep in mind the purpose of this setting. For example, if you are drawing a circle, you will use instead aroundRadius. If a rectangle, then insideBoundingBox. And so on.
aroundLatLng and aroundLatLngViaIP will be ignored if used along with this parameter.
Be careful when your coordinates cross over the 180^th meridian.
Don’t use insideBoundingBox and insidePolygon together. If you provide both, only insideBoundingBox actions will run.

Examples

Search inside a polygon area

Copy

1
2
3
4
5
6
7
8
9
10
11
12
$polygon = [
  46.650828100116044, // p1Lat
  7.123046875, // p1Lng
  45.17210966999772, // p2Lat
  1.009765625, // p2Lng
  49.62625916704081, // p3Lat
  4.6181640625 // p3Lng
];

$results = $index->search('query', [
  'insidePolygon' => [$polygon]
]);

1
2
3
4
5
6
7
8
9
10
11
12
polygon = [
  46.650828100116044, # p1Lat
  7.123046875, # p1Lng
  45.17210966999772, # p2Lat
  1.009765625, # p2Lng
  49.62625916704081, # p3Lat
  4.6181640625 # p3Lng
]

results = index.search('query', {
  insidePolygon: [polygon]
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const polygon = [
  46.650828100116044, // p1Lat
  7.123046875, // p1Lng
  45.17210966999772, // p2Lat
  1.009765625, // p2Lng
  49.62625916704081, // p3Lat
  4.6181640625 // p3Lng
];

index.search('query', {
  insidePolygon: [polygon]
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
7
8
9
10
11
12
polygon = [
    46.650828100116044, # p1Lat
    7.123046875,        # p1Lng
    45.17210966999772,  # p2Lat
    1.009765625,        # p2Lng
    49.62625916704081,  # p3Lat
    4.6181640625        # p3Lng
]

results = index.search('query', {
    'insidePolygon': [polygon]
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
let polygon = Polygon(
  (46.650828100116044, 7.123046875),
  (45.17210966999772, 1.009765625),
  (49.62625916704081, 4.6181640625),
  (47.715070300900194, 0.482421875)
)

let query = Query("query")
  .set(\.insidePolygon, to: [polygon])

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
index.Search<T>(new Query("query")
{
    InsidePolygon = new List<List<float>>
    {
        new List<float>
        {
            46.650828100116044f,
            7.123046875f,
            45.17210966999772f,
            1.009765625f,
            49.62625916704081f,
            4.6181640625f
        }
    }
});

1
2
3
4
5
6
7
8
9
10
11
index.search(
    new Query("query")
        .setInsidePolygon(
            Arrays.asList(
                Arrays.asList(
                    46.650828100116044f,
                    7.123046875f,
                    45.17210966999772f,
                    1.009765625f,
                    49.62625916704081f,
                    4.6181640625f))));

1
2
3
4
5
6
7
8
9
10
11
12
13
res, err := index.Search(
  "query",
  opt.InsidePolygon([][]float64{
    {
      46.650828100116044, // p1Lat
      7.123046875,        // p1Lng
      45.17210966999772,  // p2Lat
      1.009765625,        // p2Lng
      49.62625916704081,  // p3Lat
      4.6181640625,       // p3Lng
    },
  }),
)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    insidePolygon = Some(Seq(
      InsidePolygon(
        46.650828100116044,
        7.123046875,
        45.17210966999772,
        1.009765625,
        49.62625916704081,
        4.6181640625
      )
    ))
  )
}

1
2
3
4
5
6
7
8
9
10
11
val query = query("query") {
    insidePolygon {
        +Polygon(
            Point(latitude = 46.650828100116044f, longitude = 7.123046875f),
            Point(latitude = 45.17210966999772f, longitude = 1.009765625f),
            Point(latitude = 49.62625916704081f, longitude = 4.6181640625f)
        )
    }
}

index.search(query)

Search inside multiple polygon areas