AnimatedTileLayer 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.
Provides a layer which can smoothly animate through an array of tile layer sources.
Constructor
AnimatedTileLayer(options?: AnimatedTileLayerOptions)
Methods
| Name | Return Type | Description |
|---|---|---|
getFrameRate() |
number | Gets the frame rate of this animated tile layer. |
getLoadingScreen() |
CustomOverlay | Gets the loading screen overlay when tiles are being fetched. |
getMaxTotalLoadTime() |
number | Gets the maximum total tile fetching time of this animated tile layer |
getTileSources() |
TileSource[] | Gets the tile sources associated with this layer. |
getVisible() |
boolean | Gets the visibility of this animated tile layer. |
pause() |
Pause the tile layer animation. | |
play() |
Play the animation either from start or where it was paused. | |
| setOptions(options: AnimatedTileLayerOptions) | Sets the options for the animated tile layer. | |
stop() |
Stop the layer animation, hide layer, and reset frame to the beginning. |
Events
| Name | Return Type | Description |
|---|---|---|
| onFrameLoaded | AnimatedFrameEventArgs | An event that fires every time a new tile layer frame is loaded in the animation. |
| preLoadEnded | An event that fires when preloading tiles for the current view ends. | |
| preLoadStarted | An event that fires when preloading tiles for the current view starts. |