Search Results for

    Show / Hide Table of Contents

    Interface IGeoShapeProperty

    Maps a property as a geo_shape field

    Inherited Members
    IDocValuesProperty.DocValues
    ICoreProperty.CopyTo
    ICoreProperty.Fields
    ICoreProperty.Similarity
    ICoreProperty.Store
    IProperty.LocalMetadata
    IProperty.Meta
    IProperty.Name
    IProperty.Type
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IGeoShapeProperty : IDocValuesProperty, ICoreProperty, IProperty, IFieldMapping

    Properties

    | Edit this page View Source

    Coerce

    Should the data be coerced into becoming a valid geo shape (for instance closing a polygon)

    Declaration
    [DataMember(Name = "coerce")]
    bool? Coerce { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    IgnoreMalformed

    If true, malformed geojson shapes are ignored. If false (default), malformed geojson shapes throw an exception and reject the whole document.

    Declaration
    [DataMember(Name = "ignore_malformed")]
    bool? IgnoreMalformed { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    IgnoreZValue

    If true (default) three dimension points will be accepted (stored in source) but only latitude and longitude values will be indexed; the third dimension is ignored. If false, geo-points containing any more than latitude and longitude (two dimensions) values throw an exception and reject the whole document.

    Declaration
    [DataMember(Name = "ignore_z_value")]
    bool? IgnoreZValue { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Orientation

    Defines how to interpret vertex order for polygons and multipolygons. Defaults to CounterClockWise

    Declaration
    [DataMember(Name = "orientation")]
    GeoOrientation? Orientation { get; set; }
    Property Value
    Type Description
    GeoOrientation?
    | Edit this page View Source

    Strategy

    Defines the approach for how to represent shapes at indexing and search time. It also influences the capabilities available so it is recommended to let OpenSearch set this parameter automatically.

    Declaration
    [DataMember(Name = "strategy")]
    GeoStrategy? Strategy { get; set; }
    Property Value
    Type Description
    GeoStrategy?

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Coerce
      • IgnoreMalformed
      • IgnoreZValue
      • Orientation
      • Strategy
    • Extension Methods
    Back to top Generated by DocFX