MapViewPreferences class Maps & 3D Scene
Mapview preferences
This class should not be instantiated directly. Instead, use the GemView.preferences getter to obtain an instance.
Allows the customization of what is displayed on the GemMap and how it behaves:
- Enable or disable touch gestures (tap, swipe, pinch, etc.)
- Configure camera behavior, perspective and view angles (including followPositionPreferences)
- Change map style and control smooth style transitions
- Show and customize the map scale (SDK-drawn or user-drawn)
- Manage cursor mode and cursor rendering
- Adjust rendering options (FPS display, fast browsing, elevation/shadow)
- Toggle traffic, buildings and label visibility and quality
Also provides access for the collections of elements to be displayed of the map:
- lmks - LandmarkStoreCollection — settings / stores for visible landmarks (addresses / POI / city or custom markers). Allows the filtering of landmarks based on store and category.
- markers - MapViewMarkerCollections — collections of visible marker sets and their render settings.
- overlays - MapViewOverlayCollection — overlay collections associated with the current style.
- paths - MapViewPathCollection — visible path collections.
- routes - MapViewRoutesCollection — visible route collections.
Constructors
Properties
- areMapScalesDrawnByUser ↔ bool
-
Get if the map scales are drawn by the user or by the SDK
getter/setter pair
- buildingsVisibility ↔ BuildingsVisibility
-
Get buildings visibility option.
getter/setter pair
- carModelByPath ← String
-
Set car model by path.
no getter
- cursorEnabled → bool
-
Check if cursor is enabled.
no setter
- cursorRenderEnabled → bool
-
Check if cursor render is enabled.
no setter
- disableFastLoading ↔ bool
-
Check if fast loading is disabled or not
getter/setter pair
- drawFPS → bool
-
Get frames per second draw state.
no setter
- elevationAlphaFactor ↔ double
-
Get the value of the elevation alpha factor.
getter/setter pair
- enableCursor ← bool
-
Enable/Disable the cursor mode When the cursor is enabled map selection can be activated by calling setCursorScreenPosition The cursor is automatically disabled by GemView.startFollowingPosition.
no getter
- enableCursorRender ← bool
-
Enable/Disable the cursor rendering.
no getter
-
focusViewport
↔ RectType<
int> -
Get the map view focus viewport.
getter/setter pair
- followPositionPreferences → FollowPositionPreferences
-
Get follow position preferences.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- isFastBrowsingEnabled ↔ bool
-
Get fast browsing status
getter/setter pair
- lmks → LandmarkStoreCollection
-
Get access to the settings for the visible landmark stores.
no setter
- mapAngle ↔ double
-
The map's angle in degrees. Is between 0 and 360 degrees, where 0 represents north-up alignment.
getter/setter pair
- mapDetailsQualityLevel ↔ MapDetailsQualityLevel
-
Get map details quality level.
getter/setter pair
- mapId → int
-
no setter
- mapLabelsContinuousRendering ↔ bool
-
Get the map labels continuous rendering.
getter/setter pair
- mapLabelsFading ↔ bool
-
Get the map labels fading state
getter/setter pair
-
mapScalePosition
↔ RectType<
int> -
Get the map scale position.
getter/setter pair
- mapStyleId → int
-
Get the current view style content id. See ContentStoreItem.id.
no setter
- mapStylePath → String
-
Get the current map view style
no setter
- mapViewPerspective → MapViewPerspective
-
Get the map view perspective.
no setter
- markers → MapViewMarkerCollections
-
Get access to the collections of visible markers.
no setter
- maxViewAngle → double
-
Get the maximum viewing angle.
no setter
- minViewAngle → double
-
Get the minimum viewing angle.
no setter
- northFixedFlag ↔ bool
-
Get the value of the NorthFixed flag.
getter/setter pair
- overlays → MapViewOverlayCollection
-
Get access to the collection of visible overlays.
no setter
- paths → MapViewPathCollection
-
Get access to the collection of visible paths.
no setter
- pointerId → dynamic
-
no setter
- rotationAngle ↔ double
-
getter/setter pair
- routes → MapViewRoutesCollection
-
Get access to the collection of visible routes.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- setNorthFixedFlag ← bool
-
Set the value of the NorthFixed flag.
no getter
- showMapScale ↔ bool
-
Check if map scale is shown
getter/setter pair
- tiltAngle ↔ double
-
Get tilt angle in degrees.
getter/setter pair
- touchGesturesStates ↔ int
-
Get enabled touch gestures packed.
getter/setter pair
- trafficVisibility → bool
-
Get traffic visibility.
no setter
- viewAngle → double
-
The camera's pitch angle in degrees. Is between 0 and 90, where 0 represents a direct top-down view.
no setter
Methods
-
dispose(
) → void -
enableTouchGestures(
List< TouchGestures> gestures, bool enable) → void - Enable / disable touch gestures.
-
isMapSceneObjectVisible(
MapSceneObject obj) → bool - Get the given map scene object visibility in current view.
-
isTouchGestureEnabled(
TouchGestures gesture) → bool - Check if touch gesture is enabled.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setDrawFPS(
bool isEnabled, Point< int> pos) → void - Enable/disable frames per second draw.
-
setMapSceneObjectVisibility(
MapSceneObject obj, bool visible) → void - Set the given map scene object visibility in current view.
-
setMapStyle(
ContentStoreItem style, {bool smoothTransition = false}) → void - Set map view details by content.
-
setMapStyleByBuffer(
Uint8List buffer, {bool smoothTransition = false}) → void - Set map view style by content buffer
-
setMapStyleById(
int id, {bool smoothTransition = false}) → void - Set map view details by content id.
-
setMapStyleByPath(
String path, {bool smoothTransition = false}) → void - Set map view style by content path
-
setMapViewPerspective(
MapViewPerspective perspective, {GemAnimation? animation}) → void - Set the map view perspective.
-
setTrafficVisibility(
bool isVisible) → GemError - Set traffic visibility.
-
setViewAngle(
double viewAngle, {bool animated = false}) → void - Set the camera's pitch angle in degrees. Must be between 0 and 90, where 0 represents a direct top-down view.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited