SearchURL class
SearchURL 代表 Azure 地圖服務 搜尋作業的 URL。
- Extends
建構函式
| SearchURL(Pipeline, string) | 建立 SearchURL 的實例。 |
繼承的屬性
| maps |
基底 URL 字串值。 |
方法
| search |
位址地理編碼 在許多情況下，完整搜尋服務可能太多，例如，如果您只對傳統地理編碼感興趣。 您也可以存取 搜尋，以獨佔方式查閱位址。 地理編碼是藉由點擊地理編碼端點，只叫用有問題的位址或部分位址來執行。 地理編碼搜尋索引將會查詢街道層級數據上方的所有專案。 不會傳回任何 POI。 請注意，地理編碼器非常容許錯字和不完整的位址。 它也會處理來自確切街地道址或街道或交集的所有專案，以及較高層級的地理位置，例如城市中心、縣市、州等。使用取得 搜尋 位址 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddress |
| search |
反向地理編碼至位址 有時候您可能需要將座標轉譯為 (範例：-122.3862、37.786505) 成人類可理解的街地道址。 在追蹤您從裝置或資產接收 GPS 摘要的應用程式時，最常需要這項功能，並想要知道座標所在的位址。 此端點會傳回指定座標的地址資訊。 使用取得 搜尋 位址反向 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse |
| search |
反向地理編碼至交叉街 有時候您可能需要將座標轉譯為 (範例：-122.3862、37.786505) 成人類可理解的交叉街。 在追蹤您從裝置或資產接收 GPS 摘要的應用程式時，最常需要這項功能，並想要知道座標所在的位址。 此端點會傳回指定座標的交叉街道資訊。 使用取得 搜尋 位址反向街地道 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet |
| search |
結構化位址地理編碼 您也可以存取 Azure 位址地理編碼，以獨佔方式查閱結構化位址。 地理編碼搜尋索引將會查詢街道層級數據上方的所有專案。 不會傳回任何 POI。 請注意，地理編碼器非常容許錯字和不完整的位址。 它也會處理來自確切街地道址或街道或交集的所有專案，以及較高層級的地理位置，例如城市中心、縣市、州等。使用取得 搜尋 位址結構化 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured |
| search |
沿著路由端點 搜尋 可讓您在指定的路由上執行 POI 的模糊搜尋。
此搜尋受限於指定 |
| search |
免費表單 搜尋 基本預設 API 是 Free Form 搜尋，可處理處理任何位址或 POI 令牌組合的輸入模糊。
此搜尋 API 是標準「單一行搜尋」。
免費窗體 搜尋 API 是 POI 搜尋和地理編碼的順暢組合。
API 也可以以內容 (lat./lon 來加權。配對) 或完全受限於座標和半徑，或者可以更普遍地執行，而不需任何地理偏差錨點。
我們強烈建議您使用 『countrySet』 參數，只指定應用程式需要涵蓋範圍的國家/地區，因為預設行為是搜尋整個世界，可能會傳回不必要的結果。 例如： |
| search |
搜尋 Geometry 端點可讓您在單一幾何或其中許多幾何內執行自由格式搜尋。
將會傳回落在 geometry/geometries 內的搜尋結果。
要搜尋的地理特徵可以模型化為 Polygon 和/或 Circle 幾何，使用下列 |
| search |
鄰近 搜尋 如果您有只擷取特定位置的 POI 結果的使用案例，鄰近搜尋方法可能是正確的選擇。 此端點只會傳回 POI 結果，而且不會採用搜尋查詢參數。 使用取得 搜尋 鄰近 API：https://docs.microsoft.com/rest/api/maps/search/getsearchnearby |
| searchPOI(Aborter, string, Search |
依名稱取得POI 如果您的搜尋使用案例只需要 POI 結果，您可以使用 POI 端點進行搜尋。 此端點只會傳回 POI 結果。 使用 Get 搜尋 POI API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoi |
| search |
依類別取得POI 如果您的搜尋使用案例只需要依類別篩選的 POI 結果，您可以使用類別端點。 此端點只會傳回分類為指定之 POI 結果。 您可以 在這裡找到可用的類別清單。 使用取得 #D1FA3C161891949D2940D014B5F8A19B7 POI 類別 API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory |
| search |
搜尋 Polygon API 可讓您要求一組實體的幾何數據，例如城市或國家/地區大綱，先前以 GeoJSON 格式從在線 搜尋 要求擷取。 geometry 標識碼會在 “geometry” 和 “id” 的 dataSources 物件中傳回 搜尋 Address 或 搜尋 Fuzzy 呼叫。 請注意，從在線 搜尋 端點擷取的任何幾何標識碼都有有限的存留期。 用戶端不應該將幾何標識符儲存在持續性記憶體以供稍後轉介使用，因為這些標識碼的穩定性不保證一段時間。 預期在對提供標識碼之 Online 搜尋 方法的要求幾分鐘內，就會提出對 Polygon 方法的要求。 此服務允許最多 20 個標識碼的批次要求。 使用 Get 搜尋 Polygon API：https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon |
繼承的方法
| new |
靜態方法，用來建立具有所提供 Credential 的新 Pipeline 物件。 |
建構函式詳細資料
SearchURL(Pipeline, string)
建立 SearchURL 的實例。
new SearchURL(pipeline: Pipeline, mapsUrl?: string)參數
- pipeline
- Pipeline
呼叫MapsURL.newPipeline () 以建立預設管線，或提供自定義管線。
- mapsUrl
-
string
指向 Azure 地圖服務 服務的網址字串，預設值為 "https://atlas.microsoft.com"。
如果未指定通訊協定，例如 "atlas.microsoft.com"， https 則會假設為 。
繼承的屬性詳細資料
mapsUrl
方法詳細資料
searchAddress(Aborter, string, SearchAddressOptions)
位址地理編碼 在許多情況下，完整搜尋服務可能太多，例如，如果您只對傳統地理編碼感興趣。 您也可以存取 搜尋，以獨佔方式查閱位址。 地理編碼是藉由點擊地理編碼端點，只叫用有問題的位址或部分位址來執行。 地理編碼搜尋索引將會查詢街道層級數據上方的所有專案。 不會傳回任何 POI。 請注意，地理編碼器非常容許錯字和不完整的位址。 它也會處理來自確切街地道址或街道或交集的所有專案，以及較高層級的地理位置，例如城市中心、縣市、州等。使用取得 搜尋 位址 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，以移至 Aborter 的檔，以取得有關要求取消的更多範例。
- query
-
string
要搜尋 (位址，例如“1 Microsoft way， Redmond， WA”) 。
- options
- SearchAddressOptions
傳回
Promise<SearchAddressResponse>
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)
反向地理編碼至位址 有時候您可能需要將座標轉譯為 (範例：-122.3862、37.786505) 成人類可理解的街地道址。 在追蹤您從裝置或資產接收 GPS 摘要的應用程式時，最常需要這項功能，並想要知道座標所在的位址。 此端點會傳回指定座標的地址資訊。 使用取得 搜尋 位址反向 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，以移至 Aborter 的檔，以取得有關要求取消的更多範例。
- position
- GeoJSON.Position
要反向搜尋的位置，例如[-122.125679, 47.641268]的[longitude, latitude]座標數位。
- options
- SearchAddressReverseOptions
傳回
Promise<SearchAddressReverseResponse>
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)
反向地理編碼至交叉街 有時候您可能需要將座標轉譯為 (範例：-122.3862、37.786505) 成人類可理解的交叉街。 在追蹤您從裝置或資產接收 GPS 摘要的應用程式時，最常需要這項功能，並想要知道座標所在的位址。 此端點會傳回指定座標的交叉街道資訊。 使用取得 搜尋 位址反向街地道 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，以移至 Aborter 的檔，以取得有關要求取消的更多範例。
- position
- GeoJSON.Position
要反向搜尋的位置，例如[-122.125679, 47.641268]的[longitude, latitude]座標數位。
傳回
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)
結構化位址地理編碼 您也可以存取 Azure 位址地理編碼，以獨佔方式查閱結構化位址。 地理編碼搜尋索引將會查詢街道層級數據上方的所有專案。 不會傳回任何 POI。 請注意，地理編碼器非常容許錯字和不完整的位址。 它也會處理來自確切街地道址或街道或交集的所有專案，以及較高層級的地理位置，例如城市中心、縣市、州等。使用取得 搜尋 位址結構化 API：https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，以移至 Aborter 的檔，以取得有關要求取消的更多範例。
- countryCode
-
string
位址的 2 或 3 個字母 ISO3166-1 國家/地區代碼部分。 例如美國
- options
- SearchAddressStructuredOptions
傳回
Promise<SearchAddressStructuredResponse>
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)
沿著路由端點 搜尋 可讓您在指定的路由上執行 POI 的模糊搜尋。
此搜尋受限於指定 maxDetourTime 限制量值。
若要傳送路由點，您將使用 body ，其中包含 route 以型別表示 GeoJSON LineString 的物件，並將 Content-Type 標頭設定為 application/json。
中的每個 route 路由點都會以類型表示 GeoJSON Position ，也就是 經度 值後面接著 緯度 值的陣列，並忽略 高度 值。
route應該至少包含2個路線點。
可能會改變原始路由，可能會略過其中一些點。
如果通過找到點的路由比原始點快， detourTime 回應中的值會是負數。
使用沿著路由 API 的 Post 搜尋：https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- query
-
string
適用的查詢字串 (例如“seattle”、“pizza”) 。
- maxDetourTime
-
number
以秒為單位的景點時間上限。 最大值為3600秒
這代表要沿著搜尋的路由，而且應該是有效的 GeoJSON LineString 類型。 如需詳細資訊 ，請參閱 RFC 7946 。
- options
- SearchAlongRouteOptions
傳回
Promise<SearchAlongRouteResponse>
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)
免費表單 搜尋 基本預設 API 是 Free Form 搜尋，可處理處理任何位址或 POI 令牌組合的輸入模糊。
此搜尋 API 是標準「單一行搜尋」。
免費窗體 搜尋 API 是 POI 搜尋和地理編碼的順暢組合。
API 也可以以內容 (lat./lon 來加權。配對) 或完全受限於座標和半徑，或者可以更普遍地執行，而不需任何地理偏差錨點。
我們強烈建議您使用 『countrySet』 參數，只指定應用程式需要涵蓋範圍的國家/地區，因為預設行為是搜尋整個世界，可能會傳回不必要的結果。 例如： countrySet=US，FR. 如需所有支持國家/地區的完整清單，請參閱 [搜尋 涵蓋範圍] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage) 。
大部分 搜尋 查詢預設為 maxFuzzyLevel=2 以提升效能，並降低不尋常的結果。
您可以透過傳入查詢參數 maxFuzzyLevel=3 或 4，視需要覆寫這個新的預設值。
使用取得 搜尋 模糊 API：https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- query
-
string | GeoJSON.Position
適用的查詢字串 (例如“seattle”、“pizza”) 。
也可以指定為 (座標[longitude, latitude]數組， [-122.125679, 47.641268] 例如) 。
- options
- SearchFuzzyOptions
傳回
Promise<SearchFuzzyResponse>
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)
搜尋 Geometry 端點可讓您在單一幾何或其中許多幾何內執行自由格式搜尋。
將會傳回落在 geometry/geometries 內的搜尋結果。
要搜尋的地理特徵可以模型化為 Polygon 和/或 Circle 幾何，使用下列 GeoJSON 任何一種類型來表示： GeoJSON FeatureCollection， geometry 可以表示為 GeoJSON FeatureCollection 物件。
如果幾何同時包含多邊形和 Circle，這是建議的選項。
FeatureCollection最多可以包含 50 GeoJSON Feature 個物件。
每個 Feature 物件都應該代表具有下列條件的Polygon或 Circle： Feature Polygon 幾何的物件可以有最多 50 個座標，而且其屬性必須是空的。
Circle 幾何的 物件是由使用GeoJSON Point型別表示的中心和以公尺為單位的半徑值 () ，該值必須在對象的屬性中指定，以及其值應該是 'Circle' 的 subType 屬性。Feature
如需範例 FeatureCollection 表示法，請參閱下方的範例一節。
GeoJSON GeometryCollection， geometry 可以表示為 GeoJSON GeometryCollection 物件。
如果 geometry 只包含多邊形清單，則這是建議的選項。
GeometryCollection最多可以包含 50 GeoJSON Polygon 個物件。
每個 Polygon 物件最多可以有50個座標。
如需範例 GeometryCollection 表示法，請參閱下方的範例一節。
GeoJSON Polygon， geometry 可以表示為 GeoJSON Polygon 物件。
如果 geometry 包含單一多邊形，這是建議的選項。
物件 Polygon 最多可以有 50 個座標。
使用 Post 搜尋 Inside Geometry API：https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- query
-
string
適用的查詢字串 (例如“seattle”、“pizza”) 。
這代表一或多個地理特徵的幾何， ( (、州界限等 ) 搜尋，而且應該是符合 GeoJSON 規範的類型。 如需詳細資訊 ，請參閱 RFC 7946 。
- options
- SearchInsideGeometryOptions
傳回
Promise<SearchInsideGeometryResponse>
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)
鄰近 搜尋 如果您有只擷取特定位置的 POI 結果的使用案例，鄰近搜尋方法可能是正確的選擇。 此端點只會傳回 POI 結果，而且不會採用搜尋查詢參數。 使用取得 搜尋 鄰近 API：https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- location
- GeoJSON.Position
結果應該偏差的位置。
應該是的[longitude, latitude]陣列，例如 [-121.89, 37.337]
- options
- SearchNearbyOptions
傳回
Promise<SearchNearbyResponse>
searchPOI(Aborter, string, SearchPOIOptions)
依名稱取得POI 如果您的搜尋使用案例只需要 POI 結果，您可以使用 POI 端點進行搜尋。 此端點只會傳回 POI 結果。 使用 Get 搜尋 POI API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- query
-
string
要搜尋 (的 POI 名稱，例如「) 」 ) 。
- options
- SearchPOIOptions
傳回
Promise<SearchPOIResponse>
searchPOICategory(Aborter, string, SearchPOICategoryOptions)
依類別取得POI 如果您的搜尋使用案例只需要依類別篩選的 POI 結果，您可以使用類別端點。 此端點只會傳回分類為指定之 POI 結果。 您可以 在這裡找到可用的類別清單。 使用取得 #D1FA3C161891949D2940D014B5F8A19B7 POI 類別 API：https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- query
-
string
要搜尋 (的 POI 類別，例如“AIRPORT”、“BEACH”) 。
- options
- SearchPOICategoryOptions
傳回
Promise<SearchPOICategoryResponse>
searchPolygon(Aborter, string[])
搜尋 Polygon API 可讓您要求一組實體的幾何數據，例如城市或國家/地區大綱，先前以 GeoJSON 格式從在線 搜尋 要求擷取。 geometry 標識碼會在 “geometry” 和 “id” 的 dataSources 物件中傳回 搜尋 Address 或 搜尋 Fuzzy 呼叫。 請注意，從在線 搜尋 端點擷取的任何幾何標識碼都有有限的存留期。 用戶端不應該將幾何標識符儲存在持續性記憶體以供稍後轉介使用，因為這些標識碼的穩定性不保證一段時間。 預期在對提供標識碼之 Online 搜尋 方法的要求幾分鐘內，就會提出對 Polygon 方法的要求。 此服務允許最多 20 個標識碼的批次要求。
使用 Get 搜尋 Polygon API：https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon
function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>參數
- aborter
- Aborter
使用 Aborter.none 或 Aborter.timeout () 建立新的 Aborter 實例，如需要求取消的更多範例，請移至 Aborter 的檔。
- geometries
-
string[]
先前從在線 搜尋 要求擷取的幾何 UUID 逗號分隔清單。
傳回
Promise<SearchPolygonResponse>
繼承的方法的詳細資料
newPipeline(Credential, INewPipelineOptions)
靜態方法，用來建立具有所提供 Credential 的新 Pipeline 物件。
static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline參數
- credential
- Credential
例如 SubscriptionKeyCredential、TokenCredential 和 MapControlCredential。
- pipelineOptions
- INewPipelineOptions
傳回
新的 Pipeline 物件。