MapViewPreferences - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > MapViewPreferences

MapViewPreferences class

Mapview preferences

Signature:

export declare class MapViewPreferences

Constructors

Constructor	Modifiers	Description
(constructor)()		Constructs a new instance of the `MapViewPreferences` class

Properties

Property	Modifiers	Type	Description
areMapScalesDrawnByUser		boolean	Get if the map scales are drawn by the user or by the SDK
buildingsVisibility		BuildingsVisibility	Get buildings visibility option.
carModelByPath		string	Set car model by path.
cursorEnabled	`readonly`	boolean	Check if cursor is enabled.
cursorRenderEnabled	`readonly`	boolean	Check if cursor render is enabled.
drawFPS	`readonly`	boolean	Get frames per second draw state.
enableCursor		boolean	Check if the cursor mode is enabled.
enableCursorRender		boolean	Check if the cursor rendering is enabled.
focusViewport		RectType<number>	Get the map view focus viewport.
followPositionPreferences	`readonly`	FollowPositionPreferences	Get follow position preferences.
isFastBrowsingEnabled		boolean	Check if fast browsing is enabled
lmks	`readonly`	LandmarkStoreCollection	Get access to the settings for the visible landmark stores.
mapDetailsQualityLevel		MapDetailsQualityLevel	Get map details quality level.
mapId	`readonly`	number
mapScalePosition		RectType<number>	Get the map scale position.
mapStyleId	`readonly`	number	Get the current view style content id.
mapStylePath	`readonly`	string	Get the current map view style
mapViewPerspective	`readonly`	MapViewPerspective	Get the map view perspective.
markers	`readonly`	MapViewMarkerCollections	Get access to the collections of visible markers.
maxViewAngle	`readonly`	number	Get the maximum viewing angle.
minViewAngle	`readonly`	number	Get the minimum viewing angle.
northFixedFlag	`readonly`	boolean	Get the value of the NorthFixed flag.
overlays	`readonly`	MapViewOverlayCollection	Get access to the collection of visible overlays.
paths	`readonly`	MapViewPathCollection
pointerId	`readonly`	number \| bigint
rotationAngle		number	Get map rotation angle in degrees relative to north-south axis.
routes	`readonly`	MapViewRoutesCollection	Get access to the collection of visible routes.
setNorthFixedFlag		boolean	Set the value of the NorthFixed flag.
showMapScale		boolean	Check if map scale is shown
tiltAngle		number	Get tilt angle in degrees.
touchGesturesStates		number	Get enabled touch gestures packed.
trafficVisibility	`readonly`	boolean	Get traffic visibility.
viewAngle	`readonly`	number	Get the viewing angle.

Methods

Method	Modifiers	Description
dispose()
enableTouchGestures(gestures, enable)		Enable / disable touch gestures.
init(id, mapId, mapPointerId)	`static`
isTouchGestureEnabled(gesture)		Check if touch gesture is enabled.
setDrawFPS(isEnabled, pos)		Enable/disable frames per second draw.
setMapStyle(style, smoothTransition)		Set map view details by content.
setMapStyleByBuffer(buffer, smoothTransition)		Set map view style by content buffer
setMapStyleById(id, smoothTransition)		Set map view details by content id.
setMapStyleByPath(path, smoothTransition)		Set map view style by content path
setMapViewPerspective(perspective, animation)		Set the map view perspective.
setTrafficVisibility(isVisible)		Set traffic visibility.
setViewAngle(viewAngle, animated)		Set the viewing angle.
updateCurrentStyleFromJson(buffer)