Class IconProvider
- Last UpdatedJan 22, 2025
- 2 minute read
Package com.here.sdk.mapview
Class IconProvider
- java.lang.Object
-
- com.here.sdk.mapview.IconProvider
-
public class IconProvider extends java.lang.Object
This provider creates icons from a given set of parameters for map content and constraints for icon dimensions for a particular map scheme. The icon creation currently does not rely on map data. Therefore, it works without online connection. Note: This feature is in BETA state and thus there can be bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IconProvider.IconCallback
Interface which is used as callback to pass back an image or error code after calling the createRoadShieldIcon() method.
-
Constructor Summary
Constructors Constructor Description IconProvider(MapContext mapContext)
Creates an IconProvider.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
createRoadShieldIcon(RoadShieldIconProperties properties, MapScheme mapScheme, IconProviderAssetType assetType, long widthConstraintInPixels, long heightConstraintInPixels, IconProvider.IconCallback callback)
Creates an image displaying a road shield according to the given parameters.
-
-
-
Constructor Detail
-
IconProvider
public IconProvider(MapContext mapContext)
Creates an IconProvider.- Parameters:
mapContext
- The map context instance.
-
-
Method Detail
-
createRoadShieldIcon
public void createRoadShieldIcon(@NonNull RoadShieldIconProperties properties, @NonNull MapScheme mapScheme, @NonNull IconProviderAssetType assetType, long widthConstraintInPixels, long heightConstraintInPixels, @NonNull IconProvider.IconCallback callback)
Creates an image displaying a road shield according to the given parameters.- Parameters:
properties
- The properties which determine the kind of road shield to be created.mapScheme
- The map scheme for which the road shield should be created.assetType
- The asset type for which the road shield should be created.widthConstraintInPixels
- The maximum width of the road shield in pixels. The value is capped to a maximum of 4096 pixels. The image will be created as large as possible within the width and height constraints while maintaining the aspect ratio. If set to 0, the width will be calculated based on the heightConstraintInPixels to preserve the aspect ratio.heightConstraintInPixels
- The maximum height of the road shield in pixels. The value is capped to a maximum of 4096 pixels. The image will be created as large as possible within the width and height constraints while maintaining the aspect ratio. If set to 0, the original image-asset's height will be used.callback
- The callback which is used to return the created image or an error code. Note: This feature is in BETA state and thus there can be bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process.
-
-