Search Results for

    Show / Hide Table of Contents

    Class GeoDistanceAggregator

    A multi-bucket range aggregator that works on geo_point fields

    Inheritance
    object
    AggregatorBase
    GeoDistanceAggregator
    Inherited Members
    AggregatorBase.Name
    AggregatorBase.Names
    AggregatorBase.Aggregators
    AggregatorBase.Filter
    AggregatorBase.UiBehavior
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class GeoDistanceAggregator : AggregatorBase

    Properties

    Field

    The field's ID to execute the aggregation on.

    Declaration
    [JsonProperty("field", Required = Required.Always)]
    [Required]
    public string Field { get; set; }
    Property Value
    string

    Location

    The point of origin to calculate the distance from (latitude/longitude).

    Declaration
    [JsonProperty("location", Required = Required.Always)]
    [Required]
    public GeoLocation Location { get; set; }
    Property Value
    GeoLocation

    Ranges

    A list of distance ranges.

    Declaration
    [JsonProperty("ranges", Required = Required.Always)]
    [Required]
    public ICollection<GeoDistance> Ranges { get; set; }
    Property Value
    ICollection<GeoDistance>

    Methods

    FromJson(string)

    Declaration
    public static GeoDistanceAggregator FromJson(string data)
    Parameters
    string data

    Returns
    GeoDistanceAggregator

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX