Enums

An enum property takes either the name or the number. The name is the portable one — the numbers are an implementation detail of the C++ enum and may shift when a value is inserted.

AnimationType

Value	#	Description
ANIMATION_TYPE_NONE	0	No animation is applied.
ANIMATION_TYPE_STEP	1	Step transition is applied at the middle of the animation.
ANIMATION_TYPE_LINEAR	2	Linear transition is used for animation.
ANIMATION_TYPE_SMOOTHSTEP	3	Smooth transition with 2nd order continuity is used for animation.
ANIMATION_TYPE_SPRING	4	Spring-like transition is used for animation.

BillboardOrientation

Value	#	Description
BILLBOARD_ORIENTATION_FACE_CAMERA	0	Billboard always faces the camera plane, regardless of rotation.
BILLBOARD_ORIENTATION_FACE_CAMERA_GROUND	1	Billboard lies parallel to the ground and rotates around it's anchor point to face the camera. SetRotation can be used to offset the final angle of the billboard.
BILLBOARD_ORIENTATION_GROUND	2	Billboard lies on the ground, orientation does not depend on the camera position.

BillboardScaling

Value	#	Description
BILLBOARD_SCALING_WORLD_SIZE	0	Billboard has a constant world space size. Zooming causes the billboard to get smaller or bigger on the screen.
BILLBOARD_SCALING_SCREEN_SIZE	1	Billboard's size on screen is unaffected by zooming, but billboards that are further away from the camera get smaller when the tilt angle is < 90.
BILLBOARD_SCALING_CONST_SCREEN_SIZE	2	Billboard's screen size is always the same, regardless of the zoom level, tilt angle or billboard's position.

massif

Value	#	Description
PACKAGES_ADDED	0
PACKAGES_DELETED	1

ClickType

Value	#	Description
CLICK_TYPE_SINGLE	0	A click caused by pressing down and then releasing the screen.
CLICK_TYPE_LONG	1	A click caused by pressing down but not releasing the screen.
CLICK_TYPE_DOUBLE	2	A click caused by two fast consecutive taps on the screen.
CLICK_TYPE_DUAL	3	A click caused by two simultaneous taps on the screen.

ClusterBuilderMode

Value	#	Description
CLUSTER_BUILDER_MODE_ELEMENTS	0	Cluster builder receives full list of elements in the cluster. This mode is more expensive compared to the light mode.
CLUSTER_BUILDER_MODE_ELEMENT_COUNT	1	Cluster builder receives element count in the cluster. This mode is less expensive compared to the full mode.

ColorFormat

Value	#	Description
COLOR_FORMAT_UNSUPPORTED	0	Options for identifiny unsupported image formats.
COLOR_FORMAT_BGRA	1	An image format that describes images with four channels, one for each color: blue, green and red and one for alpha. This color format will be converted to RGBA.
COLOR_FORMAT_RGBA_4444	2	An image format that describes images with four channels, one for each color: red, green, and blue and one for alpha. Each color is only four bits. This color format will be converted to RGBA.
COLOR_FORMAT_RGB_565	3	An image format that describes images with three channels, one for each color: red, green, and blue. Red and blue colors are each packed into 5 bits, green into 6 bits. This color format will be converted to RGB.

massif

Value	#	Description
NOP	0
DOWNLOAD_PACKAGE_LIST	1
DOWNLOAD_PACKAGE	2
IMPORT_PACKAGE	3
REMOVE_PACKAGE	4
DOWNLOAD_STYLE	5

CompositeSourceType

Value	#	Description
COMPOSITE_SOURCE_TYPE_RASTER	0	A raster tile source, drawn as a RasterTileLayer at its style slot.
COMPOSITE_SOURCE_TYPE_HILLSHADE	1	An RGB-encoded elevation source, drawn as a HillshadeRasterTileLayer at its style slot.
COMPOSITE_SOURCE_TYPE_VECTOR	2	Another MBVT/protobuf source (including ContourTileDataSource), drawn at its style slot as its own child VectorTileLayer using the master decoder, filtered to its own layer name. Kept separate (not merged) so it overzooms independently via its own MaxOverzoomLevel and does not need the DEM at the target zoom.

