LayerConfigurationFeature enum
Defines a list of possible map data features that can be enabled / disabled.
See SDKOptions.layerConfiguration
Following features are enabled by default:
- LayerConfigurationFeature.detailRendering
- LayerConfigurationFeature.landmarks3d
- LayerConfigurationFeature.navigation
- LayerConfigurationFeature.offlineSearch
- LayerConfigurationFeature.offlineRouting
- LayerConfigurationFeature.rendering
- LayerConfigurationFeature.truck
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:
- LayerConfigurationFeature.detailRendering
- LayerConfigurationFeature.navigation
- LayerConfigurationFeature.offlineSearch
- LayerConfigurationFeature.offlineRouting
- LayerConfigurationFeature.rendering
- LayerConfigurationFeature.truck
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, LayerConfigurationFeature.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 LayerConfigurationFeature.rendering uses Places data to present it on the MapView, while LayerConfigurationFeature.offlineSearch uses the same data to enable discoverability by name or category. Hence, features might have overlapping sets of enabled layer groups.
Values
- detailRendering → const LayerConfigurationFeature
-
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"
-
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"
- offlineSearch → const LayerConfigurationFeature
-
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"
- offlineSearchGlobal → const LayerConfigurationFeature
-
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_GLOBALis 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_GLOBALorOFFLINE_SEARCHat 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.
- offlineRouting → const LayerConfigurationFeature
-
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 → const LayerConfigurationFeature
-
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 → const LayerConfigurationFeature
-
Map data that is used to calculate truck routes. When not set, the
OfflineRoutingEnginemay 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"
- landmarks3d → const LayerConfigurationFeature
-
Map data that is used to render 3D landmarks. When not set, the data will be excluded when downloading offline regions or prefetching areas that contain such data. When the
landmarksMapFeatureis set to be visible for aMapScene, 3D landmarks will still be loaded and visible during online usage. Increase of 2-3% is to be expected for map size, in case of enabling this feature.3D landmark rendering is enabled by default in grayscale on normal, logistics and topo schemes, and in textureless mode on lite schemes. However, when this map data feature is disabled, the 3D landmark rendering for the above schemes will not work in offline mode with the downloaded map packages. Feature enables following OCM layer groups:
- "landmarks"
- ev → const LayerConfigurationFeature
-
Offline map data for
EVChargingStation.Feature enables following OCM layer groups:
- "ev_charging_station_rendering_premium"
- "ev_charging_station_search_premium"
- truckServiceAttributes → const LayerConfigurationFeature
-
Enables truck related attributes to be returned by Offline Search engine. Feature enables following OCM layer groups:
- "truck_service_premium"
- fuelStationAttributes → const LayerConfigurationFeature
-
Enables fuel attributes to be returned by Offline Search engine.
Feature enables following OCM layer groups:
- "fueling_station_premium"
- offlineBusRouting → const LayerConfigurationFeature
-
Map data that is used to calculate bus routes. When not set, the
OfflineRoutingEnginemay not be able to calculate routes withBusOptions.Feature enables following OCM layer groups:
- "bus_offline_routing"
- junctionView3x4 → const LayerConfigurationFeature
-
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"
- junctionView16x9 → const LayerConfigurationFeature
-
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"
- junctionSign3x4 → const LayerConfigurationFeature
-
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"
- junctionSign3x5 → const LayerConfigurationFeature
-
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"
- junctionSign4x3 → const LayerConfigurationFeature
-
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"
- junctionSign5x3 → const LayerConfigurationFeature
-
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"
- junctionSign16x9 → const LayerConfigurationFeature
-
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 → const LayerConfigurationFeature
-
Map data that provides topography information. The related map feature terrain with mode hillshade is enabled by default on topo map schemes. It is disabled by default on all other schemes.
Note that this change has performance implications, with additional data consumption and impact on rendering frame rate. If performance is a concern, this feature can be disabled from the application side when loading the map scene. However, when this map data feature is disabled, the terrain rendering for the above schemes will not work in offline mode with the downloaded map packages. Feature enables following OCM layer groups:
- "terrain"
- detailedTerrain → const LayerConfigurationFeature
-
Map data that provides detailed topography information. By default this feature is disabled. Feature enables following OCM layer groups:
- "detailed_terrain"
- adas → const LayerConfigurationFeature
-
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 → const LayerConfigurationFeature
-
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"
- rdsTraffic → const LayerConfigurationFeature
-
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"
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- index → int
-
A numeric identifier for the enumerated value.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
values
→ const List<
LayerConfigurationFeature> - A constant List of the values in this enum, in order of their declaration.