Package com.esri.arcgisruntime.layers

Class ArcGISVectorTiledLayer

  • All Implemented Interfaces:
    ApiKeyResource, RemoteResource, LayerContent, Loadable
    public final class ArcGISVectorTiledLayer
extends Layer
implements RemoteResource, ApiKeyResource
    Displays data from an ArcGIS vector tiled data source.

    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 tiled 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. The vector tile file format requires much less space than raster tiles. Also, because the cartography is rendered at runtime, the differences between levels of detail appear more continuous than with raster tiles.

    To create a vector tiled layer, the runtime client is given either a URI or a PortalItem. The URI 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 URI 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 URI to a vector tile source. The source must be in the Mapbox TileJSON format. The source info includes a URI 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.

    Since:
    100.0.0
    See Also:
    Layer

    • Constructor Detail

      • ArcGISVectorTiledLayer

        public ArcGISVectorTiledLayer​(java.lang.String dataSourceUri)
        Creates a new ArcGISVectorTiledLayer from either the ArcGIS Vector Tile Service, Vector Tile Style Sheet indicated by the given URI, or the path to a Local Vector tile package(VTPK).
        Parameters:
        dataSourceUri - the Vector Tile Source service URL, Vector Tile Style Sheet URL, Path to local VTPK
        Throws:
        java.lang.IllegalArgumentException - if dataSourceUri is null or empty
        Since:
        100.0.0

      • ArcGISVectorTiledLayer

        public ArcGISVectorTiledLayer​(PortalItem portalItem)
        Creates a new ArcGISVectorTiledLayer based on the portal item.
        Parameters:
        portalItem - the PortalItem associated with this ArcGISVectorTiledLayer instance
        Throws:
        java.lang.IllegalArgumentException - if portalItem is null
        Since:
        100.0.0

      • ArcGISVectorTiledLayer

        public ArcGISVectorTiledLayer​(VectorTileCache vectorTileCache)
        Creates a new ArcGISVectorTiledLayer from a vector tile cache.
        Parameters:
        vectorTileCache - the vector tile cache to use
        Throws:
        java.lang.IllegalArgumentException - if vectorTileCache is null
        Since:
        100.2.0

      • ArcGISVectorTiledLayer

        public ArcGISVectorTiledLayer​(VectorTileCache vectorTileCache,
                              ItemResourceCache itemResourceCache)
        Creates a new ArcGISVectorTiledLayer from the specified VectorTileCache and ItemResourceCache objects. If itemResourceCache is null, it is equivalent to the constructor ArcGISVectorTiledLayer(VectorTileCache).
        Parameters:
        vectorTileCache - the vector tile cache to use
        itemResourceCache - the vector tile style to use
        Throws:
        java.lang.IllegalArgumentException - if vectorTileCache is null.
        Since:
        100.2.0