Share via


SearchInsideGeometryOptions Class

Definition

Options.

public class SearchInsideGeometryOptions : Azure.Maps.Search.SearchGeometryBaseOptions
type SearchInsideGeometryOptions = class
    inherit SearchGeometryBaseOptions
Public Class SearchInsideGeometryOptions
Inherits SearchGeometryBaseOptions
Inheritance
SearchInsideGeometryOptions

Constructors

SearchInsideGeometryOptions()

Properties

CategoryFilter

A 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.

(Inherited from SearchGeometryBaseOptions)
ExtendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Please refer to SearchIndex for all the available search indexes Value should be a comma separated list of index types (in any order) or null for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.

IndexFilter

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

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.

LocalizedMapView

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. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN. Please refer to Supported Views for details and to see the available Views.

(Inherited from SearchGeometryBaseOptions)
OperatingHours

Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned. Supported value: nextSevenDays

(Inherited from SearchGeometryBaseOptions)
Top

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

(Inherited from SearchGeometryBaseOptions)

Applies to