WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Extended Stats Aggregation Usage Geo Centroid Aggregation Usage »

› › ›

Geo Bounds Aggregation Usage

edit

Geo Bounds Aggregation Usage

edit

Fluent DSL example

edit

s => s
.Aggregations(a => a
    .GeoBounds("viewport", gb => gb
        .Field(p => p.Location)
        .WrapLongitude(true)
    )
)

Object Initializer syntax example

edit

new SearchRequest<Project>
{
    Aggregations = new GeoBoundsAggregation("viewport", Field<Project>(p => p.Location))
    {
        WrapLongitude = true
    }
}

Example json output.

{
  "aggs": {
    "viewport": {
      "geo_bounds": {
        "field": "location",
        "wrap_longitude": true
      }
    }
  }
}

Handling Responses

edit

response.ShouldBeValid();
var viewport = response.Aggs.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 »