ReadonlyclassReadonlyhandleOptional ReadonlyidThe registry id, when the object has one. A call result does not.
ReadonlyviewFalse after destroy, and after the id was dropped.
OptionalbaseBillboard?: string | Handle<any> | ElementSpecReturns the base billboard this billboard is attached to.
Optionalgeometry?: string | Handle<any> | GeometrySpecReturns the geometry object that defines the location of this billboard.
Optionalid?: numberReturns the internal id of this vector element.
OptionalmetaData?: Record<string, Json>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.
Optionalposition?: PositionOptionalrotation?: numberReturns the rotation angle of this billboard.
Returns the style of this marker.
Optionalvisible?: booleanReturns the state of the visibility flag of this vector element.
OptionalanchorPointX?: numberReturns the horizontal anchor point of this popup.
OptionalanchorPointY?: numberReturns the vertical anchor point of this popup.
OptionalballoonPopupEventListener?: HandleReturns the balloon popup event listener.
OptionalbaseBillboard?: string | Handle<any> | ElementSpecReturns the base billboard this billboard is attached to.
Returns the description of this balloon popup.
Optionalgeometry?: string | Handle<any> | GeometrySpecReturns the geometry object that defines the location of this billboard.
Optionalid?: numberReturns the internal id of this vector element.
OptionalmetaData?: Record<string, Json>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.
Optionalposition?: PositionOptionalrotation?: numberReturns the rotation angle of this billboard.
Returns the style of this balloon popup.
Returns the title of this balloon popup.
Optionalvisible?: booleanReturns the state of the visibility flag of this vector element.
OptionalclassName: ClassNameSeveral properties in ONE JNI/JSI crossing via setAll. Object values (handles, inline specs) cannot
be JSON and go one by one, as does everything on an SDK without setAll.
ProtectedbeforeHook for a subclass that has to install a native listener before the first subscription.
Owned by the map but not placed: for add(layer, index) or layers().insert(...).
The path may traverse object properties (layer.call('tileDecoder.setStyleParameter', ...)).
An object result is a MassifObject the CALLER OWNS - destroy() it, or it stays registered.
call on a worker. extract runs INSIDE the delivery, the only time an object result is alive,
e.g. (tile) => tile.getData('data'). Scalars and flat arrays need no extract.
Optionalextract: (result: MassifObject<ResultClass<"massif::Options", M>>) => Rwait holds the capture until the tiles have settled.
Optionalwait: booleanThe object behind an object property, OWNED by the caller (destroy() it); null when empty.
Unlike group it hands the object over, e.g. to share a source between layers.
Defaults cover a search result; a route's instructions are
collect(fn, { countPath: 'instructionCount', method: 'getInstruction' }).
Defaults cover a search result; a route's instructions are
collect(fn, { countPath: 'instructionCount', method: 'getInstruction' }).
Releases every id the map built, not the view: the object API's map keeps working.
sourceSpec is for a map not in lon/lat; only the first call uses it.
Defaults for every later subscription on this object.
Optionalspec: {Optionalcolor?: numberReturns the fog color.
Optionalenabled?: booleanReturns whether the fog is drawn at all.
OptionalhighColor?: numberReturns the color of the upper atmosphere.
OptionalhorizonBlend?: numberReturns how far up the sky the fog is blended in.
OptionalrangeEnd?: numberReturns where the fog reaches full strength.
OptionalrangeStart?: numberReturns where the fog starts.
OptionalshaderSource?: stringReturns the custom fog fragment shader source, or an empty string if the built-in blend is used.
OptionalspaceColor?: numberReturns the color of the sky at the zenith, beyond the atmosphere.
OptionalstarIntensity?: numberReturns how brightly stars are drawn beyond the atmosphere.
OptionalverticalRangeEnd?: numberReturns the altitude the fog has fully faded out at.
OptionalverticalRangeStart?: numberReturns the altitude the fog starts fading out at.
The path may walk objects (fogOptions.rangeStart), structs (clickInfo.clickType) and free-form
data (properties.name). Enums come back as names, positions as [lon, lat], structs as JSON.
An empty path means the handle IS the blob.
Optionalpath: stringWGS84 [lng, lat] unless a projection is named here or on the subscription. An object whose source
projection is unknown is left unconverted: a wrong guess is worse than an unconverted number.
Optionalprojection: ProjectionNameA path the tables do not carry - the concrete class is more derived than the declared one.
Optionalprojection: ProjectionNameProtectedinvokeUntyped call for the named wrappers: they know the declaring class, call's C does not.
instanceof by class name, e.g. layer.is('massif::RasterTileLayer').
Escape hatch for paths the tables cannot type: free-form feature properties, a more derived class.
Optionalpath: stringA layer this map added or adopted, by the id it was given.
Includes layers the object API put there.
Optionalspec: {OptionalambientColor?: numberReturns the ambient light color.
OptionalambientIntensity?: numberReturns the ambient light intensity.
OptionaldayCycleLightsEnabled?: booleanReturns whether the sun's COLOURS follow its position.
OptionaldayCycleLightStops?: JsonReturns the day-cycle light curve.
OptionaldayCycleRisingLightStops?: JsonReturns the curve used while the sun is RISING, if the app set one.
OptionalshadowBias?: numberReturns the shadow depth bias scale.
OptionalshadowCascades?: numberReturns the number of shadow cascades.
OptionalshadowCasterMargin?: numberReturns the shadow caster margin in tiles.
OptionalshadowDistance?: numberReturns the shadow distance.
OptionalshadowMapSize?: numberReturns the shadow map resolution.
OptionalshadowNormalOffset?: numberReturns the shadow normal offset.
OptionalshadowSoftness?: numberReturns the shadow softness.
OptionalshadowStrength?: numberReturns the shadow strength.
OptionalsunAltitude?: numberReturns the sun altitude in degrees above the horizon.
OptionalsunAzimuth?: numberReturns the sun azimuth in degrees.
OptionalsunColor?: numberReturns the sun (directional light) color.
OptionalsunIntensity?: numberReturns the sun light intensity.
OptionalsunOverridingStyle?: booleanReturns whether this sun overrides the one a style states.
OptionalterrainLightingEnabled?: booleanReturns whether the sun lights the 3D terrain surface.
OptionalterrainShadowCastingEnabled?: booleanReturns whether the terrain itself casts shadows.
OWNED by this map and released with it; module-level create is for something shared.
Removes the listener(s) for the specified event name.
Optionalcallback: anyAn optional specific event listener to remove (if omitted, all event listeners by this name will be removed).
OptionalthisArg: anyAn optional parameter which, when set, will be used to refine search of the correct event listener to be removed.
Deliberately NOT widened to string so event-name typos fail; addEventListener takes any name.
OptionalthisArg: anyAdds a listener for the specified event name, which, once fired, will remove itself.
The event listener to add. Will be called when an event of the given name is raised.
OptionalthisArg: anyAn optional parameter which, when set, will be bound as the
this context when the callback is called. Falsy values will be not be
bound.
Optionaloptions: SubscribeOptionsOptionaloptions: SubscribeOptionsOptionaloptions: SubscribeOptionsOptionaloptions: SubscribeOptionsOptionaloptions: SubscribeOptionsRemoves listener(s) for the specified event name.
Optionalcallback: anyAn optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.
OptionalthisArg: anyAn optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.
The layer stays registered until it is destroyed.
Rarely needed: the SDK redraws on picture-changing writes. For off-UI-thread changes or a view hidden while moving.
An enum takes its constant name, a position an array.
Optionalspec: {OptionalatmosphereColor?: numberReturns the tint applied to Rayleigh scattering.
OptionalatmosphereLuminance?: numberReturns the exposure applied to the scattered light.
OptionalatmosphereSunIntensity?: numberReturns the brightness of the sun driving the atmosphere.
Optionalenabled?: booleanReturns whether the shader sky is enabled.
OptionalgroundColor?: numberReturns the ground color.
OptionalhaloColor?: numberReturns the tint applied to Mie scattering.
OptionalhorizonBlend?: numberReturns the angular blend width between the horizon color and the sky color.
OptionalhorizonColor?: numberReturns the horizon color.
Optionalquality?: number | "SKY_QUALITY_LOW" | "SKY_QUALITY_MEDIUM" | "SKY_QUALITY_HIGH"Returns how finely the atmosphere is integrated.
OptionalshaderSource?: stringReturns the custom sky fragment shader source, or an empty string if the built-in shader is used.
OptionalskyColor?: numberReturns the zenith sky color.
OptionalsunDiscEnabled?: booleanReturns whether the built-in shader draws a sun disc.
Returns what the sky pass draws.
Worth an id when the app talks to it later: a layer's style property cannot be read back as a handle.
For a handler needing its own projection or delivery; on covers most cases.
Optionaloptions: SubscribeOptionsThe elevation decoder comes from the source's own encoding.
Optionalspec: {OptionalautoFlattenDuration?: numberReturns how long the terrain takes to sink flat.
OptionalautoFlattenParallax?: numberReturns the screen parallax below which the terrain renders flat.
OptionalautoFlattenRiseDuration?: numberReturns how long the terrain takes to rise back into 3D.
OptionalautoFlattenTilt?: numberReturns the tilt at or above which the terrain renders flat.
OptionalbackgroundColor?: numberReturns the terrain background color.
OptionalbillboardOcclusionEnabled?: booleanReturns the billboard/label terrain occlusion state.
OptionalbillboardOcclusionTolerance?: numberReturns the billboard/label terrain occlusion tolerance.
Optionalbridges3DEnabled?: booleanReturns whether bridges and tunnels stand on their own chord (3D bridges).
OptionalcameraClampDuration?: numberReturns the duration of the camera terrain-following correction animation.
OptionalcameraClearance?: numberReturns the camera terrain clearance floor: an explicit minimum height the camera is kept above the terrain surface, in meters.
OptionalcameraClearanceFraction?: numberReturns the share of the camera's altitude that the terrain clearance takes.
OptionaldepthBias?: numberReturns the clip-space depth bias used when depth-testing draped 2D geometry against the terrain.
OptionaldrapeCacheSize?: numberReturns the drape cache budget in megabytes.
OptionaldrapeFillsEnabled?: booleanReturns whether polygon fills are draped as a render-to-texture surface.
OptionaldrapeLinesEnabled?: booleanReturns whether vt tile lines are also draped (in addition to fills).
OptionaldrapeResolution?: numberReturns the per-tile drape texture resolution, 0 when it follows the screen.
OptionaldrapeWorkingSet?: numberReturns how many drape tiles the automatic resolution assumes are cached at once.
OptionalelevationCacheSize?: numberReturns the elevation grid cache budget in megabytes, 0 for the SDK's own rule.
OptionalelevationPrefetchEnabled?: booleanReturns whether elevation tile prefetching is enabled.
Optionalenabled?: booleanReturns the enabled state of the terrain.
Optionalexaggeration?: numberReturns the terrain height exaggeration factor.
Optionalflattened?: booleanReturns whether the map is asked to render flat. This is the 2D/3D state, whether it was set by the app or by auto-flattening; the switch itself is animated, so for a moment after a change the map is still on its way there.
OptionalflattenMode?: number | "TERRAIN_FLATTEN_MODE_RENDER" | "TERRAIN_FLATTEN_MODE_FULL"Returns how far a flattened terrain goes back towards a plain 2D map.
OptionalflattenRatio?: numberReturns how far the terrain is flattened right now, 0 (full 3D) to 1 (flat).
OptionalfocusLift?: numberReturns the height the viewpoint is lifted above the ground-following focus, in meters.
OptionalmaxTileZoomCoarsening?: numberReturns how many zoom levels below the camera a tile may coarsen to.
OptionalmaxTileZoomOffset?: numberReturns the maximum visible tile zoom offset, relative to the camera zoom level.
OptionalmaxZoom?: numberReturns the maximum tile zoom level the terrain mesh is cut at.
OptionalmeshCacheSize?: numberReturns how many terrain surface meshes may be cached.
OptionalmeshResolution?: numberReturns the terrain mesh resolution.
OptionalminZoom?: numberReturns the minimum tile zoom level with 3D terrain.
OptionalnoDrapeLayerFilter?: stringReturns the style layers that are kept out of the terrain drape bake.
OptionalnormalSampleDistance?: numberReturns the ground distance the surface normals are measured over, in meters.
OptionalpostProcessDownscale?: numberReturns the downscale factor of the packed depth/normal texture post-process effects read.
OptionalseamlessTileEdgesEnabled?: booleanReturns whether seamless tile edge handling is enabled.
OptionalsharedGroundEnabled?: booleanReturns whether the shared ground pass draws the terrain a second time.
OptionalsubdivideDistance?: numberReturns the distance geo-three's terrain LOD subdivides at.
OptionalsurfaceNodeResolution?: numberReturns the resolution the elevation node field is built at.
OptionalsurfaceShaderSource?: stringReturns the custom terrain surface fragment shader source, or an empty string if no shaded surface is drawn.
OptionaltextOcclusionOpacity?: numberReturns the opacity a label keeps while its anchor is behind 3D content.
OptionaltileEdgeStitchingEnabled?: booleanReturns whether cross-LOD tile edge stitching is enabled.
OptionalviewDistance?: numberReturns the minimum view distance, in meters.
OptionalviewDistanceFactor?: numberReturns the factor applied to the view distance.
OptionalviewDistanceMax?: numberReturns the maximum view distance, in meters.
Returns a string representation of an object.
The same without throwing, for a path that may legitimately not be there.
Addressed through its Options: fog, sky, light, terrain, camera limits... all hang off it.