mapview library - Dart API
mapview
mapview library
Classes
- AssetsManager
- Assets manager interface.
- DashPattern
- Represents a dash pattern for map polyline.
- HereMap
- Widget that displays a map. To interact with the map, use the HereMapController object that is passed to HereMapCreatedCallback Note: Before using this class, SDKNativeEngine must be already initialized.
- HereMapController
- Allows interacting with the map displayed by HereMap widget.
- HereMapControllerCore
- The representation of a dynamic and interactive geographic map.
- HereMapOptions
- Options used for initialization of map view
- IconProvider
- 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.
- JsonStyleFactory
- A factory of Style objects from styles defined in JSON format.
- JsonStyleFactoryInstantiationErrorDetails
- Describes the reason for failing to create a Style from a JSON source.
- LocationIndicator
- Graphical object to represent the location of the user on the map.
- MapArrow
- A visual representation of an arrow on the map.
- MapCamera
- Represents the camera looking onto the map view.
- MapCameraAnimation
- An animation that can be applied to a MapCamera.
- MapCameraAnimationFactory
- Factory for creating MapCameraAnimation objects to change map's camera over time.
- MapCameraKeyframeTrack
- Stores keyframes for interpolation of a camera property using a specific easing function and interpolation mode.
- MapCameraLimits
- Controls constraints on map camera parameters.
- MapCameraListener
- Abstract class for objects that want to get updates whenever the map is redrawn after camera parameters change.
- MapCameraState
- Encapsulates state of the camera.
- MapCameraUpdate
- An update that can be applied to the map camera.
- MapCameraUpdateFactory
- Factory for creating MapCameraUpdate to change map's camera.
- MapContentSettings
- Provides settings regarding map data which are applied globally to all map views.
- MapContext
- MapContext is the rendering engine and the context in which virtual geographic maps get rendered.
- MapFeatureModes
- Holds constants for map feature modes, to be used with MapScene.enableFeatures.
- MapFeatures
- Holds constants for map features, to be used with MapScene.enableFeatures and MapScene.disableFeatures.
- MapIdleListener
- Used to detect when the map becomes idle or busy.
- MapImage
- Represents a drawable resource that can be used by a MapMarker, MapMarker3D or MapImageOverlay to be shown on the map.
- MapImageOverlay
-
MapImageOverlayis used to draw images over the map, at a view coordinate inside the map viewport. - MapItemRepresentation
- Base class to represent visual style of particular map items.
- MapLayer
- Interface for managing a map layer.
- MapLayerBuilder
- MapLayerBuilder is used to add layers to a map to visualise a dataset in a programmatic way without defining it upfront in the configuration files.
- MapLayerBuilderInstantiationErrorDetails
- Describes the reason for failing to build a MapLayer.
- MapLayerMapMeasureDependentStorageLevels
- Provides a mapping between a MapLayer map measure to datasource storage level.
- MapLayerPriority
- MapLayerPriority class.
- MapLayerPriorityBuilder
- MapLayerPriorityBuilder is an interface used to define the rendering priority of a layer and its categories, relative to other layers or layer-category pairs.
- MapLayerVisibilityRange
- A layer's visibility along a zoom level range.
- MapMarker
-
MapMarkeris used to draw images on the map, for example to mark a specific location. - MapMarker3D
- Represents a 3D shape drawn on the map at specified geodetic coordinates.
- MapMarker3DModel
- Represents a 3D model that can be used by a MapMarker3D to be shown on the map.
- MapMarkerCluster
- Groups map markers and enables their clustering to reduce visual clutter when there are many of them in a small area.
- MapMarkerClusterCounterStyle
- Styling options for a marker cluster which is represented by the marker count as a text.
- MapMarkerClusterGrouping
- Represents a group of map markers belonging to a cluster.
- MapMarkerClusterImageStyle
- This class specifies the visual appearance of a cluster marker.
- MapMarkerTextStyle
- Styling options for the text of a MapMarker.
- MapMeasure
- A map measure.
- MapMeasureDependentRenderSize
- Represents a render size, described as map measure dependent values.
- MapMeasureRange
- A map measure range.
- MapObjectDescriptor
- Interface represents descriptor of a pickable map object.
- MapPickResult
- A class representing a map pick result.
- MapPolygon
- A visual representation of a polygon on the map.
- MapPolyline
- A visual representation of a line on the map.
- MapPolylineDashImageRepresentation
- Represents a dash pattern for the map polyline consisting of images rendered with certain gaps from each other.
- MapPolylineDashRepresentation
- Represents a dash pattern for map polyline where the dash can be rendered as a colored line and the gap can be either empty or colored.
- MapPolylineRepresentation
- Base class to represent the visual appearance of a MapPolyline.
- MapPolylineSolidRepresentation
- Representation for a solid line without outline.
- MapScene
- Represents a map scene and exposes the functionality to manipulate its content.
- MapSceneLights
- Manage the lights and their attributes in a scene.
- MapSceneLightsDirection
- The direction of lights as a pair of azimuth and altitude angles.
- MapSceneLoadOptions
- Represents the configuration options for loading a map scene.
- MapSceneLoadOptionsBuilder
- Builder for creating MapSceneLoadOptions instances.
- MapSceneLoadOptionsBuilderInstantiationErrorDetails
- Describes the reason for failing to build a MapSceneLoadOptions.
- MapSceneMapPickFilter
- Filter for the map content to be picked.
- MapViewBase
-
Represents the available public API from
MapView. - MapViewLifecycleListener
- Provides a mechanism for observing a lifecycle of a map view and/or implementing components whose lifecycle needs to be linked with that of a map view.
- MaterialReflectivity
- Material reflectivity properties are used to enable per‑pixel lighting for supported map objects (e.g.
- Mesh
- Represents a mesh in 3D space.
- MeshBuilder
- Builder for meshes.
- PickMapContentResult
- A class that contains possible results from picking map content on the map scene.
- PickMapItemsResult
- Carries results from the picking of map items on the map scene.
- PickTrafficIncidentResult
- Carries the result of picking a Carto traffic incident object.
- QuadMeshBuilder
- Builder for a single quad.
- RenderSize
- Represents size of visual elements drawn on the map.
- RoadShieldIconProperties
- Contains the information required to create a road shield image.
- Style
- A style that defines the visual appearance of map rendered features.
- TranslucentMapLayerGroup
- A translucent layer group that can be the target for MapLayerPriorityBuilder.inGroup.
- TranslucentMapLayerGroupErrorDetails
- Describes the reason for failing to create the group.
- TriangleMeshBuilder
- Builder for a single triangle.
- WidgetPin
-
Controller for a
Widgetpinned at a fixed geographical location on the map.
Enums
- DrawOrderType
- Specifies the type of map item draw order.
- HereMapEvent
- IconProviderAssetType
- Asset types for loading icons.
- IconProviderError
- Error which indicates why an icon could not be retrieved.
- ImageFormat
- Image format.
- JsonStyleFactoryInstantiationErrorCode
- Describes reasons for failing to create a Style from a JSON source.
- LineCap
- Determines the cap (line ending) style.
- LocationIndicatorIndicatorStyle
- The predefined styles for the location indicator which are pedestrian and navigation mode.
- LocationIndicatorMarkerType
- Enum to identify different types of markers of the location indicator.
- MapCameraAnimationInstantiationErrorCode
- Describes a reason for failing to create a multi-track MapCameraAnimation.
- MapCameraKeyframeTrackInstantiationErrorCode
- Describes a reason for failing to create a MapCameraKeyframeTrack.
- MapCameraUpdateInstantiationErrorCode
- Describes a reason for failing to create a MapCameraUpdate.
- MapContentCategory
- Type representing map content categories.
- MapContentSettingsTrafficRefreshPeriodErrorCode
- Traffic refresh period error code
- MapContentType
- Content types supported by the map.
- MapContextFreeResourceSeverity
- The severity of a free resource request.
- MapContextResourceType
- Types of system resources used by MapContext or any of the entities attached to it, like HereMapControllerCore.
- MapError
- Represents various errors that could occur from map related operations.
- MapLayerBuilderInstantiationErrorCode
- Describes a reason for failing to build a MapLayer.
- MapMarker3DModelInstantiationErrorCode
- Indicates the reason for a failure to create MapMarker3DModel.
- MapMarkerTextStyleInstantiationErrorCode
- Describes a reason for failing to create a MapMarkerTextStyle.
- MapMarkerTextStylePlacement
- Represents text placement with respect to the icon of a MapMarker.
- MapMeasureDependentRenderSizeInstantiationErrorCode
- Describes a reason for failing to create a MapMeasureDependentRenderSize.
- MapMeasureKind
- Kinds of measures.
- MapPolylineRepresentationInstantiationErrorCode
- Describes a reason for failing to create a MapPolylineRepresentation.
- MapProjection
- The map projection used for rendering.
- MapRenderMode
-
For Android only: Mode of rendering the map by a
HereMapwidget. - MapSceneLightsAttributeSettingError
- Error enum indicating reasons for failure when setting light attributes.
- MapSceneLightsCategory
- The scene uses three categories of lighting which are: Main light, Back light and Rim light.
- MapSceneLoadOptionsBuilderInstantiationErrorCode
- Describes a reason for failing to build a MapSceneLoadOptions.
- MapSceneMapPickFilterContentType
- Type of the map content to be picked.
- MapScheme
- Represents the preconfigured map schemes bundled with the SDK.
- NativeViewMode
- Mode of hosting native Android view in Flutter
- RenderSizeUnit
- Defines different units in which the size is described.
- ShadowQuality
- The shadow quality.
- TranslucentMapLayerGroupErrorCode
- Error codes for creating the group.
- VisibilityState
- Represents the visibility state of an SDK map view's object.
- WatermarkStyle
- Defines the style of the HERE watermark logo.
Typedefs
- HereMapCreatedCallback = void Function(HereMapController mapController)
- Method called when the map is ready to be used.
- HereMapEventCallback = void Function(HereMapEvent event)
- IconProviderCallback = void Function(ImageInfo? imageInfo, String? iconDescription, IconProviderError? error)
-
A callback of this type is invoked when an icon is received from the IconProvider in
the
ImageInfoformat. The callback provides information about the loaded icon, or an IconProviderError if one occurred. - MapCameraDryCameraUpdateCallback = void Function(MapCameraState? cameraState)
- Used to report back results of dry update application to camera.
- MapSceneLightsAttributeSettingCallback = void Function(MapSceneLightsAttributeSettingError? setLightError)
- This callback function allows handling errors that occur during the setting of light attributes.
- MapSceneLoadSceneCallback = void Function(MapError? loadSceneError)
-
Called on the main thread after
loadScene()method finishes loading the scene. - MapViewBaseMapPickCallback = void Function(MapPickResult? mapPickResult)
- Callback for a pick request.
- TakeScreenshotCallback = void Function(ImageInfo? image)
- Callback to be called on retrieval of screenshot.
Exceptions / Errors
- JsonStyleFactoryInstantiationException
- Thrown when failing to create a Style from a JSON source.
- MapCameraAnimationInstantiationException
- Thrown when a problem occurs while trying to create a multi-track MapCameraAnimation.
- MapCameraKeyframeTrackInstantiationException
- Thrown when a problem occurs while trying to create MapCameraKeyframeTrack.
- MapCameraUpdateInstantiationException
- Thrown when a problem occurs while trying to create a MapCameraUpdate.
- MapContentSettingsTrafficRefreshPeriodExceptionException
- Traffic refresh period error exception
- MapLayerBuilderInstantiationException
- Thrown when failing to build a MapLayer.
- MapMarker3DModelInstantiationException
- Thrown when a problem occurs while trying to create MapMarker3DModel.
- MapMarkerTextStyleInstantiationException
- Thrown when a problem occurs while trying to create a MapMarkerTextStyle instance.
- MapMeasureDependentRenderSizeInstantiationException
- Thrown when a problem occurs while trying to create MapMeasureDependentRenderSize.
- MapPolylineRepresentationInstantiationException
- Thrown when a problem occurs while trying to create MapPolylineRepresentation.
- MapSceneLoadOptionsBuilderInstantiationException
- Thrown when failing to build a MapSceneLoadOptions.
- TranslucentMapLayerGroupInstantiationException
- Thrown when failing to build the group.