FreeRoamMode

Value	#	Description
FREE_ROAM_MODE_OFF	0	Off: the standard map gestures. A one-finger drag pans the map.
FREE_ROAM_MODE_LOOK	1	Look: a one-finger drag looks around instead of panning - sideways turns the heading about the camera, up and down tilts the map the way the two-finger tilt does, so the camera still orbits its focus point. Panning moves to a two-finger drag; pinch and two-finger rotation are unchanged.
FREE_ROAM_MODE_FIRST_PERSON	2	First person: the camera stops orbiting anything. A one-finger drag turns the view about the CAMERA on both axes, like a mouse in a first person game - the position never changes - and a two-finger drag moves, forward/back and strafing, the way the keys would. Pinch and two-finger rotation are off, since neither belongs to that control scheme. The camera model applies to every source, not just to touch: setTilt and setMapRotation turn the view in place too, so a camera driven by the device's orientation behaves exactly like the drag.

GeometryType

Value	#	Description
GEOMETRY_TYPE_POINT	0	A single position.
GEOMETRY_TYPE_LINE	1	An ordered list of positions.
GEOMETRY_TYPE_POLYGON	2	An outer ring and any number of holes.
GEOMETRY_TYPE_MULTIPOINT	3	Several points.
GEOMETRY_TYPE_MULTILINE	4	Several lines.
GEOMETRY_TYPE_MULTIPOLYGON	5	Several polygons.
GEOMETRY_TYPE_COLLECTION	6	A mixed collection.

HillshadeMethod

Value	#	Description
STANDARD	0	MapLibre's legacy hillshade algorithm.
COMBINED	1	Combined hillshade algorithm based on GDAL.
IGOR	2	Igor hillshade algorithm based on GDAL.
MULTIDIRECTIONAL	3	Multi-directional hillshade based on GDAL: four light sources at 225, 270, 315 and 360 degrees weighted by the aspect. Ignores the illumination azimuth, uses only its altitude.
BASIC	4	Basic hillshade algorithm based on GDAL.

LineEndType

Value	#	Description
LINE_END_TYPE_NONE	0	No line end points are drawn.
LINE_END_TYPE_SQUARE	1	Line end points are drawn as squares.
LINE_END_TYPE_ROUND	2	Line end points are drawn as half circles.

LineJoinType

Value	#	Description
LINE_JOIN_TYPE_NONE	0	Line segments are not connected with each other. The fastest and ugliest.
LINE_JOIN_TYPE_MITER	1	Line segments are connected with each other using miter connections. This is the preferred mode (fast and good looking generally).
LINE_JOIN_TYPE_BEVEL	2	Line segments are connected with each other using bevel (straight line) connectors. Fast but results in an unnatural line.
LINE_JOIN_TYPE_ROUND	3	Line segments are connected with each other using circle sectors resulting in round corners. Slowest and prettiest.

LocalSpatialIndexType

Value	#	Description
LOCAL_SPATIAL_INDEX_TYPE_NULL	0	Null index, fastest if few elements are used. No element culling is performed.
LOCAL_SPATIAL_INDEX_TYPE_KDTREE	1	K-d tree index, element culling is exact and fast.

MBTilesScheme

Value	#	Description
MBTILES_SCHEME_TMS	0	The default scheme. Vertical coordinate is not flipped.
MBTILES_SCHEME_XYZ	1	Alternative to TMS scheme. Vertical coordinate is flipped.

MapMoveReason

Value	#	Description
MAP_MOVE_REASON_GESTURE	0	The user, directly: a gesture, a mouse wheel, or the inertia that follows one.
MAP_MOVE_REASON_ANIMATION	1	An animation the SDK is stepping - a flight, or a move given a duration. The call that started it reported the reason it was made with; every frame after that is this one.
MAP_MOVE_REASON_API	2	The app, through a call that took effect immediately: setFocusPos, setZoom, an option change that moved the camera.

