Venue label JSON 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.

Encapsulates the position and contents of a text label to try to apply to an entity.

This class is part of the venue JSON class structure.

Properties

Property Type Req? Description
text string Text to display in the label.
rects rectangle Rectangles to try to place the text of the label in.

Rectangles

Each rectangle should be tested in order and only drawn if the text fits in the rectangle and it does not overlap another label. For polygons, the current ordering is that the first rectangle is horizontal and fits within the polygon, and the second is not constrained by being horizontal but is the largest oriented rectangle that fits in the polygon.

Example

{
  "text": "My Label", 
  "rect": {"angle":-10,"xy":[20, 30],"width":5.01E-05,"height":2.1E-05}
}