@azure/maps-search package

Classes

AzureKeyCredential	A static-key-based credential that supports updating the underlying key value.
MapsSearchClient	Client class for interacting with Azure Maps Search Service.

Interfaces

Address	The address of the result
AddressRanges	Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included.
BatchItem	An item returned from Batch service call.
BatchPollerOptions	Options for batch operation poller
BatchResult	This object is returned from a successful Batch service call.
BoundingBox	Bounding Box
Brand	The brand associated with the POI
Classification	The classification for the POI being returned
ClassificationName	Name for the classification
DataSource	Optional section. Reference ids for use with the Get Search Polygon API.
EntityGeometry	Entity Geometry
EntryPoint	The entry point for the POI being returned.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
FuzzySearchBaseOptions	Base Options for fuzzy search
FuzzySearchRequest	Request object containing parameters for making fuzzy search call
GeoJsonCircleFeature	The exact type of "Circle" feature in the GeoJson format
GeoJsonCircleOrPolygonFeatureCollection	GeoJSON Feature Collection containing only polygons or circles
GeoJsonFeature	GeoJSON Feature A Feature object represents a spatially bounded thing. Every Feature object is a GeoJSON object. Reference
GeoJsonFeatureCollection	GeoJSON FeatureCollection. Reference
GeoJsonGeometryCollection	GeoJSON GeometryCollection. Reference
GeoJsonLineString	GeoJSON LineString. Reference
GeoJsonMultiLineString	GeoJSON MultiLineString. Reference
GeoJsonMultiPoint	GeoJSON MultiPoint. Reference
GeoJsonMultiPolygon	GeoJSON MultiPolygon. Reference
GeoJsonObject	A GeoJSON object represents a Geometry, Feature, or collection of Features. Reference
GeoJsonPoint	GeoJSON Point. Reference
GeoJsonPolygon	GeoJSON Polygon. Reference To specify a constraint specific to Polygons, it is useful to introduce the concept of a linear ring: A linear ring is a closed LineString with four or more positions. The first and last positions are equivalent, and they MUST contain identical values; their representation SHOULD also be identical. A linear ring is the boundary of a surface or the boundary of a hole in a surface. A linear ring MUST follow the right-hand rule with respect to the area it bounds, i.e., exterior rings are counterclockwise, and holes are clockwise.
GeoJsonPolygonCollection	GeoJSON Geomtry Collection containing only polygons
GeoJsonPolygonFeature	GeoJSON Feature that is either polygon or circle
GeometryIdentifier	Information about the geometric shape of the result. Only present if type == Geography.
GetPointOfInterestCategoriesOptions	Options for retrieving point of interest categories
OperatingHours	Opening hours for a POI (Points of Interest).
OperatingHoursTime	Represents a date and time
OperatingHoursTimeRange	Open time range for a day
PointOfInterest	Details of the returned POI including information such as the name, phone, url address, and classifications.
PointOfInterestCategory	POI category result
PointOfInterestCategorySet	POI category
PointOfInterestCategoryTreeResult	This object is returned from a successful POI Category Tree call
ReverseSearchAddressOptions	Options for reverse search address operations
ReverseSearchAddressRequest	Request object containing parameters for making reverse search address call
ReverseSearchAddressResult	Result type of the reverse search address API
ReverseSearchAddressResultItem
ReverseSearchBaseOptions	Base options for reverse search operations
ReverseSearchCrossStreetAddressOptions	Options for reverse-searching cross street addresses
ReverseSearchCrossStreetAddressResult	Result type of the reverse search cross street address API
ReverseSearchCrossStreetAddressResultItem
SearchAddressBaseOptions	Base options for search address operations
SearchAddressOptions	Options for searching addresses (geocoding)
SearchAddressRequest	Request object containing parameters for making search address call
SearchAddressResult	This object is returned from a successful Search calls.
SearchAddressResultItem	Result object for a Search API response.
SearchAlongRouteOptions	Options for searching along routes
SearchBaseOptions	Base options for search operations
SearchExtraFilterOptions	Options for specifying extra filters
SearchGeometryBaseOptions	Base options for geometry search operations
SearchInsideGeometryOptions	Options for searching inside geometries
SearchNearbyPointOfInterestOptions	Options for searching nearby points of interest
SearchPointOfInterestBaseOptions	Base Options for searching points of interest
SearchStructuredAddressOptions	Options for searching structured addresses
StructuredAddress	Structured address