PackageAction

Value	#	Description
PACKAGE_ACTION_READY	0	Package is ready.
PACKAGE_ACTION_WAITING	1	Package is waiting in the task queue.
PACKAGE_ACTION_DOWNLOADING	2	Package is being downloaded.
PACKAGE_ACTION_COPYING	3	Package data is being copied.
PACKAGE_ACTION_REMOVING	4	Package is being removed.

massif

Value	#	Description
PACKAGES_UPDATED	0
PACKAGES_ADDED	1
PACKAGES_DELETED	2

PackageErrorType

Value	#	Description
PACKAGE_ERROR_TYPE_SYSTEM	0	Internal or system error.
PACKAGE_ERROR_TYPE_CONNECTION	1	Connection or network error.
PACKAGE_ERROR_TYPE_DOWNLOAD_LIMIT_EXCEEDED	2	The number of downloaded packages exceeded subscription limit.
PACKAGE_ERROR_TYPE_PACKAGE_TOO_BIG	3	The bounding box of the package contains too many tiles. This error is only returned for custom bounding box packages.
PACKAGE_ERROR_TYPE_NO_OFFLINE_PLAN	4	The license does not allow downloading offline packages.

PackageTileStatus

Value	#	Description
PACKAGE_TILE_STATUS_MISSING	0	Tile is not part of the package.
PACKAGE_TILE_STATUS_PARTIAL	1	Tile is part of the package, but package does not fully cover it. This value is no longer used, thus this is deprecated.
PACKAGE_TILE_STATUS_FULL	2	Tile if part of the package and package fully covers it.

PackageType

Value	#	Description
PACKAGE_TYPE_MAP	0	Map package.
PACKAGE_TYPE_ROUTING	1	Routing package.
PACKAGE_TYPE_GEOCODING	2	Geocoding package.
PACKAGE_TYPE_VALHALLA_ROUTING	3	Valhalla routing package.

PanningMode

Value	#	Description
PANNING_MODE_FREE	0	Free panning means that the map panning is unrestricted, user is able to zoom, rotate and pan the map at the same time without any artificial limits.
PANNING_MODE_STICKY	1	Sticky panning means that the map panning is restricted, user is able to freely pan the map, but zooming and rotating gestures can't be performed at the same time. User is still able to switch between zooming and rotating the map but it takes a bit more effort compared to FREE panning. gesture is performed and
PANNING_MODE_STICKY_FINAL	2	Final sticky panning means that the map panning is restricted, user is able to freely pan the map, but zooming and rotating gestures can't be performed at the same time. Once the gesture type is determined the user is stuck with either zooming or rotating. To switch the gesture the user has to lift at least one the two fingers off the screen.

PanningSpeedMode

Value	#	Description
PANNING_SPEED_MODE_MAP	0	The map point under the finger follows it exactly, which is what a flat map does. On a tilted view the speed then changes DURING the gesture: a drag that starts near the camera and travels up the screen accelerates as the finger reaches parts of the screen that are further away.
PANNING_SPEED_MODE_ANCHORED	1	The scale is measured where the pan STARTS and stays fixed for the whole gesture: starting far away still pans fast and starting close still pans slowly, but the speed never changes while the finger is down. The default.
PANNING_SPEED_MODE_CONSTANT	2	The scale is measured at the centre of the screen, so it depends neither on where the finger started nor on where it goes - every pan moves the map at the same rate.

PivotMode

Value	#	Description
PIVOT_MODE_TOUCHPOINT	0	The touch point (or middle point between 2 finger touches) is used as the pivot point.
PIVOT_MODE_CENTERPOINT	1	Screen center is always used for pivot point.

RasterTileFilterMode

