Class GenerateOfflineMapParameterOverrides


  • public final class GenerateOfflineMapParameterOverrides
    extends Object
    Gives access to the individual parameters objects that will generate the various geodatabase, vector tile and tile cache packages that make up the data of an offline map.

    This allows the user more fine-grained control over the generation of an offline map than the options presented in the standard GenerateOfflineMapParameters. For example, the parameter overrides allow the user to adjust specific layers so that they: use a different spatial extent or scale range; use custom attribute or geometry settings; are omitted from the download.

    An instance of this class can be created from the overall map settings in GenerateOfflineMapParameters by calling OfflineMapTask.createGenerateOfflineMapParameterOverridesAsync(GenerateOfflineMapParameters). This object gives access to the individual parameter objects via three dictionaries containing generate geodatabase parameters, export tile cache parameters and export vector tile parameters. These can be accessed using getGenerateGeodatabaseParameters(), getExportTileCacheParameters() and getExportVectorTilesParameters() respectively. The dictionaries contain the various parameters objects mapped against an OfflineMapParametersKey.

    An OfflineMapParametersKey represents the service that a particular parameters object is intended for. OfflineMapParametersKey(Layer) or OfflineMapParametersKey(ServiceFeatureTable) can be used to construct a key given its respective layer or table. The resultant key's OfflineMapParametersKey.getType() property indicates which of the three dictionaries contains the desired parameters object and the key can be used to extract it. Note that a given parameter's key/value pair may be shared by multiple layers in the map: for example a single GenerateGeodatabaseParameters could represent the online settings for multiple feature layers which all access the same underlying feature service.

    All entries in the dictionaries correspond to layers and tables in the online map. If a dictionary entry is removed the corresponding layers or tables will be removed from the offline map without raising an error.

    Since:
    100.4.0
    • Method Detail

      • getExportTileCacheParameters

        public Map<OfflineMapParametersKey,ExportTileCacheParameters> getExportTileCacheParameters()
        Gets a dictionary containing parameters that will be used when generating tile cache packages for an offline map. The dictionary is presented as a java.util.Map. All entries correspond to ArcGISTiledLayer instances in the online map. If an entry is removed the corresponding layers will be removed from the offline map without raising an error.
        Returns:
        a modifiable Map; the keys are OfflineMapParametersKey objects representing the services that the corresponding ExportTileCacheParameters are intended for
        Since:
        100.4.0
      • getExportVectorTilesParameters

        public Map<OfflineMapParametersKey,ExportVectorTilesParameters> getExportVectorTilesParameters()
        Gets a dictionary containing parameters that will be used when generating vector tile cache packages for an offline map. The dictionary is presented as a java.util.Map. All entries correspond to ArcGISVectorTiledLayer instances in the online map. If an entry is removed the corresponding layers will be removed from the offline map without raising an error.
        Returns:
        a modifiable Map; the keys are OfflineMapParametersKey objects representing the services that the corresponding ExportVectorTilesParameters are intended for
        Since:
        100.4.0
      • getGenerateGeodatabaseParameters

        public Map<OfflineMapParametersKey,GenerateGeodatabaseParameters> getGenerateGeodatabaseParameters()
        Gets a dictionary containing parameters that will be used when generating geodatabases for an offline map. The dictionary is presented as a java.util.Map. All entries correspond to FeatureLayer or ServiceFeatureTable instances in the online map. If an entry is removed the corresponding layers or tables will be removed from the offline map without raising an error.
        Returns:
        a modifiable Map; the keys are OfflineMapParametersKey objects representing the services that the corresponding GenerateGeodatabaseParameters are intended for
        Since:
        100.4.0