SearchInsideGeometryOptions interface

Package:

@azure/maps-search

Options for searching inside geometries

Extends

SearchGeometryBaseOptions,OperationOptions

Properties

extendedPostalCodesFor	Indexes for which extended postal codes should be included in the results
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.

Inherited Properties

abortSignal	The signal which can be used to abort requests.
categoryFilter	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)
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.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
operatingHours	Hours of operation for a POI (Points of Interest).
requestOptions	Options used when creating and sending HTTP requests for this operation.
serializerOptions	Options to override serialization/de-serialization behavior.
top	Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100
tracingOptions	Options used when tracing is enabled.

Property Details

extendedPostalCodesFor

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

extendedPostalCodesFor?: string[]

Property Value

string[]

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)

indexFilter?: string[]

Property Value

string[]

language

Language in which search results should be returned.

language?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

categoryFilter

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)

categoryFilter?: number[]

Property Value

number[]

Inherited From SearchGeometryBaseOptions.categoryFilter

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.

localizedMapView?: string

Property Value

string

Inherited From SearchGeometryBaseOptions.localizedMapView

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

operatingHours

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

operatingHours?: string

Property Value

string

Inherited From SearchGeometryBaseOptions.operatingHours

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

serializerOptions

Options to override serialization/de-serialization behavior.

serializerOptions?: SerializerOptions

Property Value

SerializerOptions

Inherited From OperationOptions.serializerOptions

top

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

top?: number

Property Value

number

Inherited From SearchGeometryBaseOptions.top

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions