These are not created with a spec. They arrive as an event payload, a call result or the value of an OBJECT property, and their properties are readable through the same dotted paths.
Address
| Property | Type | Access | Description |
|---|
categories | struct std::vector<std::string> | read-only | Returns the list of category tags describing the address. |
country | string | read-only | Returns the country name included in the address. |
county | string | read-only | Returns the county name included in the address. |
houseNumber | string | read-only | Returns the house number included in the address. |
locality | string | read-only | Returns the locality (city, town, village) name included in the address. |
name | string | read-only | Returns the name included in the address. |
neighbourhood | string | read-only | Returns the local neighbourhood name included in the address. |
postcode | string | read-only | Returns the postcode of the address. |
region | string | read-only | Returns the region name included in the address. |
street | string | read-only | Returns the street name included in the address. |
AnimationStyle
| Property | Type | Access | Description |
|---|
fadeAnimationType | enum | read-only | Returns the fade animation type. |
phaseInDuration | number | read-only | Returns the phase-in duration of the animation. |
phaseOutDuration | number | read-only | Returns the phase-out duration of the animation. |
relativeSpeed | number | read-only | Returns the relative speed of the animation. |
sizeAnimationType | enum | read-only | Returns the size-related animation type. |
AnimationStyleBuilder
| Property | Type | Access | Description |
|---|
fadeAnimationType | enum | read/write | Returns the fade animation type. |
phaseInDuration | number | read/write | Returns the phase-in duration of the animation. |
phaseOutDuration | number | read/write | Returns the phase-out duration of the animation. |
relativeSpeed | number | read/write | Returns the relative speed of the animation. |
sizeAnimationType | enum | read/write | Returns the size-related animation type. |
| Property | Type | Access | Description |
|---|
style | object styles.BalloonPopupButtonStyle | read-only | Returns the style of this button. |
tag | variant | read/write | Returns the user-defined tag associated with the button. |
text | string | read-only | Returns the text of this button. |
| Property | Type | Access | Description |
|---|
button | object vectorelements.BalloonPopupButton | read-only | Returns the clicked button. |
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickType | enum | read-only | Returns the click type. |
vectorElement | object vectorelements.VectorElement | read-only | Returns the clicked vector element. |
| Property | Type | Access | Description |
|---|
backgroundColor | color | read-only | Returns the background color of the button. |
buttonWidth | integer | read-only | Returns the width of the button. If this value is -1, then button width is calculated automatically based on button text. |
cornerRadius | integer | read-only | Returns the corner radius of the button. |
strokeColor | color | read-only | Returns the color of the stroke surrounding the button. |
strokeWidth | integer | read-only | Returns the width of the stroke surrounding the button. |
textColor | color | read-only | Returns the color of the text. |
textFontName | string | read-only | Returns the name of the text font. |
textFontSize | integer | read-only | Returns the size of the text font. |
textMargins | struct massif::BalloonPopupMargins | read-only | Returns the margins of the text. |
Inherited from Style:
| Property | Type | Access | Description |
|---|
color | color | read-only | Returns the color of the vector element. |
| Property | Type | Access | Description |
|---|
buttonWidth | integer | read/write | Returns the width of the button. If this value is -1, then button width is calculated automatically based on button text. |
cornerRadius | integer | read/write | Returns the corner radius of the button. |
strokeColor | color | read/write | Returns the color of the stroke surrounding the button. |
strokeWidth | integer | read/write | Returns the width of the stroke surrounding the button. |
textColor | color | read/write | Returns the color of the text. |
textFontName | string | read/write | Returns the name of the text font. |
textFontSize | integer | read/write | Returns the size of the text font. |
textMargins | struct massif::BalloonPopupMargins | read/write | Returns the margins of the text. |
Inherited from StyleBuilder:
| Property | Type | Access | Description |
|---|
color | color | read/write | Returns the color of the vector element. |
| Property | Type | Access | Description |
|---|
bottom | integer | read-only | |
left | integer | read-only | |
right | integer | read-only | |
top | integer | read-only | |
BaseMapView
| Property | Type | Access | Description |
|---|
cameraPos | struct massif::MapPos | read-only | Returns the position the camera itself is above, which at a low tilt is nowhere near the focus - the focus is what the camera looks AT, kilometres out in front of it. This is the viewpoint: where a first-person camera stands, and where a top-down view has to be centred to come back to the same place. |
flightActive | boolean | read-only | Returns true while a flyTo animation is running. |
flightProgress | number | read-only | How far along a flyTo animation is, from 0 to 1, or -1 when none is running. It is the value the camera is actually at, so an app animating its own state alongside the move (a layer fading in, a mode switching over) reads it rather than running its own clock. |
focusPos | struct massif::MapPos | read-only | Returns the position that the camera is currently looking at. |
rotation | number | read-only | Returns the map rotation in degrees. 0 means looking north, 90 means west, -90 means east and 180 means south. |
tilt | number | read-only | Returns the tilt angle in degrees. 0 means looking directly at the horizon, 90 means looking directly down. |
zoom | number | read-only | Returns the zoom level. The value returned is never negative, 0 means absolutely zoomed out and all other values describe some level of zoom. |
| Method | Arguments | Returns |
|---|
fitBounds | bounds: json, screenBounds: json, integerZoom: bool, resetRotation: bool, resetTilt: bool, durationSeconds: float | void |
flyTo | pos: pos, zoom: float, rotation: float, tilt: float, climbHeight: float, durationSeconds: float | void |
mapToScreen | pos: pos | json |
moveTo | pos: pos, zoom: float, rotation: float, tilt: float | void |
screenToMap | x: float, y: float | json |
stopFlight | — | void |
CelestialArc
| Property | Type | Access | Description |
|---|
belowHorizonVisible | boolean | read/write | Returns whether the part of the curve below the horizon is drawn. |
clickRadius | number | read/write | Returns the click radius of the curve. |
radius | number | read-only | Returns the angular radius of a circular arc. |
segmented | boolean | read-only | Returns true if the directions are read as separate segments rather than as a path. |
width | number | read/write | Returns the line width. |
Inherited from CelestialObject:
| Property | Type | Access | Description |
|---|
altitude | number | read-only | Returns the altitude of a direction-anchored object. |
azimuth | number | read-only | Returns the azimuth of a direction-anchored object. |
color | color | read/write | Returns the color of the object. |
directionAnchored | boolean | read-only | Returns true if the object is anchored by direction, false if by geographic position. |
distance | number | read-only | Returns the distance of a direction-anchored object. |
position | struct massif::MapPos | read-only | Returns the geographic position of a position-anchored object. |
positionAltitude | number | read-only | Returns the altitude of a position-anchored object. |
visible | boolean | read/write | Returns the visibility of the object. |
CelestialLayer
| Property | Type | Access | Description |
|---|
celestialEventListener | object layers.CelestialEventListener | read/write | Returns the object event listener. |
Inherited from Layer:
| Property | Type | Access | Description |
|---|
cullDelay | integer | read/write | Returns the culling delay of the layer in milliseconds. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the layer meta data map. The changes you make to this map are NOT reflected in the actual meta data of the layer. |
opacity | number | read/write | Returns the opacity of this layer. |
postProcessed | boolean | read/write | Returns whether this layer goes through the post-process effect. |
updatePriority | integer | read/write | Returns the layer task priority of this layer. |
visible | boolean | read/write | Returns the visibility of this layer. |
visibleZoomRange | struct massif::MapRange | read/write | Returns the visible zoom range of this layer. |
| Method | Arguments | Returns |
|---|
refresh | — | void |
CelestialObject
| Property | Type | Access | Description |
|---|
altitude | number | read-only | Returns the altitude of a direction-anchored object. |
azimuth | number | read-only | Returns the azimuth of a direction-anchored object. |
color | color | read/write | Returns the color of the object. |
directionAnchored | boolean | read-only | Returns true if the object is anchored by direction, false if by geographic position. |
distance | number | read-only | Returns the distance of a direction-anchored object. |
position | struct massif::MapPos | read-only | Returns the geographic position of a position-anchored object. |
positionAltitude | number | read-only | Returns the altitude of a position-anchored object. |
visible | boolean | read/write | Returns the visibility of the object. |
CelestialSprite
| Property | Type | Access | Description |
|---|
angularSize | number | read/write | Returns the angular size of the sprite. |
bitmap | object graphics.Bitmap | read/write | Returns the bitmap of the sprite. |
clickRadius | number | read/write | Returns the extra radius that responds to a click. |
screenSize | number | read/write | Returns the screen size of the sprite. |
softness | number | read/write | Returns the edge softness of a disc sprite. |
Inherited from CelestialObject:
| Property | Type | Access | Description |
|---|
altitude | number | read-only | Returns the altitude of a direction-anchored object. |
azimuth | number | read-only | Returns the azimuth of a direction-anchored object. |
color | color | read/write | Returns the color of the object. |
directionAnchored | boolean | read-only | Returns true if the object is anchored by direction, false if by geographic position. |
distance | number | read-only | Returns the distance of a direction-anchored object. |
position | struct massif::MapPos | read-only | Returns the geographic position of a position-anchored object. |
positionAltitude | number | read-only | Returns the altitude of a position-anchored object. |
visible | boolean | read/write | Returns the visibility of the object. |
ClickInfo
| Property | Type | Access | Description |
|---|
clickType | enum | read-only | Returns the click type. |
duration | number | read-only | Returns the click duration in seconds. |
ClusteredVectorLayer
| Property | Type | Access | Description |
|---|
animatedClusters | boolean | read/write | Returns the cluster animation flag value. |
clusterElementBuilder | object layers.ClusterElementBuilder | read-only | Returns the current callback used for creating cluster elements. |
maximumClusterZoom | number | read/write | Returns the maximum zoom level when clusters are shown. If zoom level is greater, then clusters are replaced with individual elements. Default is 24. |
minimumClusterDistance | number | read/write | Returns the current minimum distance between clusters (in device-independent pixels). |
Inherited from VectorLayer:
| Property | Type | Access | Description |
|---|
ZBuffering | boolean | read/write | Returns true if Z-buffering is enabled for 2D geometry. By default it is disabled and used only for billboards. |
dataSource | object datasources.VectorDataSource | read-only | Returns the vector data source of this vector layer. |
vectorElementEventListener | object layers.VectorElementEventListener | read/write | Returns the vector element event listener. |
Inherited from Layer:
| Property | Type | Access | Description |
|---|
cullDelay | integer | read/write | Returns the culling delay of the layer in milliseconds. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the layer meta data map. The changes you make to this map are NOT reflected in the actual meta data of the layer. |
opacity | number | read/write | Returns the opacity of this layer. |
postProcessed | boolean | read/write | Returns whether this layer goes through the post-process effect. |
updatePriority | integer | read/write | Returns the layer task priority of this layer. |
visible | boolean | read/write | Returns the visibility of this layer. |
visibleZoomRange | struct massif::MapRange | read/write | Returns the visible zoom range of this layer. |
| Method | Arguments | Returns |
|---|
refresh | — | void |
| Event | Payload | Consumable |
|---|
vectorelement.clicked | VectorElementClickInfo | yes |
Color
| Property | Type | Access | Description |
|---|
ARGB | integer | read-only | Encodes this map color into 32-bit integer value (ARGB format). |
a | integer | read-only | Returns the alpha component of this map color. |
b | integer | read-only | Returns the blue component of this map color. |
g | integer | read-only | Returns the green component of this map color. |
r | integer | read-only | Returns the red component of this map color. |
ContourTileDataSource
| Property | Type | Access | Description |
|---|
baseInterval | number | read/write | Returns the base contour interval in meters. |
labelInterval | number | read/write | Returns the contour interval used for label stubs. |
labelStubsEnabled | boolean | read/write | Returns whether only short label stubs are generated instead of full contour lines. |
layerName | string | read/write | Returns the name of the generated vector tile layer. |
minVisibleZoom | integer | read/write | Returns the minimum zoom at which contour geometry is generated. |
resolution | integer | read/write | Returns the target grid resolution used for contour tracing. |
seamlessEdgesEnabled | boolean | read/write | Returns whether seamless tile edges are enabled. |
simplifyTolerance | number | read/write | Returns the simplification tolerance in tile pixels. |
terrainOptions | object std::shared_ptr<massif::TerrainOptions> | read/write | Returns the terrain options whose elevation manager the label stubs read. |
Inherited from TileDataSource:
| Property | Type | Access | Description |
|---|
dataExtent | struct massif::MapBounds | read-only | Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source. |
maxOverzoomLevel | integer | read/write | Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn" |
maxZoom | integer | read-only | Returns the maximum zoom level supported by this data source. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's. |
minZoom | integer | read-only | Returns the minimum zoom level supported by this data source. |
projection | object projections.Projection | read-only | Returns the projection of this tile source. |
| Method | Arguments | Returns |
|---|
getMetaDataElement | key: string | json |
loadTile | tile: tile | object |
setMetaDataElement | key: string, value: json | void |
CullState
| Property | Type | Access | Description |
|---|
viewState | struct massif::ViewState | read-only | Returns a view state. |
| Property | Type | Access | Description |
|---|
popupHandler | object vectorelements.CustomPopupHandler | read-only | Returns the handler used for the popup. |
Inherited from Popup:
| Property | Type | Access | Description |
|---|
anchorPointX | number | read/write | Returns the horizontal anchor point of this popup. |
anchorPointY | number | read/write | Returns the vertical anchor point of this popup. |
style | object styles.PopupStyle | read/write | Returns the style of this Popup. |
Inherited from Billboard:
| Property | Type | Access | Description |
|---|
baseBillboard | object std::shared_ptr<massif::Billboard> | read/write | Returns the base billboard this billboard is attached to. |
bounds | struct massif::MapBounds | read-only | Returns the bounds of this billboard or the base billboard, if there is one. |
geometry | object geometry.Geometry | read/write | Returns the geometry object that defines the location of this billboard. |
rootGeometry | object geometry.Geometry | read-only | Returns the location of the root billboard. If this billboard has a location, this method is equavalent to the Billboard::getGeometry method. If this billboard is attached to another billboard, the hierarchy is traveled recursively and the location of the root billboard is returned. |
rotation | number | read/write | Returns the rotation angle of this billboard. |
Inherited from VectorElement:
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the bounds of this vector element. |
geometry | object geometry.Geometry | read-only | Returns the geometry object that defines the location of this vector element. |
id | integer | read/write | Returns the internal id of this vector element. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the vector element meta data map. The changes you make to this map are NOT reflected in the actual meta data of the element. |
visible | boolean | read/write | Returns the state of the visibility flag of this vector element. |
EditableVectorLayer
| Property | Type | Access | Description |
|---|
selectedVectorElement | object std::shared_ptr<massif::VectorElement> | read/write | Returns the selected vector element. If no element is currently selected, null is returned. |
vectorEditEventListener | object layers.VectorEditEventListener | read/write | Returns the current edit event listener for the layer. |
Inherited from VectorLayer:
| Property | Type | Access | Description |
|---|
ZBuffering | boolean | read/write | Returns true if Z-buffering is enabled for 2D geometry. By default it is disabled and used only for billboards. |
dataSource | object datasources.VectorDataSource | read-only | Returns the vector data source of this vector layer. |
vectorElementEventListener | object layers.VectorElementEventListener | read/write | Returns the vector element event listener. |
Inherited from Layer:
| Property | Type | Access | Description |
|---|
cullDelay | integer | read/write | Returns the culling delay of the layer in milliseconds. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the layer meta data map. The changes you make to this map are NOT reflected in the actual meta data of the layer. |
opacity | number | read/write | Returns the opacity of this layer. |
postProcessed | boolean | read/write | Returns whether this layer goes through the post-process effect. |
updatePriority | integer | read/write | Returns the layer task priority of this layer. |
visible | boolean | read/write | Returns the visibility of this layer. |
visibleZoomRange | struct massif::MapRange | read/write | Returns the visible zoom range of this layer. |
| Method | Arguments | Returns |
|---|
refresh | — | void |
| Event | Payload | Consumable |
|---|
vectorelement.clicked | VectorElementClickInfo | yes |
FeatureBuilder
| Property | Type | Access | Description |
|---|
geometry | object geometry.Geometry | read/write | Returns the geometry of the builder. |
FeatureCollection
| Property | Type | Access | Description |
|---|
featureCount | integer | read-only | Returns the number of features in this container. |
| Method | Arguments | Returns |
|---|
getFeature | index: int | object |
FeatureCollectionSearchService
| Property | Type | Access | Description |
|---|
featureCollection | object std::shared_ptr<massif::FeatureCollection> | read-only | Returns the feature collection of the search service. |
maxResults | integer | read/write | Returns the maximum number of results the search service returns. |
projection | object std::shared_ptr<massif::Projection> | read-only | Returns the projection of the feature collection of the search service. |
| Method | Arguments | Returns |
|---|
findFeatures | request: handle | object |
GeoJSONGeometryReader
| Property | Type | Access | Description |
|---|
targetProjection | object projections.Projection | read/write | Returns the current target projection. If target projection is set, all geometry coordinates will be converted from WGS84 to target projection coordinate system. |
GeoJSONGeometryWriter
| Property | Type | Access | Description |
|---|
sourceProjection | object projections.Projection | read/write | Returns the current source projection. If source projection is set, all geometry coordinates will be converted from given coordinate system to WGS84. |
z | boolean | read/write | Returns the state of Z coordinate serialization. |
GeocodingResult
| Property | Type | Access | Description |
|---|
address | struct massif::GeocodingAddress | read-only | Returns the address of the result. |
featureCollection | object std::shared_ptr<massif::FeatureCollection> | read-only | Returns the feature collection of the result. |
projection | object std::shared_ptr<massif::Projection> | read-only | Returns the projection of the geometry in the result. |
rank | number | read-only | Returns the rank of the result. The rank is a normalized number between 0 and 1, 1 meaning a perfect match. |
GeometryCollection
| Property | Type | Access | Description |
|---|
geometry | object geometry.MultiGeometry | read/write | |
style | object std::shared_ptr<massif::GeometryCollectionStyle> | read/write | Returns the style of this geometry collection. |
Inherited from VectorElement:
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the bounds of this vector element. |
geometry | object geometry.Geometry | read-only | Returns the geometry object that defines the location of this vector element. |
id | integer | read/write | Returns the internal id of this vector element. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the vector element meta data map. The changes you make to this map are NOT reflected in the actual meta data of the element. |
visible | boolean | read/write | Returns the state of the visibility flag of this vector element. |
GeometryCollectionStyle
| Property | Type | Access | Description |
|---|
lineStyle | object std::shared_ptr<massif::LineStyle> | read-only | Returns the line style. |
pointStyle | object std::shared_ptr<massif::PointStyle> | read-only | Returns the point style. |
polygonStyle | object std::shared_ptr<massif::PolygonStyle> | read-only | Returns the polygon style. |
Inherited from Style:
| Property | Type | Access | Description |
|---|
color | color | read-only | Returns the color of the vector element. |
GeometryCollectionStyleBuilder
| Property | Type | Access | Description |
|---|
lineStyle | object std::shared_ptr<massif::LineStyle> | read/write | Returns the line style. |
pointStyle | object std::shared_ptr<massif::PointStyle> | read/write | Returns the point style. |
polygonStyle | object std::shared_ptr<massif::PolygonStyle> | read/write | Returns the polygon style. |
Inherited from StyleBuilder:
| Property | Type | Access | Description |
|---|
color | color | read/write | Returns the color of the vector element. |
Layers
| Property | Type | Access | Description |
|---|
count | integer | read-only | Returns the current layer count. |
| Method | Arguments | Returns |
|---|
add | layer: handle | void |
clear | — | void |
get | index: int | object |
insert | index: int, layer: handle | void |
remove | layer: handle | bool |
set | index: int, layer: handle | void |
LightStop
| Property | Type | Access | Description |
|---|
ambientColor | color | read-only | Returns the ambient colour. |
ambientIntensity | number | read-only | Returns the ambient intensity. |
sunAltitude | number | read-only | Returns the sun height this light belongs to. |
sunColor | color | read-only | Returns the directional colour. |
sunIntensity | number | read-only | Returns the directional intensity. |
Log
| Property | Type | Access | Description |
|---|
logEventListener | object utils.LogEventListener | static | Returns the current log listener. |
showDebug | boolean | static | Returns the state of internal debug message logging. |
showError | boolean | static | Returns the state of error logging. |
showInfo | boolean | static | Returns the state of general info logging. |
showWarn | boolean | static | Returns the state of warning logging. |
tag | string | static | Returns the tag for the log events. |
ManeuverArrowBuilder
| Property | Type | Access | Description |
|---|
lengthAfter | number | read/write | Returns the length of the arrow after the maneuver point. |
lengthBefore | number | read/write | Returns the length of the arrow before the maneuver point. |
MapBounds
| Property | Type | Access | Description |
|---|
center | struct massif::MapPos | read-only | Calculates the center map position of this map envelope object. |
delta | struct massif::MapVec | read-only | Calculates the difference vector between the maximum and minimum map positions of this map bounds object. |
max | struct massif::MapPos | read-only | Returns the maximum (north east) map position of this map envelope object. |
min | struct massif::MapPos | read-only | Returns the minimum (south west) map position of this map envelope object. |
MapBoxOnlineGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from GeocodingService:
| Property | Type | Access | Description |
|---|
autocomplete | boolean | read/write | |
language | string | read/write | |
maxResults | integer | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
MapBoxOnlineReverseGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from ReverseGeocodingService:
| Property | Type | Access | Description |
|---|
language | string | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
MapClickInfo
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
MapEnvelope
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the map bounds of this map envelope. |
convexHull | struct std::vector<massif::MapPos> | read-only | Returns the convex hull of this map envelope. |
MapInteractionInfo
| Property | Type | Access | Description |
|---|
animationStarted | boolean | read-only | Returns true if the interaction has started an animation. |
panAction | boolean | read-only | Returns true if the interaction included a map pan action. |
rotateAction | boolean | read-only | Returns true if the interaction included a rotate action. |
tiltAction | boolean | read-only | Returns true if the interaction included a tilt action. |
zoomAction | boolean | read-only | Returns true if the interaction included a zoom action. |
MapMoveInfo
| Property | Type | Access | Description |
|---|
reason | enum | read-only | Returns what caused the movement. |
MapPos
| Property | Type | Access | Description |
|---|
x | number | read-only | Returns the x coordinate of this map position. |
y | number | read-only | Returns the y coordinate of this map position. |
z | number | read-only | Returns the z coordinate of this map position. |
MapRange
| Property | Type | Access | Description |
|---|
length | number | read-only | Calculates the length of this map range. Defined as max - min. |
max | number | read-only | Returns the max value of this map range. |
midrange | number | read-only | Calculate the midrange value. |
min | number | read-only | Returns the min value of this map range. |
MapRenderer
| Property | Type | Access | Description |
|---|
mapRendererListener | object std::shared_ptr<massif::MapRendererListener> | read/write | Returns the map renderer listener. Can be null. |
MapTile
| Property | Type | Access | Description |
|---|
frameNr | integer | read-only | Returns the time of this map tile. |
tileId | integer | read-only | Returns the internal tile id of this map tile. |
x | integer | read-only | Returns the x coordinate of this map tile. |
y | integer | read-only | Returns the y coordinate of this map tile. |
zoom | integer | read-only | Returns the zoom level of this map tile. |
MapVec
| Property | Type | Access | Description |
|---|
length | number | read-only | Calculates the length of this map vector. |
normalized | struct massif::MapVec | read-only | Creates a new map vector by normalizing this map vector. |
x | number | read-only | Returns the x coordinate of this map vector. |
y | number | read-only | Returns the y coordinate of this map vector. |
z | number | read-only | Returns the z coordinate of this map vector. |
MultiGeometry
| Property | Type | Access | Description |
|---|
geometryCount | integer | read-only | Returns the number of geometry objects in this multi geometry container. |
Inherited from Geometry:
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the minimal bounds for the geometry. |
centerPos | struct massif::MapPos | read-only | |
geoJSON | string | read-only | Returns the geometry as a GeoJSON string, in its own coordinates. Here rather than only on Feature because serialising a shape otherwise means constructing a GeoJSONGeometryWriter, which no string-based binding can do. |
type | enum | read-only | |
NMLModel
| Property | Type | Access | Description |
|---|
rotationAngle | number | read/write | Returns the rotation angle of this model. This is deprecated. Use getRotation instead. |
rotationAxis | struct massif::MapVec | read/write | Returns the rotation axis of this model. If rotation angle is 0, then the axis is irrelevant. |
scale | number | read/write | Returns the scale of this model. |
style | object std::shared_ptr<massif::NMLModelStyle> | read/write | Returns the style of this object. |
Inherited from Billboard:
| Property | Type | Access | Description |
|---|
baseBillboard | object std::shared_ptr<massif::Billboard> | read/write | Returns the base billboard this billboard is attached to. |
bounds | struct massif::MapBounds | read-only | Returns the bounds of this billboard or the base billboard, if there is one. |
geometry | object geometry.Geometry | read/write | Returns the geometry object that defines the location of this billboard. |
rootGeometry | object geometry.Geometry | read-only | Returns the location of the root billboard. If this billboard has a location, this method is equavalent to the Billboard::getGeometry method. If this billboard is attached to another billboard, the hierarchy is traveled recursively and the location of the root billboard is returned. |
rotation | number | read/write | Returns the rotation angle of this billboard. |
Inherited from VectorElement:
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the bounds of this vector element. |
geometry | object geometry.Geometry | read-only | Returns the geometry object that defines the location of this vector element. |
id | integer | read/write | Returns the internal id of this vector element. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the vector element meta data map. The changes you make to this map are NOT reflected in the actual meta data of the element. |
visible | boolean | read/write | Returns the state of the visibility flag of this vector element. |
NMLModelStyle
| Property | Type | Access | Description |
|---|
modelAsset | object std::shared_ptr<massif::BinaryData> | read-only | Returns the model asset of the object. |
orientationMode | enum | read-only | Returns the orientation mode of the model. |
scalingMode | enum | read-only | Returns the scaling mode of the model. |
Inherited from BillboardStyle:
| Property | Type | Access | Description |
|---|
animationStyle | object std::shared_ptr<massif::AnimationStyle> | read-only | Returns the animation style of the billboard. |
attachAnchorPointX | number | read-only | Returns the horizontal attaching anchor point of the billoard. |
attachAnchorPointY | number | read-only | Returns the vertical attaching anchor point of the billoard. |
causesOverlap | boolean | read-only | Returns the state of the causes overlap flag. |
hideIfOverlapped | boolean | read-only | Returns the state of the allow overlap flag. |
horizontalOffset | number | read-only | Returns the horizontal offset of the billboard. |
placementPriority | integer | read-only | Returns the placement priority of the billboard. |
scaleWithDPI | boolean | read-only | Returns the state of the scale with DPI flag. |
verticalOffset | number | read-only | Returns the vertical offset of the billboard. |
Inherited from Style:
| Property | Type | Access | Description |
|---|
color | color | read-only | Returns the color of the vector element. |
NMLModelStyleBuilder
| Property | Type | Access | Description |
|---|
modelAsset | object std::shared_ptr<massif::BinaryData> | read/write | Returns the model asset of the object. |
orientationMode | enum | read/write | Returns the orientation mode of the model. |
scalingMode | enum | read/write | Returns the scaling mode of the model. |
Inherited from BillboardStyleBuilder:
| Property | Type | Access | Description |
|---|
animationStyle | object std::shared_ptr<massif::AnimationStyle> | read/write | Returns the animation style of the billboard. |
attachAnchorPointX | number | read/write | Returns the horizontal attaching anchor point of the billboard. |
attachAnchorPointY | number | read/write | Returns the vertical attaching anchor point of the billboard. |
causesOverlap | boolean | read/write | Returns the state of the causes overlap flag. |
hideIfOverlapped | boolean | read/write | Returns the state of the allow overlap flag. |
horizontalOffset | number | read/write | Returns the horizontal offset of the billboard. |
placementPriority | integer | read/write | Returns the placement priority of the billboard. |
scaleWithDPI | boolean | read/write | Returns the state of the scale with DPI flag. |
verticalOffset | number | read/write | Returns the vertical offset of the billboard. |
Inherited from StyleBuilder:
| Property | Type | Access | Description |
|---|
color | color | read/write | Returns the color of the vector element. |
Options
| Property | Type | Access | Description |
|---|
DPI | number | read/write | Returns the dots per inch value. |
ambientLightColor | color | read/write | Returns the color of the ambient light. |
backgroundBitmap or background | object std::shared_ptr<massif::Bitmap> | read/write | Returns the background bitmap. May be null. |
baseProjection or projection | object projections.Projection | read/write | Returns the base projection. |
clearColor | color | read/write | Returns the clear color used by the renderer before drawing anything else. By default, this is white. It should be set to (0, 0, 0, 0) if transparent MapView is needed. |
clickTypeDetection | boolean | read/write | Returns the click type detection state. |
debugTileBorders | boolean | read/write | Returns the state of the tile border debug overlay. |
doubleClickDetection | boolean | read/write | Returns the double click detection state. |
doubleClickMaxDuration | number | read/write | Returns the double click max duration in seconds. |
drawDistance | number | read/write | Returns the draw distance value. |
envelopeThreadPoolSize | integer | read/write | Returns the number of threads used by the envelope task pool. |
fieldOfViewY | integer | read/write | Returns the vertial field of view angle. |
focusPointOffset | struct massif::ScreenPos | read/write | Returns the focus point offset (from screen center) in pixels. |
fogOptions or fog | object std::shared_ptr<massif::FogOptions> | read/write | Returns the fog (atmosphere) options. May be null. |
freeRoamLookSensitivity | number | read/write | Returns how fast a free roam drag turns the view. |
freeRoamMode | enum | read/write | Returns the free roam mode. |
freeRoamMoveSpeed | number | read/write | Returns how far a first person move drag travels. |
kineticPan | boolean | read/write | Returns the state of the kinetic panning flag. |
kineticRotation | boolean | read/write | Returns the state of the kinetic rotation flag. |
kineticZoom | boolean | read/write | Returns the state of kinetic zoom flag. |
layersLabelsProcessedInReverseOrder | boolean | read/write | Returns wether layers are processed in reversed order to process labels. |
lightOptions or light | object std::shared_ptr<massif::LightOptions> | read/write | Returns the light (sun) options. May be null. |
longClickDuration | number | read/write | Returns the long click duration in seconds. |
mainLightColor | color | read/write | Returns the color of the main light. |
mainLightDirection | struct massif::MapVec | read/write | Returns the direction of the main light. |
panBounds | struct massif::MapBounds | read/write | Returns the map panning bounds constraints. Map bounds minimum and maximum points are in the base projection's coordinate system. |
panningMode | enum | read/write | Returns the panning mode. |
panningSpeedMode | enum | read/write | Returns the panning speed mode. |
pivotMode | enum | read/write | Returns the pivot mode. |
renderProjectionMode | enum | read/write | Returns the render projection mode. |
restrictedPanning | boolean | read/write | Returns the state of the restricted panning flag. |
rotatable | boolean | read/write | Returns the state of the map rotatability flag. |
rotationGestures | boolean | read/write | Returns the state of rotation gestures. |
seamlessPanning | boolean | read/write | Returns the state of seamless horizontal panning flag. |
skyColor | color | read/write | Returns the sky color. |
skyOptions or sky | object std::shared_ptr<massif::SkyOptions> | read/write | Returns the sky options. May be null. |
terrainOptions or terrain | object std::shared_ptr<massif::TerrainOptions> | read/write | Returns the terrain options. May be null if no terrain is configured. |
tileDrawSize | integer | read/write | Returns the tile size used for drawing map tiles. |
tileLODFactor | number | read/write | Returns the factor on the screen size a tile may cover before it is refined. |
tileLODMaxZoomLevelsOnScreen | number | read/write | Returns how many distinct zoom levels a tilted view may spread over. |
tileLODTileCountRatio | number | read/write | Returns how many times more tiles a tilted view may load than a top-down one. |
tileStyleZoomLift | integer | read/write | Returns how many zoom levels above its own a coarsened tile may be styled at. |
tileThreadPoolSize | integer | read/write | Returns the number of threads used by the tile task pool. |
tiltGestureReversed | boolean | read/write | Returns true if tilting gesture direction is reversed (and same as with Google Maps). |
tiltRange | struct massif::MapRange | read/write | Returns the tilt range constraint. |
userInput | boolean | read/write | Returns the state of the user input flag. |
zoomGestures | boolean | read/write | Returns the state of zoom gestures. |
zoomRange | struct massif::MapRange | read/write | Returns the zoom range constraint. |
| Event | Payload | Consumable |
|---|
map.clicked | MapClickInfo | no |
map.idle | — | no |
map.interaction | MapInteractionInfo | no |
map.moved | MapMoveInfo | no |
map.stable | MapMoveInfo | no |
PackageInfo
| Property | Type | Access | Description |
|---|
metaInfo | object std::shared_ptr<massif::PackageMetaInfo> | read-only | Returns package meta info. If package contains no meta info, null is returned. |
name | string | read-only | Returns the default name (short description) of the package. It is better to use getNames method instead, as each package may contain multiple names. The name returned is generic name or if that is not available, then English name. |
packageId | string | read-only | Returns the internal package id. This should not be displayed to the user. |
packageType | enum | read-only | Returns the package type. |
size | integer | read-only | Returns the size of the package in bytes. This can be displayed to the user. |
tileMask | object std::shared_ptr<massif::PackageTileMask> | read-only | Returns the encoded tile mask of the package. This is available for map packages but not for routing packages. This should not be displayed to the user. |
version | integer | read-only | Returns the package version. This should not be displayed to the user. |
PackageManager
| Property | Type | Access | Description |
|---|
localPackages | struct std::vector<std::shared_ptr<massif::PackageInfo> > | read-only | |
packageManagerListener | object packagemanager.PackageManagerListener | read/write | |
serverPackageListAge | integer | read-only | |
serverPackageListMetaInfo | object std::shared_ptr<massif::PackageMetaInfo> | read-only | |
serverPackages | struct std::vector<std::shared_ptr<massif::PackageInfo> > | read-only | |
PackageManagerTileDataSource
| Property | Type | Access | Description |
|---|
packageManager | object packagemanager.PackageManager | read-only | Returns the package manager instance used by the data source. |
Inherited from TileDataSource:
| Property | Type | Access | Description |
|---|
dataExtent | struct massif::MapBounds | read-only | Returns the extent of the tiles in this data source. The bounds are in coordinate system of the projection of the data source. |
maxOverzoomLevel | integer | read/write | Gets the current maximum overzoom level for this datasource. Over it the datasource will not be "drawn" |
maxZoom | integer | read-only | Returns the maximum zoom level supported by this data source. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the data source meta data map. The changes you make to this map are NOT reflected in the actual meta data of the source. The map is attached to every tile this source loads, and consumers read their settings from it - "dem_encoding" ("mapbox" or "terrarium") selects the elevation decoder, for instance. A wrapper source with no map of its own answers with its wrapped source's. |
minZoom | integer | read-only | Returns the minimum zoom level supported by this data source. |
projection | object projections.Projection | read-only | Returns the projection of this tile source. |
| Method | Arguments | Returns |
|---|
getMetaDataElement | key: string | json |
loadTile | tile: tile | object |
setMetaDataElement | key: string, value: json | void |
| Property | Type | Access | Description |
|---|
variant | variant | read-only | Returns the underlying variant. |
PackageStatus
| Property | Type | Access | Description |
|---|
currentAction | enum | read-only | Returns the current action being performed. |
paused | boolean | read-only | Returns the paused state of the action. |
progress | number | read-only | Returns the progress of the action. |
PackageTileMask
| Property | Type | Access | Description |
|---|
maxZoomLevel | integer | read-only | Returns maximum zoom level encoded in this tilemask. |
stringValue | string | read-only | Returns the encoded tile mask value. This should not be displayed to the user. |
PeliasOnlineGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from GeocodingService:
| Property | Type | Access | Description |
|---|
autocomplete | boolean | read/write | |
language | string | read/write | |
maxResults | integer | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
PeliasOnlineReverseGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from ReverseGeocodingService:
| Property | Type | Access | Description |
|---|
language | string | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
Polygon3D
| Property | Type | Access | Description |
|---|
geometry | object geometry.PolygonGeometry | read/write | |
height | number | read/write | Returns the height of this 3d polygon. |
style | object std::shared_ptr<massif::Polygon3DStyle> | read/write | Returns the style of this 3d polygon. |
Inherited from VectorElement:
| Property | Type | Access | Description |
|---|
bounds | struct massif::MapBounds | read-only | Returns the bounds of this vector element. |
geometry | object geometry.Geometry | read-only | Returns the geometry object that defines the location of this vector element. |
id | integer | read/write | Returns the internal id of this vector element. |
metaData | struct std::map<std::string, massif::Variant> | read/write | Returns a copy of the vector element meta data map. The changes you make to this map are NOT reflected in the actual meta data of the element. |
visible | boolean | read/write | Returns the state of the visibility flag of this vector element. |
Polygon3DStyle
| Property | Type | Access | Description |
|---|
sideColor | color | read-only | Returns the color for sides of the 3d polygon. |
Inherited from Style:
| Property | Type | Access | Description |
|---|
color | color | read-only | Returns the color of the vector element. |
Polygon3DStyleBuilder
| Property | Type | Access | Description |
|---|
sideColor | color | read/write | Returns the color of the 3d polygon sides. |
Inherited from StyleBuilder:
| Property | Type | Access | Description |
|---|
color | color | read/write | Returns the color of the vector element. |
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
elementClickPos | struct massif::ScreenPos | read-only | Returns the 2D click position on the clicked popup. |
popup | object vectorelements.Popup | read-only | Returns the clicked popup. |
| Property | Type | Access | Description |
|---|
DPToPX | number | read-only | Returns the value used for converting display independent pixels (dp) to pixels (px). |
anchorScreenPos | struct massif::ScreenPos | read-only | Returns the screen position of the anchor point of this popup in pixels. |
popup | object vectorelements.Popup | read-only | Returns the popup to draw. |
screenBounds | struct massif::ScreenBounds | read-only | Returns the screen bounds, so that the popup can be clipped if neccessary. |
PostProcessEffect
| Property | Type | Access | Description |
|---|
fragmentShader | string | read-only | Returns the fragment shader source of the effect. |
name | string | read-only | Returns the name of the effect. |
terrainDepthRequired | boolean | read/write | Returns true if the effect needs the terrain depth pre-pass (uTerrainDepthTex). |
RasterTileClickInfo
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
interpolatedColor | color | read-only | Returns the interpolated color at the click position. |
layer | object layers.Layer | read-only | Returns the layer of the raster tile. |
mapTile | struct massif::MapTile | read-only | Returns the tile id of the clicked feature. |
nearestColor | color | read-only | Returns the color of the nearest pixel to the click position. |
RouteMatchingPoint
| Property | Type | Access | Description |
|---|
edgeIndex | integer | read-only | Returns the corresponding matching edge index in the matching result. |
pos | struct massif::MapPos | read-only | Returns the position of the matching point. |
type | enum | read-only | Returns the type of the matching point. |
RouteMatchingResult
| Property | Type | Access | Description |
|---|
matchingEdges | struct std::vector<massif::RouteMatchingEdge> | read-only | Returns the list with details of the matched edges. |
matchingPoints | struct std::vector<massif::RouteMatchingPoint> | read-only | Returns the list with details of the matched points. |
points | struct std::vector<massif::MapPos> | read-only | Returns the point list of the result. The list contains all the points from the request snapped to the road network. |
projection | object std::shared_ptr<massif::Projection> | read-only | Returns the projection of the points in the result. |
rawResult | string | read-only | Returns raw result |
RoutingInstruction
| Property | Type | Access | Description |
|---|
action | enum | read-only | Returns the action of the instruction. |
azimuth | number | read-only | Returns the azimuth of the initial position. |
distance | number | read-only | Returns the distance to move along the given street. |
geometryTag | variant | read-only | Returns the geometry tag associated with the instructions. |
instruction | string | read-only | Returns the optional instruction description. This info is dependent on the routing engine (can be empty) and may be localized. |
pointIndex | integer | read-only | Returns the index of the first geometry point in external point array. |
streetName | string | read-only | Returns the name of street. |
time | number | read-only | Returns the time approximate duration of the instruction. |
turnAngle | number | read-only | Returns the turn angle of the action. |
RoutingResult
| Property | Type | Access | Description |
|---|
instructionCount | integer | read-only | Returns the number of turn-by-turn instructions. |
instructions | struct std::vector<massif::RoutingInstruction> | read-only | Returns the turn-by-turn instruction list. |
instructionsJSON | string | read-only | Returns every turn-by-turn instruction as one JSON array. A maneuver is nine scalars, and reading them one instruction at a time costs a call per field: a mountain route has hundreds. The keys are the property names (action, pointIndex, streetName, instruction, turnAngle, azimuth, distance, time), and action is the enum's constant name. |
pointCount | integer | read-only | Returns the number of points in the path. |
points | struct std::vector<massif::MapPos> | read-only | Returns the point list of the result. The list contains all the points the route must pass in correct order. |
projection | object std::shared_ptr<massif::Projection> | read-only | Returns the projection of the points in the result. |
rawResult | string | read-only | Returns raw result |
totalDistance | number | read-only | Returns the total distance of the path. |
totalTime | number | read-only | Returns the approximate total duration of the path. |
| Method | Arguments | Returns |
|---|
getInstruction | index: int | object |
getPoints | — | doubles |
ScreenBounds
| Property | Type | Access | Description |
|---|
center | struct massif::ScreenPos | read-only | Calculates the center screen position of this screen envelope object. |
max | struct massif::ScreenPos | read-only | Returns the maximum screen position of this screen envelope object. |
min | struct massif::ScreenPos | read-only | Returns the minimum screen position. |
ScreenPos
| Property | Type | Access | Description |
|---|
x | number | read-only | Returns the x coordinate of this position. |
y | number | read-only | Returns the y coordinate of this position. |
TextMargins
| Property | Type | Access | Description |
|---|
bottom | integer | read-only | |
left | integer | read-only | |
right | integer | read-only | |
top | integer | read-only | |
TileData
| Property | Type | Access | Description |
|---|
data | object std::shared_ptr<massif::BinaryData> | read-only | Returns tile data as binary data. |
height | integer | read-only | The pixel height, or 0 when the data is an encoded file. |
maxAge | integer | read/write | Returns the maximum age of the tile data, tile data will expire after that point. |
rawPixels | boolean | read-only | Returns true when getData() holds raw RGBA8 pixels rather than an encoded file. A consumer that turns tiles into bitmaps has to check this before decoding. |
replaceWithParent | boolean | read/write | Returns true if the tile should be replaced with parent tile. |
width | integer | read-only | The pixel width, or 0 when the data is an encoded file. |
| Method | Arguments | Returns |
|---|
getMetaDataElement | key: string | json |
TileDownloadInfo
| Property | Type | Access | Description |
|---|
progress | number | read-only | Returns the progress of the download. |
tile | struct massif::MapTile | read-only | Returns the tile the event concerns, which is only meaningful for a failure. |
tileCount | integer | read-only | Returns the number of tiles the download will fetch. |
TomTomOnlineGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from GeocodingService:
| Property | Type | Access | Description |
|---|
autocomplete | boolean | read/write | |
language | string | read/write | |
maxResults | integer | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
TomTomOnlineReverseGeocodingService
| Property | Type | Access | Description |
|---|
customServiceURL | string | read/write | Returns the custom backend service URL. |
Inherited from ReverseGeocodingService:
| Property | Type | Access | Description |
|---|
language | string | read/write | |
| Method | Arguments | Returns |
|---|
calculateAddresses | request: handle | json |
TorqueTileDecoder
| Property | Type | Access | Description |
|---|
animationDuration | number | read-only | Returns the animation duration, in seconds. |
frameCount | integer | read-only | Returns the frame count defined in the Torque style. |
resolution | integer | read-only | Returns the tile resolution, in pixels. |
styleSet | object std::shared_ptr<massif::CartoCSSStyleSet> | read/write | Returns the current style set used by the decoder. |
Inherited from VectorTileDecoder:
| Property | Type | Access | Description |
|---|
maxZoom | integer | read-only | |
minZoom | integer | read-only | |
UTFGridClickInfo
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
elementInfo | variant | read-only | Returns the info tag of the clicked element. |
layer | object layers.Layer | read-only | Returns the clicked layer. |
Variant
| Property | Type | Access | Description |
|---|
arraySize | integer | read-only | Returns the number of elements in the array. |
bool | boolean | read-only | Returns the boolean value of this variant. |
double | number | read-only | Returns the floating point value of this variant. |
long | integer | read-only | Returns the integer value of this variant. |
objectKeys | struct std::vector<std::string> | read-only | Returns all the keys in the object. |
string | string | read-only | Returns the string value of this variant. |
type | enum | read-only | Returns the type of this variant. |
VectorData
| Property | Type | Access | Description |
|---|
elements | struct std::vector<std::shared_ptr<massif::VectorElement> > | read-only | Returns the list of vector elements. |
VectorElementClickInfo
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
elementClickPos | struct massif::MapPos | read-only | Returns the position on the clicked element, that is close to the click position. For points it will always be the center position, for lines it will be the closest point on the line, for billboards it will be the anchor point and for polygons it's equal to getClickPos(). |
layer | object layers.Layer | read-only | Returns the layer of the clicked vector element. |
vectorElement | object vectorelements.VectorElement | read-only | Returns the clicked vector element. |
VectorElementDragInfo
| Property | Type | Access | Description |
|---|
mapPos | struct massif::MapPos | read-only | Returns the drag position in projection coordinate system of the layer. |
screenPos | struct massif::ScreenPos | read-only | Returns the drag position in screen coordinates. |
vectorElement | object vectorelements.VectorElement | read-only | Returns the vector element being dragged. |
vectorElementDragMode | enum | read-only | Returns the drag mode. |
VectorElementSearchService
| Property | Type | Access | Description |
|---|
dataSource | object std::shared_ptr<massif::VectorDataSource> | read-only | Returns the vector data source of the search service. |
maxResults | integer | read/write | Returns the maximum number of results the search service returns. |
VectorTileClickInfo
| Property | Type | Access | Description |
|---|
clickInfo | struct massif::ClickInfo | read-only | Returns the click info. |
clickPos | struct massif::MapPos | read-only | Returns the click position. |
clickType | enum | read-only | Returns the click type. |
feature | object std::shared_ptr<massif::VectorTileFeature> | read-only | Returns the clicked feature. |
featureClickPos | struct massif::MapPos | read-only | Returns the position on the clicked feature, that is close to the click position. For points it will always be the center position, for lines it will be the closest point on the line, for billboards it will be the anchor point and for polygons it's equal to getClickPos(). |
featureId | integer | read-only | Returns the id of the clicked feature. |
featureLayerName | string | read-only | Returns the name of the layer of the clicked feature. Note that this is the layer name in the tile, not the name of style layer. |
featurePos | struct massif::MapPos | read-only | Returns the position of the clicked feature. For a MultiPoint this is the point that was clicked, not the centre of the whole set - which getFeatureClickPos deliberately does not cover, and which a caller otherwise has to reconstruct from getFeaturePosIndex plus a downcast. |
featurePosIndex | integer | read-only | In case of MultiPoint PointGeometry this will return the index of the clicked position |
layer | object layers.Layer | read-only | Returns the layer of the vector tile. |
mapTile | struct massif::MapTile | read-only | Returns the tile id of the clicked feature. |
VectorTileFeature
| Property | Type | Access | Description |
|---|
distance | number | read-only | |
id | integer | read-only | Returns the id of the feature. |
layerName | string | read-only | Returns the layer name of the feature. |
mapTile | struct massif::MapTile | read-only | Returns the map tile of the feature. |
Inherited from Feature:
| Property | Type | Access | Description |
|---|
geometry | object geometry.Geometry | read-only | Returns the geometry of the feature. |
geometryGeoJSON | string | read-only | Returns the feature's geometry as a GeoJSON string, in its own coordinates. Serialising a geometry otherwise means constructing a GeoJSONGeometryWriter in the binding, which every binding then does differently and, in a scripting one, slowly. |
properties | variant | read-only | Returns the properties of the feature. |
VectorTileFeatureBuilder
| Property | Type | Access | Description |
|---|
id | integer | read/write | Returns the id of the builder. |
layerName | string | read/write | Returns the layer name of the builder. |
mapTile | struct massif::MapTile | read/write | Returns the map tile of the builder. |
Inherited from FeatureBuilder:
| Property | Type | Access | Description |
|---|
geometry | object geometry.Geometry | read/write | Returns the geometry of the builder. |
VectorTileFeatureCollection
Inherited from FeatureCollection:
| Property | Type | Access | Description |
|---|
featureCount | integer | read-only | Returns the number of features in this container. |
| Method | Arguments | Returns |
|---|
getFeature | index: int | object |
getFeature | index: int | object |
ViewState
| Property | Type | Access | Description |
|---|
DPI | number | read-only | Returns the dots per inch parameter of the screen. |
DPToPX | number | read-only | Returns a value that is used for converting display independent pixels (dp) to pixels (px). This values depends on the screen density. |
FOVY | integer | read-only | Returns the vertical field of view angle. |
aspectRatio | number | read-only | Returns the aspect ratio of the map screen. Equal to width / height. |
cameraChanged | boolean | read-only | Returns the state of the camera changed flag. |
far | number | read-only | Returns the far plane distance. |
height | integer | read-only | Returns the height of the map screen. |
near | number | read-only | Returns the near plane distance. |
rotation | number | read-only | Returns the camera rotation angle. |
screenHeight | integer | read-only | Returns the screen height. |
screenWidth | integer | read-only | Returns the screen width. |
tilt | number | read-only | Returns the camera tilt angle. A NEGATIVE tilt means the view looks above the horizon. |
unitToDPCoef | number | read-only | Returns the conversion ratio between internal map units and screen density independent pixels (DP or DIP). This parameter is dependent on the zoom level, DPI and other screen parameters. |
unitToPXCoef | number | read-only | Returns the conversion ratio between internal map units and screen pixels. This parameter is dependent on the zoom level and other screen parameters. |
width | integer | read-only | Returns the width of the map screen. |
zoom | number | read-only | Returns the camera zoom level. |
zoom0Distance | number | read-only | Returns the distance between the focus and the camera position, when the zoom level is set to 0. This parameter depends on the screen size, DPI, tile draw size and field of view settings. |