Package version:

Interface SearchInsideGeometryOptions

Options for searching inside geometries

Hierarchy

Properties

categoryFilter?: Object

A comma-separated list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using POI Categories API.

Usage examples: categorySet=7315(Search Points of Interest from category Restaurant) categorySet=7315025,7315017(Search Points of Interest of category either Italian or French Restaurant)

extendedPostalCodesFor?: Object

Indexes for which extended postal codes should be included in the results

indexFilter?: Object

A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are:

  • Addr = Address range interpolation,
  • Geo = Geographies, PAD = Point Addresses,
  • POI = Points of interest, Str = Streets,
  • Xstr = Cross Streets (intersections)
language?: string

Language in which search results should be returned.

localizedMapView?: string

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions.

operatingHours?: string

Hours of operation for a POI (Points of Interest).

top?: number

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100

Generated using TypeDoc