Value	#	Description
RASTER_TILE_FILTER_MODE_NEAREST	0	No filter (nearest texel).
RASTER_TILE_FILTER_MODE_BILINEAR	1	Bilinear filter (interpolate between 4 closest texels).
RASTER_TILE_FILTER_MODE_BICUBIC	2	Bicubic filter (interpolate between 16 closest texels).

RenderProjectionMode

Value	#	Description
RENDER_PROJECTION_MODE_PLANAR	0	Planar projection.
RENDER_PROJECTION_MODE_SPHERICAL	1	Spherical projection.

RouteMatchingPointType

Value	#	Description
ROUTE_MATCHING_POINT_UNMATCHED	0	The point was unmatched.
ROUTE_MATCHING_POINT_INTERPOLATED	1	The point was interpolated.
ROUTE_MATCHING_POINT_MATCHED	2	The point was matched.

RoutingAction

Value	#	Description
ROUTING_ACTION_HEAD_ON	0	Head on, start the route.
ROUTING_ACTION_FINISH	1	Finish the route.
ROUTING_ACTION_NO_TURN	2	Continue along the given street, do not turn.
ROUTING_ACTION_GO_STRAIGHT	3	Go straight.
ROUTING_ACTION_TURN_RIGHT	4	Turn right.
ROUTING_ACTION_UTURN	5	Do an u-turn.
ROUTING_ACTION_TURN_LEFT	6	Turn left.
ROUTING_ACTION_REACH_VIA_LOCATION	7	Reached given via point. If this is the final point, FINISH action is used instead.
ROUTING_ACTION_ENTER_ROUNDABOUT	8	Enter roundabout. Used by Valhalla and OSRM.
ROUTING_ACTION_LEAVE_ROUNDABOUT	9	Leave roundabout. Used by Valhalla and OSRM.
ROUTING_ACTION_STAY_ON_ROUNDABOUT	10	Continue along the roundabout. Only used by OSRM.
ROUTING_ACTION_START_AT_END_OF_STREET	11	Start at the end of the street. Currently used only by OSRM.
ROUTING_ACTION_ENTER_AGAINST_ALLOWED_DIRECTION	12	Enter street while moving against the allowed direction. Only used by OSRM.
ROUTING_ACTION_LEAVE_AGAINST_ALLOWED_DIRECTION	13	Leave the street while moving aginst the allowed direction. Only used by OSRM.
ROUTING_ACTION_GO_UP	14	Go up. Only used by the SGRE.
ROUTING_ACTION_GO_DOWN	15	Go down. Only used by SGRE.
ROUTING_ACTION_WAIT	16	Wait. Only used by SGRE.
ROUTING_ACTION_ENTER_FERRY	17	Enter ferry. Only used by Valhalla.
ROUTING_ACTION_LEAVE_FERRY	18	Leave ferry. Only used by Valhalla.

SkyQuality

Value	#	Description
SKY_QUALITY_LOW	0	5 samples along the view ray, 3 towards the sun.
SKY_QUALITY_MEDIUM	1	8 and 4. The default.
SKY_QUALITY_HIGH	2	12 and 5.

SkyType

Value	#	Description
SKY_TYPE_GRADIENT	0	A gradient between HorizonColor and SkyColor. What the SDK drew before the atmosphere existed; pick it for a flat, stylised or brand-coloured sky.
SKY_TYPE_ATMOSPHERE	1	Rayleigh and Mie single scattering, integrated along the view ray. The blue zenith, the reddening at a low sun and the halo around it all come out of the model rather than out of a colour ramp, so the sky follows the time of day on its own.

TerrainFlattenMode

Value	#	Description
TERRAIN_FLATTEN_MODE_RENDER	0	Rendering only: the terrain passes, the drape and the elevation fetches are dropped, but the tiles keep the terrain subdivision they were decoded with. Switching costs nothing and is instant, and a flat map still carries a 3D map's triangles.
TERRAIN_FLATTEN_MODE_FULL	1	The whole way: a flat map decodes, culls and draws as if no terrain were configured. The price is a re-decode at each switch, paid while the map is already flat.