Type Aliases

BBox	Bounding box including information on the coordinate range for its geometries
BBox2D	2D bounding box
BBox3D	3D bounding box
ElectricVehicleConnector	Defines values for ElectricVehicleConnector. KnownElectricVehicleConnector can be used interchangeably with ElectricVehicleConnector, this enum contains the known values that the service supports. Known values supported by the service StandardHouseholdCountrySpecific: These are the standard household connectors for a certain region. They are all AC single phase and the standard Voltage and standard Amperage. See also: Plug & socket types - World Standards IEC62196Type1: Type 1 connector as defined in the IEC 62196-2 standard. Also called Yazaki after the original manufacturer or SAE J1772 after the standard that first published it. Mostly used in combination with 120V single phase or up to 240V single phase infrastructure. IEC62196Type1CCS: Type 1 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 1 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. IEC62196Type2CableAttached: Type 2 connector as defined in the IEC 62196-2 standard. Provided as a cable and plug attached to the charging point IEC62196Type2Outlet: Type 2 connector as defined in the IEC 62196-2 standard. Provided as a socket set into the charging point. IEC62196Type2CCS: Type 2 based combo connector as defined in the IEC 62196-3 standard. The connector is based on the Type 2 connector – as defined in the IEC 62196-2 standard – with two additional direct current (DC) contacts to allow DC fast charging. IEC62196Type3: Type 3 connector as defined in the IEC 62196-2 standard. Also called Scame after the original manufacturer. Mostly used in combination with up to 240V single phase or up to 420V three phase infrastructure. Chademo: CHAdeMO connector named after an association formed by the Tokyo Electric Power Company and industrial partners. Because of this is is also known as the TEPCO's connector. It supports fast DC charging. IEC60309AC1PhaseBlue: Industrial Blue connector is a connector defined in the IEC 60309 standard. It is sometime referred to as by some combination of the standard, the color and the fact that is a single phase connector. The connector usually has the "P+N+E, 6h" configuration. IEC60309DCWhite: Industrial White connector is a DC connector defined in the IEC 60309 standard. Tesla: The Tesla connector is the regionally specific Tesla Supercharger connector. I.e. it refers to either Tesla's proprietary connector, sometimes referred to as Tesla Port mostly limited to North America or the modified Type 2 (DC over Type 2) in Europe.
EntryPointType	Defines values for EntryPointType. KnownEntryPointType can be used interchangeably with EntryPointType, this enum contains the known values that the service supports. Known values supported by the service main minor
FuzzySearchBatchOptions	Options for performing batch fuzzy searches
FuzzySearchBatchPoller	The poller type for the fuzzy search batch
FuzzySearchOptions	Options for fuzzy search
GeoJsonCircleOrPolygonFeature
GeoJsonGeometry	GeoJSON Geometry
GeoJsonType	GeoJSON types
GeographicEntityType	Defines values for GeographicEntityType. KnownGeographicEntityType can be used interchangeably with GeographicEntityType, this enum contains the known values that the service supports. Known values supported by the service Country CountrySubdivision CountrySecondarySubdivision CountryTertiarySubdivision Municipality MunicipalitySubdivision Neighbourhood PostalCodeArea
GeometryType	Geometry types
GetGeometriesOptions	Options for retrieving polygon geometries given geometry ids
LatLon	Latitude/Longitude Pair
LocalizedMapView	Defines values for LocalizedMapView. KnownLocalizedMapView can be used interchangeably with LocalizedMapView, this enum contains the known values that the service supports. Known values supported by the service AE: United Arab Emirates (Arabic View) AR: Argentina (Argentinian View) BH: Bahrain (Arabic View) IN: India (Indian View) IQ: Iraq (Arabic View) JO: Jordan (Arabic View) KW: Kuwait (Arabic View) LB: Lebanon (Arabic View) MA: Morocco (Moroccan View) OM: Oman (Arabic View) PK: Pakistan (Pakistani View) PS: Palestinian Authority (Arabic View) QA: Qatar (Arabic View) SA: Saudi Arabia (Arabic View) SY: Syria (Arabic View) YE: Yemen (Arabic View) Auto: Return the map data based on the IP address of the request. Unified: Unified View (Others)
MapsSearchClientOptions	Client options used to configure the Maps Search Client
MatchType	Defines values for MatchType. KnownMatchType can be used interchangeably with MatchType, this enum contains the known values that the service supports. Known values supported by the service AddressPoint HouseNumberRange Street
OperatingHoursRange	Defines values for OperatingHoursRange. KnownOperatingHoursRange can be used interchangeably with OperatingHoursRange, this enum contains the known values that the service supports. Known values supported by the service nextSevenDays: Shows the hours of operation for the next week, starting with the current day in the local time of the POI.
Position	An array of number representing a point
Position2D	2D position
Position3D	3D position
QueryType	Defines values for QueryType. KnownQueryType can be used interchangeably with QueryType, this enum contains the known values that the service supports. Known values supported by the service NEARBY: Search was performed around a certain latitude and longitude with a defined radius NON_NEAR: Search was performed globally, without biasing to a certain latitude and longitude, and no defined radius
ReverseSearchAddressBatchOptions	Options for performing batch reverse searches
ReverseSearchAddressBatchPoller	The poller type for the reverse search address batch
RoadUseType	Defines values for RoadUseType. KnownRoadUseType can be used interchangeably with RoadUseType, this enum contains the known values that the service supports. Known values supported by the service LimitedAccess Arterial Terminal Ramp Rotary LocalStreet
SearchAddressBatchOptions	Options for performing batch address searches
SearchAddressBatchPoller	The poller type for the search address batch
SearchAddressResultType	Defines values for SearchAddressResultType. KnownSearchAddressResultType can be used interchangeably with SearchAddressResultType, this enum contains the known values that the service supports. Known values supported by the service POI Street Geography Point Address Address Range Cross Street
SearchGeometry	The union type of several GeoJSON geometry object which is available for search.
SearchIndexes	Defines values for SearchIndexes. KnownSearchIndexes can be used interchangeably with SearchIndexes, this enum contains the known values that the service supports. Known values supported by the service Addr: Address range interpolation Geo: Geographies PAD: Point Addresses POI: Points of interest Str: Streets Xstr: Cross Streets (Intersections)
SearchPointOfInterestCategoryOptions	Options for seaching points of interest by categories
SearchPointOfInterestOptions	Options for searching points of interest
SearchQuery	Fuzzy search query

Enums

KnownElectricVehicleConnector	Known values of ElectricVehicleConnector that the service accepts.
KnownEntryPointType	Known values of EntryPointType that the service accepts.
KnownGeographicEntityType	Known values of GeographicEntityType that the service accepts.
KnownLocalizedMapView	Known values of LocalizedMapView that the service accepts.
KnownMatchType	Known values of MatchType that the service accepts.
KnownOperatingHoursRange	Known values of OperatingHoursRange that the service accepts.
KnownQueryType	Known values of QueryType that the service accepts.
KnownRoadUseType	Known values of RoadUseType that the service accepts.
KnownSearchAddressResultType	Known values of SearchAddressResultType that the service accepts.
KnownSearchIndexes	Known values of SearchIndexes that the service accepts.