MapViewPreferences class Maps & 3D Scenes
Map view preferences.
This class exposes view-level preferences and collections for a GemMap. Use GemView.preferences to obtain an instance rather than constructing this class directly.
The preferences control what is displayed on the map and how the view behaves. Examples include enabling/disabling touch gestures, configuring camera behavior (perspective and view angles), changing map style, toggling rendering options (FPS display, fast browsing), managing cursor mode, and controlling visibility for traffic, buildings and labels.
The class also provides access to collections used by the view:
- lmks — landmark store settings (LandmarkStoreCollection).
- markers — visible marker collections (MapViewMarkerCollections).
- paths — visible path collections (
MapViewPathCollection). - routes — visible route collections (MapViewRoutesCollection).
Constructors
Properties
- areMapScalesDrawnByUser ↔ bool
-
Get whether map scales are drawn by the user or SDK.
getter/setter pair
- buildingsVisibility ↔ BuildingsVisibility
-
Get buildings visibility option.
getter/setter pair
- carModelByPath ← String
-
Set the car model by file path.
no getter
- cursorEnabled → bool
-
Check if the cursor is enabled.
no setter
- cursorRenderEnabled → bool
-
Check if cursor rendering is enabled.
no setter
- disableFastLoading ↔ bool
-
Check whether fast loading is disabled.
getter/setter pair
- drawFPS → bool
-
Get frames-per-second draw state.
no setter
- elevationAlphaFactor ↔ double
-
Get the elevation alpha factor.
getter/setter pair
- enableCursor ← bool
-
Enable or disable cursor mode.
no getter
- enableCursorRender ← bool
-
Enable or disable cursor rendering.
no getter
-
focusViewport
↔ Rectangle<
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 visible landmark stores.
no setter
- mapAngle ↔ double
-
Get the map's angle in degrees.
getter/setter pair
- mapDetailsQualityLevel ↔ MapDetailsQualityLevel
-
Get the map details quality level.
getter/setter pair
- mapId → int
-
no setter
- mapLabelsContinuousRendering ↔ bool
-
Get the map labels continuous rendering flag.
getter/setter pair
- mapLabelsFading ↔ bool
-
Get the map labels fading state.
getter/setter pair
-
mapScalePosition
↔ Rectangle<
int> -
Get the map scale position.
getter/setter pair
- mapStyleId → int
-
Get the current view style content id.
no setter
- mapStylePath → String
-
Get the current map view style path.
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 in degrees.
no setter
- minViewAngle → double
-
Get the minimum viewing angle in degrees.
no setter
- northFixedFlag ↔ bool
-
Get the North-fixed flag value.
getter/setter pair
- paths → MapViewPathCollection
-
Get access to the collection of visible paths.
no setter
- pointerId → dynamic
-
no setter
- 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
- showMapScale ↔ bool
-
Check whether the map scale is shown.
getter/setter pair
- tiltAngle ↔ double
-
Get the tilt angle in degrees.
getter/setter pair
- touchGesturesStates ↔ int
-
Get enabled touch gestures bitfield.
getter/setter pair
- trafficVisibility → bool
-
Get traffic visibility.
no setter
- viewAngle → double
-
Get the camera's pitch angle in degrees.
no setter
Methods
-
dispose(
) → void - Releases native resources associated with this preferences instance.
-
enableTouchGestures(
List< TouchGestures> gestures, bool enable) → void - Enable or disable specific touch gestures for the map view.
-
isMapSceneObjectVisible(
MapSceneObject obj) → bool - Check whether a MapSceneObject is visible in the current view.
-
isTouchGestureEnabled(
TouchGestures gesture) → bool - Check whether a 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 or disable frames-per-second drawing.
-
setMapSceneObjectVisibility(
MapSceneObject obj, bool visible) → void - Set visibility of a MapSceneObject in the current view.
-
setMapStyle(
ContentStoreItem style, {bool smoothTransition = false}) → void - Set map view style 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 style 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.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited