Package com.esri.arcgisruntime.tasks.vectortilecache

Enum EsriVectorTilesDownloadOption

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EsriVectorTilesDownloadOption>
    public enum EsriVectorTilesDownloadOption
extends java.lang.Enum<EsriVectorTilesDownloadOption>
    Enumerates options for downloading an Esri vector tiled basemap service.

    When taking an Esri vector tiled basemap service offline (for example to create a VectorTileCache on your device), you can choose from different versions of the service depending on your use case.

    Primary considerations are the download speed and the size of the resulting .vtpk file. Among other things, file size is influenced by the amount of fonts downloaded from the service. Esri vector tiled basemap layers make use of fonts as part of their style resources - see the vector-tile-style documentation. When you take a vector tiled layer offline, these fonts are downloaded as part of the VectorTileCache.

    Esri services also offer an alternative version with a reduced font package size which will reduce the download size of a vtpk by around 80 Mb. You can view a set of vector tile styles which use the reduced font services here. If you are creating a web map that is only intended for taking maps offline and not for online-viewing, these "for export" versions of the services are recommended.

    This enumeration describes options for controlling which set of fonts are downloaded. Note that these options only apply to Esri vector tile basemap services.

    Since:
    100.10.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      USE_ORIGINAL_SERVICE
      The complete set of vector tile resources for the original service, including the full set of fonts, will be downloaded.
      USE_REDUCED_FONTS_SERVICE
      An alternative service that uses a reduced set of font resources, supporting a limited set of language characters, will be downloaded.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static EsriVectorTilesDownloadOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EsriVectorTilesDownloadOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • USE_ORIGINAL_SERVICE

        public static final EsriVectorTilesDownloadOption USE_ORIGINAL_SERVICE
        The complete set of vector tile resources for the original service, including the full set of fonts, will be downloaded.

        Downloading all font resources increases the download size of a .vtpk. However, this option ensures that the offline vector tile layer displays the same as the original online service.

        Since:
        100.10.0

      • USE_REDUCED_FONTS_SERVICE

        public static final EsriVectorTilesDownloadOption USE_REDUCED_FONTS_SERVICE
        An alternative service that uses a reduced set of font resources, supporting a limited set of language characters, will be downloaded.

        Downloading the smaller set of font resources reduces the download size of a .vtpk by around 80 Mb. This omits the large Arial Unicode font, that is used to support many characters for the full world basemap. This makes this option unsuitable for some locales or when your offline vector tiled layer includes certain character sets. For example, this option will not display Chinese, Japanese, Thai, Korean or Georgian characters. You should confirm that this option is suitable for your specific use-case.

        You can view a set of vector tile styles which use the reduced font services here. This option is not recommended for Esri basemap services that do not have an equivalent "for export" version.

        Since:
        100.10.0

    • Method Detail

      • values

        public static EsriVectorTilesDownloadOption[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (EsriVectorTilesDownloadOption c : EsriVectorTilesDownloadOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EsriVectorTilesDownloadOption valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null