Skip To Content ArcGIS for Developers Sign In Dashboard

Basemap QML Type

A basemap that can be displayed in a map. More...

Properties

Signals

Methods

Detailed Description

A basemap provides a background of geographical context for the content you want to display in the map. It is used for locational reference and provides a framework on which you can overlay operational layers, perform analysis, and visualize geographic information. Thus, the basemap serves as a foundation and provides a framework for working with information geographically.

A basemap is composed of a collection of baseLayers and referenceLayers. Base layers are displayed at the bottom of a map, and reference layers are displayed at the top, with the map's operational layers sandwiched between them. The content of a basemap is typically static and does not change frequently.

ArcGIS Online provides a number of ready-to-use basemaps such as streets, topographic, shaded relief, and so on. If you prefer, you can also create your own basemap by mashing up layers.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
LayerbaseLayers (appends to model)
ArcGISItemitem

Example:

Add a tiled map service to your map's basemap:

Map {
    id: map
    Basemap {
        ArcGISTiledLayer {
            url: sampleServerWorldStreetMapUrl
        }
    }
}

See also JsonSerializable and Loadable.

Property Documentation

[default] baseLayers : LayerListModel

Returns the LayerListModel of the baseLayers (read-only).

This property may be populated after the basemap loads.


error : Error

Returns the error object (read-only).

See also Loadable and Error.


[default] item : ArcGISItem

A item that can be used to initialize the Basemap.

Note that this property can only be changed or assigned before the basemap is loaded with layers.

See also Loadable.


json : jsobject

JSON that can be used to instantiate the type instance.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


name : string

The name of the Basemap.


referenceLayers : LayerListModel

Returns the LayerListModel of the referenceLayers (read-only).

This property may be populated after the basemap loads.


unknownJson : jsobject

Returns the unknown JSON from the source JSON.

See also JsonSerializable.


unsupportedJson : jsobject

Returns the unsupported data from the source JSON.

See also JsonSerializable.


url : url

Returns the URL of the Basemap.

url may be a direct URL to web map JSON content or the URL of a portal item.

The URL can be one of three possible types:

  • The item details page : http://www.myPortal.com/home/item.html?id=12345678901234567890123456789012
  • The map view page : http://www.myPortal.com/home/webmap/viewer.html?webmap=12345678901234567890123456789012
  • The sharing data page : http://www.myPortal.com/sharing/rest/content/items/12345678901234567890123456789012/data

Note: This property may only be assigned before the Basemap is loaded.


Signal Documentation

baseLayersChanged()

Emitted when the baseLayers property of this Basemap changes.


itemChanged()

Emitted when the item property of this Basemap changes.


loadErrorChanged()

Emitted when the loadError property of this Basemap changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property of this Basemap changes.

See also Loadable.


nameChanged()

Emitted when the name property of this Basemap changes.


referenceLayersChanged()

Emitted when the referenceLayers property of this Basemap changes.


urlChanged()

Emitted when the url property of this Basemap changes.


Method Documentation

void cancelLoad()

Cancels loading if it is in progress.

See also Loadable.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?