TileFormat

Value	#	Description
TILE_FORMAT_AUTO	0	Detect the format from the tile data. The two are unambiguous in practice, but set the format explicitly when the source is known - it skips the check and cannot be fooled.
TILE_FORMAT_MVT	1	MapBox Vector Tile, the protobuf format.
TILE_FORMAT_MLT	2	MapLibre Tile, the columnar format. Smaller tiles and faster decoding, but the whole tile is decoded at once - MVT decodes only the layers and attributes the style asks for.

TileLODProfile

Value	#	Description
TILE_LOD_PROFILE_REFERENCE	0	The reference density: TileLODFactor 1, which is tangram's rule, mapbox's and maplibre's alike - a tile is refined while it covers more than a 2x2 block of nominal tiles. Fewest tiles, and what every reference renderer ships.
TILE_LOD_PROFILE_MOBILE	1	Half a level finer than the reference, with a shorter style zoom lift. Meant for a phone: visibly sharper than the reference at roughly twice its tile count.
TILE_LOD_PROFILE_DESKTOP	2	A full level finer than the reference (TileLODFactor 0.5, the historical default), about 4x its tile count. Meant for a desktop or a web page on a real GPU.

TileSubstitutionPolicy

Value	#	Description
TILE_SUBSTITUTION_POLICY_ALL	0	Consider all cached/loaded tiles.
TILE_SUBSTITUTION_POLICY_VISIBLE	1	Consider only tiles that are currently visible. This is recommended for low-latency data sources, like offline sources.
TILE_SUBSTITUTION_POLICY_NONE	2	Never substitute tiles.

VariantType

Value	#	Description
VARIANT_TYPE_NULL	0	Null element.
VARIANT_TYPE_STRING	1	String element.
VARIANT_TYPE_BOOL	2	Boolean element.
VARIANT_TYPE_INTEGER	3	Integer element.
VARIANT_TYPE_DOUBLE	4	Double-precision floating point element.
VARIANT_TYPE_ARRAY	5	Array element.
VARIANT_TYPE_OBJECT	6	Object (dictionary) element.

VectorElementDragMode

Value	#	Description
VECTOR_ELEMENT_DRAG_MODE_VERTEX	0	A single vertex is being moved.
VECTOR_ELEMENT_DRAG_MODE_ELEMENT	1	The whole vector element is being moved.

VectorElementDragPointStyle

Value	#	Description
VECTOR_ELEMENT_DRAG_POINT_STYLE_NORMAL	0	Normal control point. Corresponds to vertex.
VECTOR_ELEMENT_DRAG_POINT_STYLE_VIRTUAL	1	Virtual control point (midpoint between actual vertices). Used for lines and polygons.
VECTOR_ELEMENT_DRAG_POINT_STYLE_SELECTED	2	Selected control point.

VectorElementDragResult

Value	#	Description
VECTOR_ELEMENT_DRAG_RESULT_IGNORE	0	Dragging should be ignored. The input event will be passed on to other handlers.
VECTOR_ELEMENT_DRAG_RESULT_STOP	1	Dragging should be ignored. The input event is not passed on to other handlers.
VECTOR_ELEMENT_DRAG_RESULT_MODIFY	2	The underlying vector element (or vertex) should be modified.
VECTOR_ELEMENT_DRAG_RESULT_DELETE	3	The underlying vector element or vertex should be deleted.

VectorTileRenderOrder

Value	#	Description
VECTOR_TILE_RENDER_ORDER_HIDDEN	-1	No rendering, elements are hidden.
VECTOR_TILE_RENDER_ORDER_LAYER	0	Elements are rendered together with the same layer elements. Layers that are on top of the layers are rendered on top this layer.
VECTOR_TILE_RENDER_ORDER_LAST	1	Elements are rendered on top of all normal layers.