A layer that can visualize data from a Bing Maps web service. More...
| Header: | #include <BingMapsLayer.h> |
| Since: | Esri::ArcGISRuntime 100.1 |
| Inherits: | Esri::ArcGISRuntime::ServiceImageTiledLayer |
Public Functions
| BingMapsLayer(const QString &bingMapsKey, Esri::ArcGISRuntime::BingMapsLayerStyle style, QObject *parent = nullptr) | |
| BingMapsLayer(Esri::ArcGISRuntime::Portal *portal, Esri::ArcGISRuntime::BingMapsLayerStyle style, QObject *parent = nullptr) | |
| virtual | ~BingMapsLayer() override |
| QString | culture() const |
| QString | key() const |
| Esri::ArcGISRuntime::Portal * | portal() const |
| void | setCulture(const QString &culture) |
| void | setKey(const QString &bingMapsKey) |
| Esri::ArcGISRuntime::BingMapsLayerStyle | style() const |
Detailed Description
A Bing maps layer displays map content from a Bing Maps web service, providing access to static map tiles and imagery meta-data. Map style and culture can be customized prior to loading the layer.
Functional characteristics
Bing maps require an API key from Microsoft. There are two ways to set this key:
- By providing an ArcGIS portal configured with a Bing Maps key. For more information, see "How to install a Microsoft Bing Key"
- By providing a Bing Maps key directly for this layer. For more information, see "Getting a Bing Maps Key"
A Bing maps layer will fail to load if it does not have a Bing map key or a Portal from where it can get the Bing map key. In this situation, you can set the key and call Loadable::retryLoad. To use the BingMapsLayer you must adhere to Microsoft's Mobile Brand Guidelines.
Bing maps layers do not support identify, query, selection, or time.
Performance characteristics
Bing maps layers perform similarly to other tiled layers. Raster tiles are fetched from Bing's servers on demand.
See also Layer.
Member Function Documentation
BingMapsLayer::BingMapsLayer (const QString &bingMapsKey , Esri::ArcGISRuntime::BingMapsLayerStyle style, QObject *parent = nullptr)
Creates a Bing maps layer with the given style and Bing Maps API Key.
- bingMapsKey - The Bing Maps API key.
- style - The type of Bing maps layer.
- parent - The optional parent QObject.
BingMapsLayer::BingMapsLayer (Esri::ArcGISRuntime::Portal *portal, Esri::ArcGISRuntime::BingMapsLayerStyle style, QObject *parent = nullptr)
Creates a Bing maps layer with the given style and the Bing Maps API Key given by the specified portal.
- portal - A portal that provides a Bing Maps API key.
- style - The type of Bing maps layer such as aerial or road.
- parent - The optional parent QObject.
See also Portal.
[override virtual] BingMapsLayer::~BingMapsLayer ()
Destructor.
QString BingMapsLayer::culture() const
Returns the culture for this Bing maps layer.
Culture determines the language used for labels in this layer. English (en-US) is used by default. For a list of all available options, see Supported Culture Codes.
The value of culture cannot be changed after the layer loads.
See also setCulture().
QString BingMapsLayer::key() const
Returns the Bing Maps API key for this layer.
The value of key cannot be changed after the layer loads.
See also setKey().
Esri::ArcGISRuntime::Portal *BingMapsLayer::portal() const
Returns the portal from which this layer got its Bing Maps API key (if applicable).
void BingMapsLayer::setCulture (const QString &culture)
Sets the culture to culture.
See also culture.
void BingMapsLayer::setKey (const QString &bingMapsKey )
Sets the key to bingMapsKey.
See also key.
Esri::ArcGISRuntime::BingMapsLayerStyle BingMapsLayer::style() const
Returns the Bing Maps style used to display this layer.
The value of style cannot be changed after the layer loads.