The user interface for the BasemapGallery. The BasemapGallery displays a collection of items representing basemaps from either ArcGIS Online, a user-defined portal, or an array of Basemaps. When the user selects a basemap from the BasemapGallery, the basemap rendered in the current geoModel is removed from the given map/scene and replaced with the basemap selected in the gallery. More...
| Header: | #include <BasemapGallery> |
| Since: | Esri.ArcGISRuntime 100.13 |
Public Functions
| BasemapGallery(QWidget *parent = nullptr) | |
| BasemapGallery(Esri::ArcGISRuntime::GeoModel *geomodel, QWidget *parent = nullptr) | |
| ~BasemapGallery() | |
| Esri::ArcGISRuntime::Toolkit::BasemapGalleryController * | controller() const |
| Esri::ArcGISRuntime::GeoModel * | geoModel() |
| void | setGeoModel(Esri::ArcGISRuntime::GeoModel *geomodel) |
Detailed Description
Note: By default, the BasemapGallery will attempt to fetch the set of developer basemaps, which require an API key to access.
Member Function Documentation
[invokable] BasemapGallery::BasemapGallery (QWidget *parent = nullptr)
Default constructor.
- parent Parent widget.
View mantains its associated controller, sets up the view itself and its model.
Note: If this constructor is used, a GeoModel must be set separately using setGeoModel.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
[invokable] BasemapGallery::BasemapGallery (Esri::ArcGISRuntime::GeoModel *geomodel, QWidget *parent = nullptr)
Constructor that takes a GeoModel.
- geomodel GeoModel.
- parent Parent widget.
The provided GeoModel's basemap will be set as the BasemapGallery's currentBasemap.
Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.
BasemapGallery::~BasemapGallery ()
Destructor.
Esri::ArcGISRuntime::Toolkit::BasemapGalleryController *BasemapGallery::controller() const
Returns the controller.
Esri::ArcGISRuntime::GeoModel *BasemapGallery::geoModel ()
Returns the current GeoModel used by the BasemapGallery.
See also setGeoModel.
void BasemapGallery::setGeoModel (Esri::ArcGISRuntime::GeoModel *geomodel)
Sets the geomodel used by the controller.
Setting this will reset the active basemap in the gallery. When a new basemap item is selected from the gallery, the GeoModel will be updated with the associated basemap.
Note: If geomodel is passed as nullptr, the current geomodel is unset.
See also geoModel() and BasemapGalleryController::currentBasemap.