QueryAPIOptions Object
Note
Bing Maps Web Control SDK retirement
Bing Maps Web Control SDK is deprecated and will be retired. Free (Basic) account customers can continue to use Bing Maps Web Control SDK until June 30th, 2025. Enterprise account customers can continue to use Bing Maps Web Control SDK until June 30th, 2028. To avoid service disruptions, all implementations using Bing Maps Web Control SDK will need to be updated to use Azure Maps Web SDK by the retirement date that applies to your Bing Maps for Enterprise account type. For detailed migration guidance, see Migrate from Bing Maps Web Control SDK and Migrate Bing Maps Enterprise applications to Azure Maps with GitHub Copilot.
Azure Maps is Microsoft's next-generation maps and geospatial services for developers. Azure Maps has many of the same features as Bing Maps for Enterprise, and more. To get started with Azure Maps, create a free Azure subscription and an Azure Maps account. For more information about azure Maps, see Azure Maps Documentation. For migration guidance, see Bing Maps Migration Overview.
Represents the options for querying a data source that is hosted in the Bing Spatial Data Services.
Properties
| Name | Type | Description |
|---|---|---|
queryUrl |
string | Required. A query URL containing the access id, data source name and the entity type name. |
filter |
string or Filter or FilterGroup | Optional. Specifies a conditional expression for a list of properties and values. |
inlineCount |
boolean | Optional. Specifies whether or not to return a count of the results in the response. Default: false. |
isStaging |
boolean | Optional. Specifies to query the staged version of the data source instead of the published version. Default: false. |
orderBy |
string[] | Optional. Specifies one or more properties to use to sort the results of a query. You can specify up to three (3) properties. Results are sorted in ascending order. Note: You cannot use the latitude and longitude properties to sort results. You can use the elevation property. |
select |
string[] | Optional. Specifies the data source properties to return in the response. If the $select query option is not specified or if it is set to "" ($select=), all data source properties are returned. Default: "*,_distance" |
skip |
number | Optional. Specifies to not return a specified number of query results. For example, if this value is set to 50, then the first result that is returned is the 51st result. You can use the skip query option with the top query option to display a subset of the query results. For example, the following parameter combinations provide sets of 10 results at a time. skip=0, top=10 - provides results 1 to 10 skip=10, top=10 - provides results 11 to 20 Default: 0 |
spatialFilter |
SpatialFilterOptions | Optional. Spatial filter options to apply. |
top |
number | Optional. Specifies the maximum number of results to return in the query response. Default: 25 |