Enum LayerConfiguration.Feature

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LayerConfiguration.Feature>
    Enclosing class:
    LayerConfiguration

    public static enum LayerConfiguration.Feature
    extends java.lang.Enum<LayerConfiguration.Feature>

    Defines a list of possible map data features that can be enabled / disabled. See SDKOptions.layerConfiguration

    Following features are enabled by default:

    All other features are disabled, by default.

    Each feature enables a set of OCM layer groups to be downloaded by sdk.maploader.MapDownloader. Detailed description of each layer group available in the HERE Optimized Client Map Developer Guide

    Following features are enabled by default for implicit prefetch:

    Implicit prefetch downloads map content for implicit prefetch features within a view port currently showed by MapView. Explicit prefetching is done using sdk.prefetcher.RoutePrefetcher and sdk.prefetcher.PolygonPrefetcher.

    Feature might have more than one layer group predefined to enable full experience. For example, NAVIGATION requires routing attributes, visual-friendly street names, maneuvers data and ability to interconnect those data sets.

    The same map data is useful for different features, for example RENDERING uses Places data to present it on the MapView, while OFFLINE_SEARCH uses the same data to enable discoverability by name or category. Hence, features might have overlapping sets of enabled layer groups.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ADAS
      Map data which provides ADAS information which includes slope, elevation and curvature information.
      DETAIL_RENDERING
      Additional rendering details like buildings.
      DETAILED_TERRAIN
      Map data that provides detailed topography information.
      EHORIZON
      Map data which provides information about the parts of foreign segments in a tile, where a foreign segment is a segment that is stored in another tile but intersects the current tile.
      EV
      Offline map data for EVChargingStation.
      FUEL_STATION_ATTRIBUTES
      Enables fuel attributes to be returned by Offline Search engine.
      JUNCTION_SIGN_16X9
      Map data that provides junction sign images with aspect ratio 16x9.
      JUNCTION_SIGN_3X4
      Map data that provides junction sign images with aspect ratio 3x4.
      JUNCTION_SIGN_3X5
      Map data that provides junction sign images with aspect ratio 3x5.
      JUNCTION_SIGN_4X3
      Map data that provides junction sign images with aspect ratio 4x3.
      JUNCTION_SIGN_5X3
      Map data that provides junction sign images with aspect ratio 5x3.
      JUNCTION_VIEW_16X9
      Map data that provides junction view images and assets with aspect ratio 16x9.
      JUNCTION_VIEW_3X4
      Map data that provides junction view images and assets with aspect ratio 3x4.
      LANDMARKS_3D
      Map data that is used to render textured 3D landmarks.
      NAVIGATION
      Map data that is used for map matching during navigation.
      OFFLINE_BUS_ROUTING
      Map data that is used to calculate bus routes.
      OFFLINE_ROUTING
      Map data that is used to calculate routes.
      OFFLINE_SEARCH
      Map data that is used to search.
      OFFLINE_SEARCH_GLOBAL
      Map data used for global search indexing.
      RDS_TRAFFIC
      Map data that provides traffic broadcast functionality using RDS-TMC format.
      RENDERING
      A basic set of rendering features such as carto POIs.
      TERRAIN
      Map data that provides topography information.
      TRUCK
      Map data that is used to calculate truck routes.
      TRUCK_SERVICE_ATTRIBUTES
      Enables truck related attributes to be returned by Offline Search engine.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static LayerConfiguration.Feature valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static LayerConfiguration.Feature[] 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

      • DETAIL_RENDERING

        public static final LayerConfiguration.Feature DETAIL_RENDERING

        Additional rendering details like buildings. Only used for the MapView. When not set, the data will be excluded when downloading offline regions or prefetching areas that contain such data. However, during online usage such data may still be downloaded into the cache and shown. Increase of 11-16% is to be expected for map size, in case of enabling this feature.

        Feature enables following OCM layer groups:

        • "detailed_rendering"
      • NAVIGATION

        public static final LayerConfiguration.Feature NAVIGATION

        Map data that is used for map matching during navigation. When not set, navigation may not work properly when being used offline. Increase of 5-7% is to be expected for map size, but pay attention, that this feature is depended on other layer groups (e.g. routing), so, in total is takes about 21-29 % of map size.

        Feature enables following OCM layer groups:

        • "interop"
        • "rendering"
        • "navigation"
        • "routing"
      • OFFLINE_SEARCH

        public static final LayerConfiguration.Feature OFFLINE_SEARCH

        Map data that is used to search. When not set, the OfflineSearchEngine may not work properly when being used offline.

        Feature enables following OCM layer groups:

        • "rendering"
        • "routing"
        • "search"
      • OFFLINE_SEARCH_GLOBAL

        public static final LayerConfiguration.Feature OFFLINE_SEARCH_GLOBAL

        Map data used for global search indexing. This feature enables searches across broader geographic areas and improves both performance and accuracy by leveraging global search indices. By default this feature is disabled.

        Enables HERE SDK to use the enhanced offline search algorithm when OFFLINE_SEARCH_GLOBAL is present in LayerConfiguration.enabledFeatures and downloaded map regions exist with required OCM layer groups listed below. Note: Currently, this algorithm supports only offline maps stored in persistent (protected) storage.

        To prevent excessive map size growth, it is recommended to enable only one of OFFLINE_SEARCH_GLOBAL or OFFLINE_SEARCH at a time.

        Enabling this feature increases the size of downloaded map regions by approximately 11–16% when enabled via LayerConfiguration.enabledFeatures.

        Feature enables following OCM layer groups:

        • "search_global"
        • "search_data"

        Note: This is an alpha release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

      • OFFLINE_ROUTING

        public static final LayerConfiguration.Feature OFFLINE_ROUTING

        Map data that is used to calculate routes. When not set, the OfflineRoutingEngine may not work properly when being used offline. Increase of 12-16.5% is to be expected for map size, but pay attention, that this feature is depended on other layer groups (e.g. navigation), so, in total is takes about 33-45 % of map size.

        Feature enables following OCM layer groups:

        • "rendering"
        • "navigation"
        • "routing"
        • "interop"
        • "car_offline_routing"
      • RENDERING

        public static final LayerConfiguration.Feature RENDERING

        A basic set of rendering features such as carto POIs. Increase of 16-22% is to be expected for map size, but pay attention, that this feature is depended on other layer groups (e.g. navigation), so, in total is takes about 21-29 % of map size.

        Feature enables following OCM layer groups:

        • "rendering"
      • TRUCK

        public static final LayerConfiguration.Feature TRUCK

        Map data that is used to calculate truck routes. When not set, the OfflineRoutingEngine may not work properly when being used to calculate truck routes. It is also used for map matching during truck navigation. When not set, truck navigation may not work properly when being used offline. Online truck navigation will still work when the device has an online connection. Increase of 0.7-1.1% is to be expected for map size, in case of enabling this feature.

        Feature enables following OCM layer groups:

        • "truck"
        • "long_truck_offline_routing"
        • "truck_offline_routing"
      • LANDMARKS_3D

        public static final LayerConfiguration.Feature LANDMARKS_3D

        Map data that is used to render textured 3D landmarks. When not set, the data will be excluded when downloading offline regions or prefetching areas that contain such data. When the landmarks layer is set to be visible for a MapScene, 3D landmarks will still be visible during online usage. Increase of 2-3% is to be expected for map size, in case of enabling this feature. Disabled by default.

        Feature enables following OCM layer groups:

        • "landmarks"
      • EV

        public static final LayerConfiguration.Feature EV

        Offline map data for EVChargingStation.

        Feature enables following OCM layer groups:

        • "ev_charging_station_rendering_premium"
        • "ev_charging_station_search_premium"
      • TRUCK_SERVICE_ATTRIBUTES

        public static final LayerConfiguration.Feature TRUCK_SERVICE_ATTRIBUTES

        Enables truck related attributes to be returned by Offline Search engine. Feature enables following OCM layer groups:

        • "truck_service_premium"
      • FUEL_STATION_ATTRIBUTES

        public static final LayerConfiguration.Feature FUEL_STATION_ATTRIBUTES

        Enables fuel attributes to be returned by Offline Search engine.

        Feature enables following OCM layer groups:

        • "fueling_station_premium"
      • OFFLINE_BUS_ROUTING

        public static final LayerConfiguration.Feature OFFLINE_BUS_ROUTING

        Map data that is used to calculate bus routes. When not set, the OfflineRoutingEngine may not be able to calculate routes with BusOptions.

        Feature enables following OCM layer groups:

        • "bus_offline_routing"
      • JUNCTION_VIEW_3X4

        public static final LayerConfiguration.Feature JUNCTION_VIEW_3X4

        Map data that provides junction view images and assets with aspect ratio 3x4. This will also provide common assets that do not depend on specific aspect ratio. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_view_file_3x4"
        • "junction_view_asset_3x4"
        • "junction_view_asset_common"
      • JUNCTION_VIEW_16X9

        public static final LayerConfiguration.Feature JUNCTION_VIEW_16X9

        Map data that provides junction view images and assets with aspect ratio 16x9. This will also provide common assets that do not depend on specific aspect ratio. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_view_file_16x9"
        • "junction_view_asset_16x9"
        • "junction_view_asset_common"
      • JUNCTION_SIGN_3X4

        public static final LayerConfiguration.Feature JUNCTION_SIGN_3X4

        Map data that provides junction sign images with aspect ratio 3x4. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_sign_file_3x4"
      • JUNCTION_SIGN_3X5

        public static final LayerConfiguration.Feature JUNCTION_SIGN_3X5

        Map data that provides junction sign images with aspect ratio 3x5. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_sign_file_3x5"
      • JUNCTION_SIGN_4X3

        public static final LayerConfiguration.Feature JUNCTION_SIGN_4X3

        Map data that provides junction sign images with aspect ratio 4x3. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_sign_file_4x3"
      • JUNCTION_SIGN_5X3

        public static final LayerConfiguration.Feature JUNCTION_SIGN_5X3

        Map data that provides junction sign images with aspect ratio 5x3. By default this feature is disabled. Feature enables following OCM layer groups:

        • "junction_sign_file_5x3"
      • JUNCTION_SIGN_16X9

        public static final LayerConfiguration.Feature JUNCTION_SIGN_16X9

        Map data that provides junction sign images with aspect ratio 16x9. By default this feature is disabled.

        Feature enables following OCM layer groups:

        • "junction_sign_file_16x9"
      • TERRAIN

        public static final LayerConfiguration.Feature TERRAIN

        Map data that provides topography information. By default this feature is disabled. Feature enables following OCM layer groups:

        • "terrain"
      • DETAILED_TERRAIN

        public static final LayerConfiguration.Feature DETAILED_TERRAIN

        Map data that provides detailed topography information. By default this feature is disabled. Feature enables following OCM layer groups:

        • "detailed_terrain"
      • ADAS

        public static final LayerConfiguration.Feature ADAS

        Map data which provides ADAS information which includes slope, elevation and curvature information. By default this feature is disabled. Feature enables following OCM layer groups:

        • "adas"
      • EHORIZON

        public static final LayerConfiguration.Feature EHORIZON

        Map data which provides information about the parts of foreign segments in a tile, where a foreign segment is a segment that is stored in another tile but intersects the current tile. By default this feature is disabled. Feature enables following OCM layer groups:

        • "ehorizon"
      • RDS_TRAFFIC

        public static final LayerConfiguration.Feature RDS_TRAFFIC

        Map data that provides traffic broadcast functionality using RDS-TMC format. It should be used when there is no internet connection, so that the routing module can utilize traffic data coming over the radio channel to build a route in the offline mode. Feature enables following OCM layer groups:

        • "traffic"
    • Method Detail

      • values

        public static LayerConfiguration.Feature[] 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 (LayerConfiguration.Feature c : LayerConfiguration.Feature.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static LayerConfiguration.Feature 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