ArcGISVectorTiledLayer QML Type

  • Esri.ArcGISRuntime
  • ArcGISVectorTiledLayer
  • Displays data from an ArcGIS vector tiled data source. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    Layer

    Properties

    Signals

    Detailed Description

    The ArcGIS Vector Tiled Layer is similar to the ArcGIS Tiled Layer. An ArcGIS Vector Tiled Layer is loaded from ArcGIS online, ArcGIS Enterprise, ArcGIS Server, or a local vector tile layer package file. The tile data format is optimized to reduce network bandwidth and reduce CPU load while rendering the tiles. Vector Tiled Layers are appropriate for basemap, reference and possibly operational layers. They do not contain any feature data, and do not support identify or search operations.

    Vector tiles are an alternative to raster tile basemap layers. Instead of pixels (raster), the cartography is delivered using 2D points. The points describe lines, polygons, or the locations of labels and marker symbols. The file format of tiles is binary and conforms to the Mapbox Vector Tile Specification. This specification allows a more continuous visual experience between levels of detail compared to raster tiles. The vector tile file format also requires less space than raster tiles.

    You can create a vector tiled layer using either a URL or a portal item. The URL can point to a vector tile source, a vector tile style sheet, or a local vector tile package file. The portal item will contain a URL to a vector tile stylesheet. The style sheet describes the appearance of the geometry and must be in the Mapbox GL Style format. The style sheet also contains a URL to a vector tile source. The source must be in the Mapbox TileJSON format. The source info includes a URL to a default style sheet.

    More than one vector tile style sheet can use the same source. Both the source info and the style sheet are human readable JSON files.

    Vector tile packages can also be downloaded from a ArcGIS Online vector tile service. The vector tile package is a single file (.vptk) that contains all of the tile data files, the source information, a style sheet, and the font and symbol marker resources required to display the map.

    Vector tile packages are also distributed inside Mobile Map Packages. The MMPK contains JSON that points to the location of the vector tile style sheet or the root of the vector tile package data.

    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
    ArcGISItemitem
    Credentialcredential
    RequestConfigurationrequestConfiguration (since Esri.ArcGISRuntime 100.1)
    VectorTileCachevectorTileCache (since Esri.ArcGISRuntime 100.2)
    ItemResourceCacheitemResourceCache (since Esri.ArcGISRuntime 100.2)

    Example:

    Display the Navigation vector tile layer by using an online service:

    // Create MapView that contains a Map
    MapView {
        id: mapview
        anchors.fill: parent
    
        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }
    
        Map {
            id: map
            Basemap {
                // Nest an ArcGISVectorTiledLayer Layer in the Basemap
                ArcGISVectorTiledLayer {
                    url: "https://www.arcgis.com/home/item.html?id=7675d44bb1e4428aa2c30a9b68f97822"
                }
            }
            initialViewpoint: ViewpointCenter {
                center: Point { x:-80.18; y: 25.778135; spatialReference: SpatialReference { wkid: 4326 } }
                targetScale: 150000
            }
        }
    }

    Alternatively, you can display vector tiles offline by setting the file path to a local vector tile package (*.vtpk):

    Map {
        Basemap {
            ArcGISVectorTiledLayer {
                url: dataPath + "vtpk/FillmoreTopographicMap.vtpk"
            }
        }
    //... other map properties

    See sample: Vector tiled layer (URL)

    See also ApiKeyResource, Cancelable, LayerContent, Loadable, RemoteResource, Layer, LayerContent, Loadable, and RemoteResource.

    Property Documentation

    [since Esri.ArcGISRuntime 100.10] apiKey : string

    Returns the API key.

    This property was introduced in Esri.ArcGISRuntime 100.10.

    See also ApiKeyResource.


    [default] credential : Credential

    The credential used to access the source of this layer.


    [default] item : ArcGISItem

    The item used to initialize the layer.

    The item cannot be changed after the layer is loaded.


    [since Esri.ArcGISRuntime 100.2] itemResourceCache : ItemResourceCache

    The item resource cache containing style resources for this layer.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    [default, since Esri.ArcGISRuntime 100.1] requestConfiguration : RequestConfiguration

    The configuration parameters used for network requests sent by this layer.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [read-only] sourceInfo : VectorTileSourceInfo

    Returns information about the vector tile layer's source (read-only).

    The returned VectorTileSource includes name, extent, visible scale, and so on.


    [read-only] style : VectorTileStyle

    Returns information about the style sheet used with this vector tiled layer (read-only).

    The returned VectorTileStyle includes the style sheet's URL, version, and so on.


    url : url

    The URL to the source of this layer.


    [since Esri.ArcGISRuntime 100.2] vectorTileCache : VectorTileCache

    The vector tile cache of this layer.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.10] apiKeyChanged()

    Emitted when the apiKey property changes.

    Note: The corresponding handler is onApiKeyChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.10.

    See also ApiKeyResource.


    credentialChanged()

    Emitted when the credential property changes.

    Note: The corresponding handler is onCredentialChanged.


    [since Esri.ArcGISRuntime 100.2] itemResourceCacheChanged()

    Emitted when the itemResourceCache property changes.

    Note: The corresponding handler is onItemResourceCacheChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.2.


    [since Esri.ArcGISRuntime 100.1] requestConfigurationChanged()

    Emitted when the requestConfiguration property changes.

    Note: The corresponding handler is onRequestConfigurationChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.1.


    sourceInfoChanged()

    Emitted when the sourceInfo property changes.

    Note: The corresponding handler is onSourceInfoChanged.


    styleChanged()

    Emitted when the style property changes.

    Note: The corresponding handler is onStyleChanged.


    urlChanged()

    Emitted when the url property changes.

    Note: The corresponding handler is onUrlChanged.


    [since Esri.ArcGISRuntime 100.2] vectorTileCacheChanged()

    Emitted when the vectorTileCache property changes.

    Note: The corresponding handler is onVectorTileCacheChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.2.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.