Filter Class

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.

The Filter class defines the logic behind a filter expression that can be executed against a JSON object or generate a filter string that can be used with the Bing Spatial Data Services.

Constructor

Filter(propertyName: string, operator: string | FilterCompareOperator, value: any)

Methods

Name	Return Type	Description
execute(object: any)	boolean	Executes the filter logic against a JSON object and returns a boolean indicating if the object meets the requirement of the Filter.
toString()	string	Converts the filter logic into a string format that is compatible with the Bing Spatial Data Services.

Tip

If you have an array of objects and want to filter out those that match your filters, simply loop through your array and execute the filter against each object.