Type alias CreateGeoS2AnalyzerOptions

CreateGeoS2AnalyzerOptions: {
    features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}

(Enterprise Edition only.) Options for creating a Geo S2 Analyzer

Type declaration

  • Optional features?: AnalyzerFeature[]

    Features to enable for this Analyzer.

  • properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    }

    Additional properties for the Analyzer.

    • Optional format?: "latLngDouble" | "latLngInt" | "s2Point"

      If set to "latLngDouble", each latitude and longitude value is stored as an 8-byte floating-point value (16 bytes per coordinate pair).

      If set to "latLngInt", each latitude and longitude value is stored as a 4-byte integer value (8 bytes per coordinate pair).

      If set to "s2Point", each longitude-latitude pair is stored in the native format of Google S2 (24 bytes per coordinate pair).

      Default: "latLngDouble"

    • Optional options?: {
          maxCells?: number;
          maxLevel?: number;
          minLevel?: number;
      }

      Options for fine-tuning geo queries.

      Default: { maxCells: 20, minLevel: 4, maxLevel: 23 }

      • Optional maxCells?: number
      • Optional maxLevel?: number
      • Optional minLevel?: number
    • Optional type?: "shape" | "centroid" | "point"

      If set to "centroid", only the centroid of the input geometry will be computed and indexed.

      If set to "point" only GeoJSON objects of type Point will be indexed and all other geometry types will be ignored.

      Default: "shape"

  • type: "geo_s2"

    Type of the Analyzer.