New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« Extended Stats Aggregation Usage Geo Centroid Aggregation Usage »
Elastic Docs ›Elasticsearch.Net and NEST: the .NET clients [6.x] ›Aggregations ›Metric Aggregations

Geo Bounds Aggregation Usage

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Geo Bounds Aggregation Usage

edit

Fluent DSL example

edit
a => a
.GeoBounds("viewport", gb => gb
    .Field(p => p.LocationPoint)
    .WrapLongitude(true)
)

Object Initializer syntax example

edit
new GeoBoundsAggregation("viewport", Field<Project>(p => p.LocationPoint))
{
    WrapLongitude = true
}

Example json output.

{
  "viewport": {
    "geo_bounds": {
      "field": "locationPoint",
      "wrap_longitude": true
    }
  }
}

Handling Responses

edit
response.ShouldBeValid();
var viewport = response.Aggregations.GeoBounds("viewport");
viewport.Should().NotBeNull();
viewport.Bounds.Should().NotBeNull();

var bottomRight = viewport.Bounds.BottomRight;
bottomRight.Should().NotBeNull();
bottomRight.Lat.Should().HaveValue();
GeoLocation.IsValidLatitude(bottomRight.Lat.Value).Should().BeTrue();
bottomRight.Lon.Should().HaveValue();
GeoLocation.IsValidLongitude(bottomRight.Lon.Value).Should().BeTrue();

var topLeft = viewport.Bounds.TopLeft;
topLeft.Should().NotBeNull();
topLeft.Lat.Should().HaveValue();
GeoLocation.IsValidLatitude(topLeft.Lat.Value).Should().BeTrue();
topLeft.Lon.Should().HaveValue();
GeoLocation.IsValidLongitude(topLeft.Lon.Value).Should().BeTrue();
« Extended Stats Aggregation Usage Geo Centroid Aggregation Usage »

On this page

Was this helpful?
Feedback