Search Results for

    Show / Hide Table of Contents

    Class GeoDistanceSort

    Allows you to sort based on a proximity to one or more GeoLocation

    Inheritance
    object
    SortBase
    GeoDistanceSort
    Implements
    IGeoDistanceSort
    ISort
    Inherited Members
    SortBase.Missing
    SortBase.Mode
    SortBase.NumericType
    SortBase.Nested
    SortBase.Order
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class GeoDistanceSort : SortBase, IGeoDistanceSort, ISort

    Properties

    | Edit this page View Source

    DistanceType

    How to compute the distance. Can either be arc (default), or plane (faster, but inaccurate on long distances and close to the poles).

    Declaration
    public GeoDistanceType? DistanceType { get; set; }
    Property Value
    Type Description
    GeoDistanceType?
    | Edit this page View Source

    Field

    Declaration
    public Field Field { get; set; }
    Property Value
    Type Description
    Field
    | Edit this page View Source

    IgnoreUnmapped

    Indicates if the unmapped field should be treated as a missing value. Setting it to true is equivalent to specifying an unmapped_type in the field sort. The default is false (unmapped field are causing the search to fail)

    Declaration
    public bool? IgnoreUnmapped { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Points

    Declaration
    public IEnumerable<GeoLocation> Points { get; set; }
    Property Value
    Type Description
    IEnumerable<GeoLocation>
    | Edit this page View Source

    SortKey

    The field on which to sort

    Declaration
    protected override Field SortKey { get; }
    Property Value
    Type Description
    Field
    Overrides
    SortBase.SortKey
    | Edit this page View Source

    Unit

    The unit to use when computing sort values. The default is m (meters)

    Declaration
    public DistanceUnit? Unit { get; set; }
    Property Value
    Type Description
    DistanceUnit?

    Implements

    IGeoDistanceSort
    ISort

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • DistanceType
      • Field
      • IgnoreUnmapped
      • Points
      • SortKey
      • Unit
    • Implements
    • Extension Methods
    Back to top Generated by DocFX