Class ArcGISVectorTiledLayer

  • All Implemented Interfaces:
    RemoteResource, LayerContent, Loadable

    public final class ArcGISVectorTiledLayer
    extends Layer
    implements RemoteResource
    Represents a layer that allows you to display data from an ArcGIS Vector Tile Service, a Vector Tile Style Sheet or a Local Vector tile package(VTPK).
    Since:
    100.0.0
    • Constructor Detail

      • ArcGISVectorTiledLayer

        public ArcGISVectorTiledLayer​(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:
        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:
        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:
        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:
        IllegalArgumentException - if vectorTileCache is null.
        Since:
        100.2.0
    • Method Detail

      • getSourceInfo

        public VectorTileSourceInfo getSourceInfo()
        Gets the Vector Tile Source info.
        Returns:
        the source info
        Since:
        100.0.0
      • getStyle

        public VectorTileStyle getStyle()
        Gets the VectorTileStyle.
        Returns:
        the style
        Since:
        100.0.0
      • copy

        public ArcGISVectorTiledLayer copy()
        Creates a deep copy of this ArcGISVectorTiledLayer instance.
        Returns:
        a deep copy of this ArcGISVectorTiledLayer instance, which means that copies of all fields of this layer are made including its loading state
        Since:
        100.1.0
      • getVectorTileCache

        public VectorTileCache getVectorTileCache()
        Gets the underlying vector tile cache for creating the vector tile layer, or null if no vector tile cache is present.

        If this layer was created from a vector tile cache or a local file URI, then this property will return the vector tile cache. If this layer was created from a remote URI, this property will return null.

        Returns:
        the vector tile cache or null if no vector tile cache available
        Since:
        100.2.0
      • getItemResourceCache

        public ItemResourceCache getItemResourceCache()
        Gets the item resource cache or null if no item resource cache is present.
        Returns:
        the item resource cache or null if no item resource cache available
        Since:
        100.2.0
      • getCredential

        public Credential getCredential()
        Description copied from interface: RemoteResource
        Gets the Credential that is set on the network resource.
        Specified by:
        getCredential in interface RemoteResource
        Returns:
        the Credential, or null if there is none
      • setCredential

        public void setCredential​(Credential credential)
        Description copied from interface: RemoteResource
        Sets a Credential to be used by the network resource in the event of an authentication challenge. The default credential is null.
        Specified by:
        setCredential in interface RemoteResource
        Parameters:
        credential - the Credential to be used for authentication
      • getRequestConfiguration

        public RequestConfiguration getRequestConfiguration()
        Description copied from interface: RemoteResource
        Gets the RequestConfiguration used to modify the parameters of network requests made by this RemoteResource.
        Specified by:
        getRequestConfiguration in interface RemoteResource
        Returns:
        the RequestConfiguration used to modify network requests
      • getUri

        public String getUri()
        Description copied from interface: RemoteResource
        Gets the URI of this RemoteResource. Typically this is the URI used to instantiate the object.
        Specified by:
        getUri in interface RemoteResource
        Returns:
        the URI of this RemoteResource