{ "Atmosphere": { "description": "", "displayName": "Atmosphere", "methods": [], "props": [ { "name": "style", "required": true, "type": "AtmosphereLayerStyleProps", "default": "none", "description": "FIX ME NO DESCRIPTION" } ], "fileNameWithExt": "Atmosphere.tsx", "name": "Atmosphere", "styles": [ { "name": "range", "type": "array", "values": [], "minimum": -20, "maximum": 20, "default": [ 0.5, 10 ], "description": "The start and end distance range in which fog fades from fully transparent to fully opaque. The distance to the point at the center of the map is defined as zero, so that negative range values are closer to the camera, and positive values are farther away.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "color", "type": "color", "values": [], "default": "#ffffff", "description": "The color of the atmosphere region immediately below the horizon and within the `range` and above the horizon and within `horizonBlend`. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "highColor", "type": "color", "values": [], "default": "#245cdf", "description": "The color of the atmosphere region above the horizon, `highColor` extends further above the horizon than the `color` property and its spread can be controlled with `horizonBlend`. The opacity can be set to `0` to remove the high atmosphere color contribution.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "spaceColor", "type": "color", "values": [], "default": [ "interpolate", [ "linear" ], [ "zoom" ], 4, "#010b19", 7, "#367ab9" ], "description": "The color of the region above the horizon and after the end of the `horizonBlend` contribution. The opacity can be set to `0` to have a transparent background.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "horizonBlend", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": [ "interpolate", [ "linear" ], [ "zoom" ], 4, 0.2, 7, 0.1 ], "description": "Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "starIntensity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": [ "interpolate", [ "linear" ], [ "zoom" ], 5, 0.35, 6, 0 ], "description": "A value controlling the star intensity where `0` will show no stars and `1` will show stars at their maximum intensity.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "BackgroundLayer": { "description": "", "displayName": "BackgroundLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "BackgroundLayer.js", "name": "BackgroundLayer", "styles": [ { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "backgroundColor", "type": "color", "values": [], "default": "#000000", "description": "The color with which the background will be drawn.", "requires": [], "disabledBy": [ "backgroundPattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "backgroundPattern", "type": "resolvedImage", "values": [], "description": "Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": true }, { "name": "backgroundOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity at which the background will be drawn.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "Callout": { "description": "Callout that displays information about a selected annotation near the annotation.", "displayName": "Callout", "methods": [], "props": [ { "name": "title", "required": false, "type": "string", "default": "none", "description": "String that get's displayed in the default callout." }, { "name": "style", "required": false, "type": "any", "default": "none", "description": "Style property for the Animated.View wrapper, apply animations to this" }, { "name": "containerStyle", "required": false, "type": "any", "default": "none", "description": "Style property for the native RCTMGLCallout container, set at your own risk." }, { "name": "contentStyle", "required": false, "type": "any", "default": "none", "description": "Style property for the content bubble." }, { "name": "tipStyle", "required": false, "type": "any", "default": "none", "description": "Style property for the triangle tip under the content." }, { "name": "textStyle", "required": false, "type": "any", "default": "none", "description": "Style property for the title in the content bubble." } ], "composes": [ "../utils" ], "fileNameWithExt": "Callout.js", "name": "Callout" }, "Camera": { "description": "Controls the perspective from which the user sees the map.\n\nTo use imperative methods, pass in a ref object:\n\n```\nconst camera = useRef(null);\n\nuseEffect(() => {\n camera.current?.setCamera({\n centerCoordinate: [lon, lat],\n });\n}, []);\n\nreturn (\n \n);\n```", "displayName": "Camera", "methods": [], "props": [ { "name": "type", "required": false, "type": "literal", "default": "none", "description": "Allows static check of the data type. For internal use only." }, { "name": "centerCoordinate", "required": false, "type": "Position", "default": "none", "description": "The location on which the map should center." }, { "name": "bounds", "required": false, "type": "intersection", "default": "none", "description": "The corners of a box around which the map should bound. Contains padding props for backwards\ncompatibility; the root `padding` prop should be used instead." }, { "name": "heading", "required": false, "type": "number", "default": "none", "description": "The heading (orientation) of the map." }, { "name": "pitch", "required": false, "type": "number", "default": "none", "description": "The pitch of the map." }, { "name": "zoomLevel", "required": false, "type": "number", "default": "none", "description": "The zoom level of the map." }, { "name": "padding", "required": false, "type": "{paddingLeft:number;paddingRight:number;paddingTop:number;paddingBottom:number;}", "default": "none", "description": "The viewport padding in points." }, { "name": "animationDuration", "required": false, "type": "number", "default": "none", "description": "The duration the map takes to animate to a new configuration." }, { "name": "animationMode", "required": false, "type": "\\| 'flyTo'\n\\| 'easeTo'\n\\| 'linearTo'\n\\| 'moveTo'\n\\| 'none'", "default": "none", "description": "The easing or path the camera uses to animate to a new configuration." }, { "name": "followUserMode", "required": false, "type": "UserTrackingMode", "default": "none", "description": "The mode used to track the user location on the map." }, { "name": "followUserLocation", "required": false, "type": "boolean", "default": "none", "description": "Whether the map orientation follows the user location." }, { "name": "followZoomLevel", "required": false, "type": "number", "default": "none", "description": "The zoom level used when following the user location." }, { "name": "followPitch", "required": false, "type": "number", "default": "none", "description": "The pitch used when following the user location." }, { "name": "followHeading", "required": false, "type": "number", "default": "none", "description": "The heading used when following the user location." }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The lowest allowed zoom level." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The highest allowed zoom level." }, { "name": "maxBounds", "required": false, "type": "{ne:Position;sw:Position;}", "default": "none", "description": "The corners of a box defining the limits of where the camera can pan or zoom." }, { "name": "defaultSettings", "required": false, "type": "FIX ME FORMAT BIG OBJECT", "default": "none", "description": "The configuration that the camera falls back on, if no other values are specified." }, { "name": "allowUpdates", "required": false, "type": "boolean", "default": "none", "description": "Whether the camera should send any configuration to the native module. Prevents unnecessary tile\nfetching and improves performance when the map is not visible. Defaults to `true`." }, { "name": "triggerKey", "required": false, "type": "string \\| number", "default": "none", "description": "Any arbitrary primitive value that, when changed, causes the camera to retry moving to its target\nconfiguration. (Not yet implemented.)" }, { "name": "onUserTrackingModeChange", "required": false, "type": "UserTrackingModeChangeCallback", "default": "none", "description": "Executes when user tracking mode changes." } ], "fileNameWithExt": "Camera.tsx", "name": "Camera" }, "CircleLayer": { "description": "CircleLayer is a style layer that renders one or more filled circles on the map.", "displayName": "CircleLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property\nfrom which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "CircleLayer.js", "name": "CircleLayer", "styles": [ { "name": "circleSortKey", "type": "number", "values": [], "description": "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "circleRadius", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 5, "description": "Circle radius.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleColor", "type": "color", "values": [], "default": "#000000", "description": "The fill color of the circle.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleBlur", "type": "number", "values": [], "default": 0, "description": "Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity at which the circle will be drawn.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "circleTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "The circle is translated relative to the map." }, { "value": "viewport", "doc": "The circle is translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `circleTranslate`.", "requires": [ "circleTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "circlePitchScale", "type": "enum", "values": [ { "value": "map", "doc": "Circles are scaled according to their apparent distance to the camera." }, { "value": "viewport", "doc": "Circles are not scaled." } ], "default": "map", "description": "Controls the scaling behavior of the circle when the map is pitched.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "circlePitchAlignment", "type": "enum", "values": [ { "value": "map", "doc": "The circle is aligned to the plane of the map." }, { "value": "viewport", "doc": "The circle is aligned to the plane of the viewport." } ], "default": "viewport", "description": "Orientation of circle when map is pitched.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "circleStrokeWidth", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "The width of the circle's stroke. Strokes are placed outside of the `circleRadius`.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleStrokeColor", "type": "color", "values": [], "default": "#000000", "description": "The stroke color of the circle.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "circleStrokeOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity of the circle's stroke.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true } ] }, "FillExtrusionLayer": { "description": "FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.", "displayName": "FillExtrusionLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "FillExtrusionLayer.js", "name": "FillExtrusionLayer", "styles": [ { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "fillExtrusionOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity of the entire fill extrusion layer. This is rendered on a perLayer, not perFeature, basis, and dataDriven styling is not available.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "fillExtrusionColor", "type": "color", "values": [], "default": "#000000", "description": "The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fillExtrusionOpacity` to set layer opacity.", "requires": [], "disabledBy": [ "fillExtrusionPattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillExtrusionTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "fillExtrusionTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "The fill extrusion is translated relative to the map." }, { "value": "viewport", "doc": "The fill extrusion is translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `fillExtrusionTranslate`.", "requires": [ "fillExtrusionTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "fillExtrusionPattern", "type": "resolvedImage", "values": [], "description": "Name of image in sprite to use for drawing images on extruded fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] }, "transition": true }, { "name": "fillExtrusionHeight", "type": "number", "values": [], "minimum": 0, "units": "meters", "default": 0, "description": "The height with which to extrude this layer.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillExtrusionBase", "type": "number", "values": [], "minimum": 0, "units": "meters", "default": 0, "description": "The height with which to extrude the base of this layer. Must be less than or equal to `fillExtrusionHeight`.", "requires": [ "fillExtrusionHeight" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillExtrusionVerticalGradient", "type": "boolean", "values": [], "default": true, "description": "Whether to apply a vertical gradient to the sides of a fillExtrusion layer. If true, sides will be shaded slightly darker farther down.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": false }, { "name": "fillExtrusionAmbientOcclusionIntensity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 0, "description": "Controls the intensity of ambient occlusion (AO) shading. Current AO implementation is a lowCost bestEffort approach that shades area near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "fillExtrusionAmbientOcclusionRadius", "type": "number", "values": [], "minimum": 0, "default": 3, "description": "The radius of ambient occlusion (AO) shading, in meters. Current AO implementation is a lowCost bestEffort approach that shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to hight of one floor and brings the most plausible results for buildings.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "FillLayer": { "description": "FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.", "displayName": "FillLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "FillLayer.js", "name": "FillLayer", "styles": [ { "name": "fillSortKey", "type": "number", "values": [], "description": "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "fillAntialias", "type": "boolean", "values": [], "default": true, "description": "Whether or not the fill should be antialiased.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "fillOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity of the entire fill layer. In contrast to the `fillColor`, this value will also affect the 1px stroke around the fill, if the stroke is used.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillColor", "type": "color", "values": [], "default": "#000000", "description": "The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.", "requires": [], "disabledBy": [ "fillPattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillOutlineColor", "type": "color", "values": [], "description": "The outline color of the fill. Matches the value of `fillColor` if unspecified.", "requires": [], "disabledBy": [ "fillPattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "fillTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "fillTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "The fill is translated relative to the map." }, { "value": "viewport", "doc": "The fill is translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `fillTranslate`.", "requires": [ "fillTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "fillPattern", "type": "resolvedImage", "values": [], "description": "Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] }, "transition": true } ] }, "HeadingIndicator": { "description": "", "displayName": "HeadingIndicator", "methods": [], "props": [ { "name": "heading", "required": false, "type": "number", "default": "none", "description": "FIX ME NO DESCRIPTION" } ], "fileNameWithExt": "HeadingIndicator.js", "name": "HeadingIndicator" }, "HeatmapLayer": { "description": "HeatmapLayer is a style layer that renders one or more filled circles on the map.", "displayName": "HeatmapLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property\nfrom which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "HeatmapLayer.js", "name": "HeatmapLayer", "styles": [ { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "heatmapRadius", "type": "number", "values": [], "minimum": 1, "units": "pixels", "default": 30, "description": "Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. `queryRenderedFeatures` on heatmap layers will return points within this radius.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "heatmapWeight", "type": "number", "values": [], "minimum": 0, "default": 1, "description": "A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": false }, { "name": "heatmapIntensity", "type": "number", "values": [], "minimum": 0, "default": 1, "description": "Similar to `heatmapWeight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "heatmapColor", "type": "color", "values": [], "default": [ "interpolate", [ "linear" ], [ "heatmap-density" ], 0, "rgba(0, 0, 255, 0)", 0.1, "royalblue", 0.3, "cyan", 0.5, "lime", 0.7, "yellow", 1, "red" ], "description": "Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `[\"heatmapDensity\"]` as input.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "heatmap-density" ] }, "transition": false }, { "name": "heatmapOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The global opacity at which the heatmap layer will be drawn.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "ImageSource": { "description": "ImageSource is a content source that is used for a georeferenced raster image to be shown on the map.\nThe georeferenced image scales and rotates as the user zooms and rotates the map", "displayName": "ImageSource", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source." }, { "name": "url", "required": false, "type": "union", "default": "none", "description": "An HTTP(S) URL, absolute file URL, or local file URL to the source image.\nGifs are currently not supported." }, { "name": "coordinates", "required": true, "type": { "name": "array", "value": { "type": { "name": "array", "value": { "type": "number" } } } }, "default": "none", "description": "The top left, top right, bottom right, and bottom left coordinates for the image." } ], "composes": [ "../utils" ], "fileNameWithExt": "ImageSource.js", "name": "ImageSource" }, "Images": { "description": "Images defines the images used in Symbol etc layers", "displayName": "Images", "methods": [], "props": [ { "name": "images", "required": false, "type": "object", "default": "none", "description": "Specifies the external images in key-value pairs required for the shape source.\nKeys are names - see iconImage expressions, values can be either urls-s objects\nwith format {uri: 'http://...'}` or `require('image.png')` or `import 'image.png'`" }, { "name": "nativeAssetImages", "required": false, "type": { "name": "array", "value": { "type": "string" } }, "default": "none", "description": "If you have an asset under Image.xcassets on iOS and the drawables directory on android\nyou can specify an array of string names with assets as the key `['pin']`." }, { "name": "onImageMissing", "required": false, "type": "func", "default": "none", "description": "Gets called when a Layer is trying to render an image whose key is not present in\nany of the `Images` component of the Map." } ], "composes": [ "../utils" ], "fileNameWithExt": "Images.js", "name": "Images" }, "Light": { "description": "Light represents the light source for extruded geometries", "displayName": "Light", "methods": [], "props": [ { "name": "style", "required": false, "type": "custom", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "Light.js", "name": "Light", "styles": [ { "name": "anchor", "type": "enum", "values": [ { "value": "map", "doc": "The position of the light source is aligned to the rotation of the map." }, { "value": "viewport", "doc": "The position of the light source is aligned to the rotation of the viewport." } ], "default": "viewport", "description": "Whether extruded geometries are lit relative to the map or viewport.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": false }, { "name": "position", "type": "array", "values": [], "default": [ 1.15, 210, 30 ], "description": "Position of the light source relative to lit (extruded) geometries, in [r radial coordinate, a azimuthal angle, p polar angle] where r indicates the distance from the center of the base of an object to its light, a indicates the position of the light relative to 0° (0° when `light.anchor` is set to `viewport` corresponds to the top of the viewport, or 0° when `light.anchor` is set to `map` corresponds to due north, and degrees proceed clockwise), and p indicates the height of the light (from 0°, directly above, to 180°, directly below).", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "color", "type": "color", "values": [], "default": "#ffffff", "description": "Color tint for lighting extruded geometries.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "intensity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 0.5, "description": "Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "LineLayer": { "description": "LineLayer is a style layer that renders one or more stroked polylines on the map.", "displayName": "LineLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "LineLayer.js", "name": "LineLayer", "styles": [ { "name": "lineCap", "type": "enum", "values": [ { "value": "butt", "doc": "A cap with a squared-off end which is drawn to the exact endpoint of the line." }, { "value": "round", "doc": "A cap with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line." }, { "value": "square", "doc": "A cap with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width." } ], "default": "butt", "description": "The display of line endings.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "lineJoin", "type": "enum", "values": [ { "value": "bevel", "doc": "A join with a squared-off end which is drawn beyond the endpoint of the line at a distance of one-half of the line's width." }, { "value": "round", "doc": "A join with a rounded end which is drawn beyond the endpoint of the line at a radius of one-half of the line's width and centered on the endpoint of the line." }, { "value": "miter", "doc": "A join with a sharp, angled corner which is drawn with the outer sides beyond the endpoint of the path until they meet." } ], "default": "miter", "description": "The display of lines when joining.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "lineMiterLimit", "type": "number", "values": [], "default": 2, "description": "Used to automatically convert miter joins to bevel joins for sharp angles.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "lineRoundLimit", "type": "number", "values": [], "default": 1.05, "description": "Used to automatically convert round joins to miter joins for shallow angles.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "lineSortKey", "type": "number", "values": [], "description": "Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "lineOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity at which the line will be drawn.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineColor", "type": "color", "values": [], "default": "#000000", "description": "The color with which the line will be drawn.", "requires": [], "disabledBy": [ "linePattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "lineTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "The line is translated relative to the map." }, { "value": "viewport", "doc": "The line is translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `lineTranslate`.", "requires": [ "lineTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "lineWidth", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 1, "description": "Stroke thickness.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineGapWidth", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineOffset", "type": "number", "values": [], "units": "pixels", "default": 0, "description": "The line's offset. For linear features, a positive value offsets the line to the right, relative to the direction of the line, and a negative value to the left. For polygon features, a positive value results in an inset, and a negative value results in an outset.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineBlur", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "Blur applied to the line, in pixels.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "lineDasharray", "type": "array", "values": [], "minimum": 0, "units": "line widths", "description": "Specifies the lengths of the alternating dashes and gaps that form the dash pattern. The lengths are later scaled by the line width. To convert a dash length to pixels, multiply the length by the current line width. Note that GeoJSON sources with `lineMetrics: true` specified won't render dashed lines to the expected scale. Also note that zoomDependent expressions will be evaluated only at integer zoom levels.", "requires": [], "disabledBy": [ "linePattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] }, "transition": true }, { "name": "linePattern", "type": "resolvedImage", "values": [], "description": "Name of image in sprite to use for drawing image lines. For seamless patterns, image width must be a factor of two (2, 4, 8, ..., 512). Note that zoomDependent expressions will be evaluated only at integer zoom levels.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] }, "transition": true }, { "name": "lineGradient", "type": "color", "values": [], "description": "Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.", "requires": [], "disabledBy": [ "linePattern" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "line-progress" ] }, "transition": false }, { "name": "lineTrimOffset", "type": "array", "values": [], "minimum": [ 0, 0 ], "maximum": [ 1, 1 ], "default": [ 0, 0 ], "description": "The line part between [trimStart, trimEnd] will be marked as transparent to make a route vanishing effect. The line trimOff offset is based on the whole line range [0.0, 1.0].", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "transition": false } ] }, "MapView": { "description": "MapView backed by Mapbox Native GL", "displayName": "MapView", "methods": [ { "name": "getPointInView", "docblock": "Converts a geographic coordinate to a point in the given view’s coordinate system.\n\n@example\nconst pointInView = await this._map.getPointInView([-37.817070, 144.949901]);\n\n@param {Array} coordinate - A point expressed in the map view's coordinate system.\n@return {Array}", "modifiers": [ "async" ], "params": [ { "name": "coordinate", "description": "A point expressed in the map view's coordinate system.", "type": { "name": "Array" }, "optional": false } ], "returns": { "description": null, "type": { "name": "Array" } }, "description": "Converts a geographic coordinate to a point in the given view’s coordinate system.", "examples": [ "\nconst pointInView = await this._map.getPointInView([-37.817070, 144.949901]);\n\n" ] }, { "name": "getCoordinateFromView", "docblock": "Converts a point in the given view’s coordinate system to a geographic coordinate.\n\n@example\nconst coordinate = await this._map.getCoordinateFromView([100, 100]);\n\n@param {Array} point - A point expressed in the given view’s coordinate system.\n@return {Array}", "modifiers": [ "async" ], "params": [ { "name": "point", "description": "A point expressed in the given view’s coordinate system.", "type": { "name": "Array" }, "optional": false } ], "returns": { "description": null, "type": { "name": "Array" } }, "description": "Converts a point in the given view’s coordinate system to a geographic coordinate.", "examples": [ "\nconst coordinate = await this._map.getCoordinateFromView([100, 100]);\n\n" ] }, { "name": "getVisibleBounds", "docblock": "The coordinate bounds(ne, sw) visible in the users’s viewport.\n\n@example\nconst visibleBounds = await this._map.getVisibleBounds();\n\n@return {Array}", "modifiers": [ "async" ], "params": [], "returns": { "description": null, "type": { "name": "Array" } }, "description": "The coordinate bounds(ne, sw) visible in the users’s viewport.", "examples": [ "\nconst visibleBounds = await this._map.getVisibleBounds();\n\n" ] }, { "name": "queryRenderedFeaturesAtPoint", "docblock": "Returns an array of rendered map features that intersect with a given point.\n\n@example\nthis._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array} coordinate - A point expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {FeatureCollection}", "modifiers": [ "async" ], "params": [ { "name": "coordinate", "description": "A point expressed in the map view’s coordinate system.", "type": { "name": "Array" }, "optional": false }, { "name": "filter", "description": "A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.", "type": { "name": "Array" }, "optional": true }, { "name": "layerIDs", "description": "A array of layer id's to filter the features by", "type": { "name": "Array" }, "optional": true } ], "returns": { "description": null, "type": { "name": "FeatureCollection" } }, "description": "Returns an array of rendered map features that intersect with a given point.", "examples": [ "\nthis._map.queryRenderedFeaturesAtPoint([30, 40], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n" ] }, { "name": "queryRenderedFeaturesInRect", "docblock": "Returns an array of rendered map features that intersect with the given rectangle,\nrestricted to the given style layers and filtered by the given predicate.\n\n@example\nthis._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n@param {Array} bbox - A rectangle expressed in the map view’s coordinate system.\n@param {Array=} filter - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} layerIDs - A array of layer id's to filter the features by\n@return {FeatureCollection}", "modifiers": [ "async" ], "params": [ { "name": "bbox", "description": "A rectangle expressed in the map view’s coordinate system.", "type": { "name": "Array" }, "optional": false }, { "name": "filter", "description": "A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.", "type": { "name": "Array" }, "optional": true }, { "name": "layerIDs", "description": " A array of layer id's to filter the features by", "type": { "name": "Array" }, "optional": true } ], "returns": { "description": null, "type": { "name": "FeatureCollection" } }, "description": "Returns an array of rendered map features that intersect with the given rectangle,\nrestricted to the given style layers and filtered by the given predicate.", "examples": [ "\nthis._map.queryRenderedFeaturesInRect([30, 40, 20, 10], ['==', 'type', 'Point'], ['id1', 'id2'])\n\n" ] }, { "name": "setCamera", "docblock": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.", "modifiers": [], "params": [], "returns": null, "description": "Map camera will perform updates based on provided config. Deprecated use Camera#setCamera.", "examples": [] }, { "name": "takeSnap", "docblock": "Takes snapshot of map with current tiles and returns a URI to the image\n@param {Boolean} writeToDisk If true will create a temp file, otherwise it is in base64\n@return {String}", "modifiers": [ "async" ], "params": [ { "name": "writeToDisk", "description": "If true will create a temp file, otherwise it is in base64", "type": { "name": "Boolean" }, "optional": false } ], "returns": { "description": null, "type": { "name": "String" } }, "description": "Takes snapshot of map with current tiles and returns a URI to the image", "examples": [] }, { "name": "getZoom", "docblock": "Returns the current zoom of the map view.\n\n@example\nconst zoom = await this._map.getZoom();\n\n@return {Number}", "modifiers": [ "async" ], "params": [], "returns": { "description": null, "type": { "name": "Number" } }, "description": "Returns the current zoom of the map view.", "examples": [ "\nconst zoom = await this._map.getZoom();\n\n" ] }, { "name": "getCenter", "docblock": "Returns the map's geographical centerpoint\n\n@example\nconst center = await this._map.getCenter();\n\n@return {Array} Coordinates", "modifiers": [ "async" ], "params": [], "returns": { "description": "Coordinates", "type": { "name": "Array", "elements": [ { "name": "Number" } ] } }, "description": "Returns the map's geographical centerpoint", "examples": [ "\nconst center = await this._map.getCenter();\n\n" ] }, { "name": "queryTerrainElevation", "docblock": "Queries the currently loaded data for elevation at a geographical location.\nThe elevation is returned in meters relative to mean sea-level.\nReturns null if terrain is disabled or if terrain data for the location hasn't been loaded yet.\n\n@param {Array} coordinate - the coordinates to query elevation at\n@return {Number}", "modifiers": [ "async" ], "params": [ { "name": "coordinate", "description": "the coordinates to query elevation at", "type": { "name": "Array" }, "optional": false } ], "returns": { "description": null, "type": { "name": "Number" } }, "description": "Queries the currently loaded data for elevation at a geographical location.\nThe elevation is returned in meters relative to mean sea-level.\nReturns null if terrain is disabled or if terrain data for the location hasn't been loaded yet.", "examples": [] }, { "name": "setSourceVisibility", "docblock": "Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`\n\n@example\nawait this._map.setSourceVisibility(false, 'composite', 'building')\n\n@param {boolean} visible - Visibility of the layers\n@param {String} sourceId - Identifier of the target source (e.g. 'composite')\n@param {String=} sourceLayerId - Identifier of the target source-layer (e.g. 'building')", "modifiers": [], "params": [ { "name": "visible", "description": "Visibility of the layers", "type": { "name": "boolean" }, "optional": false }, { "name": "sourceId", "description": "Identifier of the target source (e.g. 'composite')", "type": { "name": "String" }, "optional": false }, { "name": "sourceLayerId", "description": "Identifier of the target source-layer (e.g. 'building')", "type": { "name": "String" }, "optional": true } ], "returns": null, "description": "Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`", "examples": [ "\nawait this._map.setSourceVisibility(false, 'composite', 'building')\n\n" ] }, { "name": "showAttribution", "docblock": "Show the attribution and telemetry action sheet.\nIf you implement a custom attribution button, you should add this action to the button.", "modifiers": [], "params": [], "returns": null, "description": "Show the attribution and telemetry action sheet.\nIf you implement a custom attribution button, you should add this action to the button.", "examples": [] } ], "props": [ { "name": "contentInset", "required": false, "type": "union", "default": "none", "description": "The distance from the edges of the map view’s frame to the edges of the map view’s logical viewport." }, { "name": "style", "required": false, "type": "any", "default": "none", "description": "Style for wrapping React Native View" }, { "name": "styleURL", "required": false, "type": "string", "default": "none", "description": "Style URL for map - notice, if non is set it _will_ default to `MapboxGL.StyleURL.Street`" }, { "name": "styleJSON", "required": false, "type": "string", "default": "none", "description": "StyleJSON for map - according to TileJSON specs: https://github.com/mapbox/tilejson-spec" }, { "name": "preferredFramesPerSecond", "required": false, "type": "number", "default": "none", "description": "iOS: The preferred frame rate at which the map view is rendered.\nThe default value for this property is MGLMapViewPreferredFramesPerSecondDefault,\nwhich will adaptively set the preferred frame rate based on the capability of\nthe user’s device to maintain a smooth experience. This property can be set to arbitrary integer values.\n\nAndroid: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.\nThis property can be set to arbitrary integer values." }, { "name": "localizeLabels", "required": false, "type": "bool", "default": "false", "description": "Automatically change the language of the map labels to the system’s preferred language,\nthis is not something that can be toggled on/off" }, { "name": "zoomEnabled", "required": false, "type": "bool", "default": "none", "description": "Enable/Disable zoom on the map" }, { "name": "scrollEnabled", "required": false, "type": "bool", "default": "true", "description": "Enable/Disable scroll on the map" }, { "name": "pitchEnabled", "required": false, "type": "bool", "default": "true", "description": "Enable/Disable pitch on map" }, { "name": "rotateEnabled", "required": false, "type": "bool", "default": "true", "description": "Enable/Disable rotation on map" }, { "name": "attributionEnabled", "required": false, "type": "bool", "default": "true", "description": "The Mapbox terms of service, which governs the use of Mapbox-hosted vector tiles and styles,\n[requires](https://www.mapbox.com/help/how-attribution-works/) these copyright notices to accompany any map that features Mapbox-designed styles, OpenStreetMap data, or other Mapbox data such as satellite or terrain data.\nIf that applies to this map view, do not hide this view or remove any notices from it.\n\nYou are additionally [required](https://www.mapbox.com/help/how-mobile-apps-work/#telemetry) to provide users with the option to disable anonymous usage and location sharing (telemetry).\nIf this view is hidden, you must implement this setting elsewhere in your app. See our website for [Android](https://www.mapbox.com/android-docs/map-sdk/overview/#telemetry-opt-out) and [iOS](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) for implementation details.\n\nEnable/Disable attribution on map. For iOS you need to add MGLMapboxMetricsEnabledSettingShownInApp=YES\nto your Info.plist" }, { "name": "attributionPosition", "required": false, "type": "custom", "default": "none", "description": "Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map. By default on Android, the attribution with information icon (i) will be on the bottom left, while on iOS the mapbox logo will be on bottom left with information icon (i) on bottom right. Read more about mapbox attribution [here](https://docs.mapbox.com/help/getting-started/attribution/)" }, { "name": "tintColor", "required": false, "type": "union", "default": "none", "description": "MapView's tintColor" }, { "name": "logoEnabled", "required": false, "type": "bool", "default": "true", "description": "Enable/Disable the logo on the map." }, { "name": "logoPosition", "required": false, "type": "custom", "default": "none", "description": "Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map" }, { "name": "compassEnabled", "required": false, "type": "bool", "default": "false", "description": "Enable/Disable the compass from appearing on the map" }, { "name": "compassFadeWhenNorth", "required": false, "type": "bool", "default": "false", "description": "[`mapbox` (v10) implementation only] Enable/Disable if the compass should fade out when the map is pointing north" }, { "name": "compassPosition", "required": false, "type": "custom", "default": "none", "description": "[`mapbox` (v10) implementation only] Adds compass offset, e.g. `{top: 8, left: 8}` will put the compass in top-left corner of the map" }, { "name": "compassViewPosition", "required": false, "type": "number", "default": "none", "description": "Change corner of map the compass starts at. 0: TopLeft, 1: TopRight, 2: BottomLeft, 3: BottomRight" }, { "name": "compassViewMargins", "required": false, "type": "object", "default": "none", "description": "Add margins to the compass with x and y values" }, { "name": "scaleBarEnabled", "required": false, "type": "bool", "default": "true", "description": "[`mapbox` (v10) implementation only] Enable/Disable the scale bar from appearing on the map" }, { "name": "scaleBarPosition", "required": false, "type": "custom", "default": "none", "description": "[`mapbox` (v10) implementation only] Adds scale bar offset, e.g. `{top: 8, left: 8}` will put the scale bar in top-left corner of the map" }, { "name": "surfaceView", "required": false, "type": "bool", "default": "false", "description": "[Android only] Enable/Disable use of GLSurfaceView insted of TextureView." }, { "name": "onPress", "required": false, "type": "func", "default": "none", "description": "Map press listener, gets called when a user presses the map" }, { "name": "onLongPress", "required": false, "type": "func", "default": "none", "description": "Map long press listener, gets called when a user long presses the map" }, { "name": "onRegionWillChange", "required": false, "type": "func", "default": "none", "description": "", "values": [], "minimum": [ 0, 0 ], "maximum": [ 360, 180 ], "units": "degrees", "description": "Position of the sun center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the sun relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the sun, where 0° is directly above, at zenith, and 90° at the horizon. When this property is ommitted, the sun center is directly inherited from the light position.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": false }, { "name": "skyAtmosphereSunIntensity", "type": "number", "values": [], "minimum": 0, "maximum": 100, "default": 10, "description": "Intensity of the sun as a light source in the atmosphere (on a scale from 0 to a 100). Setting higher values will brighten up the sky.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "transition": false }, { "name": "skyGradientCenter", "type": "array", "values": [], "minimum": [ 0, 0 ], "maximum": [ 360, 180 ], "units": "degrees", "default": [ 0, 0 ], "description": "Position of the gradient center [a azimuthal angle, p polar angle]. The azimuthal angle indicates the position of the gradient center relative to 0° north, where degrees proceed clockwise. The polar angle indicates the height of the gradient center, where 0° is directly above, at zenith, and 90° at the horizon.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": false }, { "name": "skyGradientRadius", "type": "number", "values": [], "minimum": 0, "maximum": 180, "default": 90, "description": "The angular distance (measured in degrees) from `skyGradientCenter` up to which the gradient extends. A value of 180 causes the gradient to wrap around to the opposite direction from `skyGradientCenter`.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] }, "transition": false }, { "name": "skyGradient", "type": "color", "values": [], "default": [ "interpolate", [ "linear" ], [ "sky-radial-progress" ], 0.8, "#87ceeb", 1, "white" ], "description": "Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using `skyRadialProgress`. The range [0, 1] for the interpolant covers a radial distance (in degrees) of [0, `skyGradientRadius`] centered at the position specified by `skyGradientCenter`.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "sky-radial-progress" ] }, "transition": false }, { "name": "skyAtmosphereHaloColor", "type": "color", "values": [], "default": "white", "description": "A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "transition": false }, { "name": "skyAtmosphereColor", "type": "color", "values": [], "default": "white", "description": "A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "transition": false }, { "name": "skyOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity of the entire sky layer.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true } ] }, "Style": { "description": "Style is a component that automatically adds sources / layers to the map using Mapbox GL Style Spec.\nOnly [`sources`](https://docs.mapbox.com/mapbox-gl-js/style-spec/sources) & [`layers`](https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/) are supported.\nOther fields such as `sprites`, `glyphs` etc. will be ignored. Not all layer / source attributes from the style spec are supported, in general the supported attributes will mentioned under https://github.com/rnmapbox/maps/tree/main/docs.", "displayName": "Style", "methods": [], "props": [ { "name": "json", "required": false, "type": "any", "default": "none", "description": "A JSON object conforming to the schema described in the Mapbox Style Specification , or a URL to such JSON." } ], "fileNameWithExt": "Style.js", "name": "Style" }, "SymbolLayer": { "description": "SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.", "displayName": "SymbolLayer", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the source in the style to which it is added." }, { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", "required": false, "type": "string", "default": "none", "description": "Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style." }, { "name": "aboveLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer above aboveLayerID." }, { "name": "belowLayerID", "required": false, "type": "string", "default": "none", "description": "Inserts a layer below belowLayerID" }, { "name": "layerIndex", "required": false, "type": "number", "default": "none", "description": "Inserts a layer at a specified index" }, { "name": "filter", "required": false, "type": "array", "default": "none", "description": "Filter only the features in the source layer that satisfy a condition that you define" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "The minimum zoom level at which the layer gets parsed and appears." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "The maximum zoom level at which the layer gets parsed and appears." }, { "name": "style", "required": false, "type": "union", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "fileNameWithExt": "SymbolLayer.js", "name": "SymbolLayer", "styles": [ { "name": "symbolPlacement", "type": "enum", "values": [ { "value": "point", "doc": "The label is placed at the point where the geometry is located." }, { "value": "line", "doc": "The label is placed along the line of the geometry. Can only be used on `LineString` and `Polygon` geometries." }, { "value": "line-center", "doc": "The label is placed at the center of the line of the geometry. Can only be used on `LineString` and `Polygon` geometries. Note that a single feature in a vector tile may contain multiple line geometries." } ], "default": "point", "description": "Label placement relative to its geometry.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "symbolSpacing", "type": "number", "values": [], "minimum": 1, "units": "pixels", "default": 250, "description": "Distance between two symbol anchors.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "symbolAvoidEdges", "type": "boolean", "values": [], "default": false, "description": "If true, the symbols will not cross tile edges to avoid mutual collisions. Recommended in layers that don't have enough padding in the vector tile to prevent collisions, or if it is a point symbol layer placed after a line symbol layer. When using a client that supports global collision detection, like Mapbox GL JS version 0.42.0 or greater, enabling this property is not needed to prevent clipped labels at tile boundaries.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "symbolSortKey", "type": "number", "values": [], "description": "Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `iconAllowOverlap` or `textAllowOverlap` is `false`, features with a lower sort key will have priority during placement. When `iconAllowOverlap` or `textAllowOverlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "symbolZOrder", "type": "enum", "values": [ { "value": "auto", "doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`." }, { "value": "viewport-y", "doc": "Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`." }, { "value": "source", "doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data." } ], "default": "auto", "description": "Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their yPosition relative to the viewport. To control the order and prioritization of symbols otherwise, use `symbolSortKey`.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconAllowOverlap", "type": "boolean", "values": [], "default": false, "description": "If true, the icon will be visible even if it collides with other previously drawn symbols.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconIgnorePlacement", "type": "boolean", "values": [], "default": false, "description": "If true, other symbols can be visible even if they collide with the icon.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconOptional", "type": "boolean", "values": [], "default": false, "description": "If true, text will display without their corresponding icons when the icon collides with other symbols and the text does not.", "requires": [ "iconImage", "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconRotationAlignment", "type": "enum", "values": [ { "value": "map", "doc": "When `symbol-placement` is set to `point`, aligns icons east-west. When `symbol-placement` is set to `line` or `line-center`, aligns icon x-axes with the line." }, { "value": "viewport", "doc": "Produces icons whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`." }, { "value": "auto", "doc": "When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`." } ], "default": "auto", "description": "In combination with `symbolPlacement`, determines the rotation behavior of icons.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconSize", "type": "number", "values": [], "minimum": 0, "units": "factor of the original icon size", "default": 1, "description": "Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by `iconSize`. 1 is the original size; 3 triples the size of the image.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "iconTextFit", "type": "enum", "values": [ { "value": "none", "doc": "The icon is displayed at its intrinsic aspect ratio." }, { "value": "width", "doc": "The icon is scaled in the x-dimension to fit the width of the text." }, { "value": "height", "doc": "The icon is scaled in the y-dimension to fit the height of the text." }, { "value": "both", "doc": "The icon is scaled in both x- and y-dimensions." } ], "default": "none", "description": "Scales the icon to fit around the associated text.", "requires": [ "iconImage", "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconTextFitPadding", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0, 0, 0 ], "description": "Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.", "requires": [ "iconImage", "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "iconImage", "type": "resolvedImage", "values": [], "description": "Name of image in sprite to use for drawing an image background.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "iconRotate", "type": "number", "values": [], "units": "degrees", "default": 0, "description": "Rotates the icon clockwise.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "iconPadding", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 2, "description": "Size of the additional area around the icon bounding box used for detecting symbol collisions.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "iconKeepUpright", "type": "boolean", "values": [], "default": false, "description": "If true, the icon may be flipped to prevent it from being rendered upsideDown.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "iconOffset", "type": "array", "values": [], "default": [ 0, 0 ], "description": "Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of `iconSize` to obtain the final offset in pixels. When combined with `iconRotate` the offset will be as if the rotated direction was up.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "iconAnchor", "type": "enum", "values": [ { "value": "center", "doc": "The center of the icon is placed closest to the anchor." }, { "value": "left", "doc": "The left side of the icon is placed closest to the anchor." }, { "value": "right", "doc": "The right side of the icon is placed closest to the anchor." }, { "value": "top", "doc": "The top of the icon is placed closest to the anchor." }, { "value": "bottom", "doc": "The bottom of the icon is placed closest to the anchor." }, { "value": "top-left", "doc": "The top left corner of the icon is placed closest to the anchor." }, { "value": "top-right", "doc": "The top right corner of the icon is placed closest to the anchor." }, { "value": "bottom-left", "doc": "The bottom left corner of the icon is placed closest to the anchor." }, { "value": "bottom-right", "doc": "The bottom right corner of the icon is placed closest to the anchor." } ], "default": "center", "description": "Part of the icon placed closest to the anchor.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "iconPitchAlignment", "type": "enum", "values": [ { "value": "map", "doc": "The icon is aligned to the plane of the map." }, { "value": "viewport", "doc": "The icon is aligned to the plane of the viewport." }, { "value": "auto", "doc": "Automatically matches the value of `icon-rotation-alignment`." } ], "default": "auto", "description": "Orientation of icon when map is pitched.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textPitchAlignment", "type": "enum", "values": [ { "value": "map", "doc": "The text is aligned to the plane of the map." }, { "value": "viewport", "doc": "The text is aligned to the plane of the viewport." }, { "value": "auto", "doc": "Automatically matches the value of `text-rotation-alignment`." } ], "default": "auto", "description": "Orientation of text when map is pitched.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textRotationAlignment", "type": "enum", "values": [ { "value": "map", "doc": "When `symbol-placement` is set to `point`, aligns text east-west. When `symbol-placement` is set to `line` or `line-center`, aligns text x-axes with the line." }, { "value": "viewport", "doc": "Produces glyphs whose x-axes are aligned with the x-axis of the viewport, regardless of the value of `symbol-placement`." }, { "value": "auto", "doc": "When `symbol-placement` is set to `point`, this is equivalent to `viewport`. When `symbol-placement` is set to `line` or `line-center`, this is equivalent to `map`." } ], "default": "auto", "description": "In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textField", "type": "formatted", "values": [], "default": "", "description": "Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options. SDF images are not supported in formatted text and will be ignored.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "textFont", "type": "array", "values": [], "default": [ "Open Sans Regular", "Arial Unicode MS Regular" ], "description": "Font stack to use for displaying text.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "textSize", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 16, "description": "Font size.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textMaxWidth", "type": "number", "values": [], "minimum": 0, "units": "ems", "default": 10, "description": "The maximum line width for text wrapping.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textLineHeight", "type": "number", "values": [], "units": "ems", "default": 1.2, "description": "Text leading value for multiLine text.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textLetterSpacing", "type": "number", "values": [], "units": "ems", "default": 0, "description": "Text tracking amount.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textJustify", "type": "enum", "values": [ { "value": "auto", "doc": "The text is aligned towards the anchor position." }, { "value": "left", "doc": "The text is aligned to the left." }, { "value": "center", "doc": "The text is centered." }, { "value": "right", "doc": "The text is aligned to the right." } ], "default": "center", "description": "Text justification options.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "textRadialOffset", "type": "number", "values": [], "units": "ems", "default": 0, "description": "Radial offset of text, in the direction of the symbol's anchor. Useful in combination with `textVariableAnchor`, which defaults to using the twoDimensional `textOffset` if present.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textVariableAnchor", "type": "array", "values": [], "description": "To increase the chance of placing highPriority labels on the map, you can provide an array of `textAnchor` locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use `textJustify: auto` to choose justification based on anchor position. To apply an offset, use the `textRadialOffset` or the twoDimensional `textOffset`.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textAnchor", "type": "enum", "values": [ { "value": "center", "doc": "The center of the text is placed closest to the anchor." }, { "value": "left", "doc": "The left side of the text is placed closest to the anchor." }, { "value": "right", "doc": "The right side of the text is placed closest to the anchor." }, { "value": "top", "doc": "The top of the text is placed closest to the anchor." }, { "value": "bottom", "doc": "The bottom of the text is placed closest to the anchor." }, { "value": "top-left", "doc": "The top left corner of the text is placed closest to the anchor." }, { "value": "top-right", "doc": "The top right corner of the text is placed closest to the anchor." }, { "value": "bottom-left", "doc": "The bottom left corner of the text is placed closest to the anchor." }, { "value": "bottom-right", "doc": "The bottom right corner of the text is placed closest to the anchor." } ], "default": "center", "description": "Part of the text placed closest to the anchor.", "requires": [ "textField" ], "disabledBy": [ "textVariableAnchor" ], "allowedFunctionTypes": [ "camera" ], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "textMaxAngle", "type": "number", "values": [], "units": "degrees", "default": 45, "description": "Maximum angle change between adjacent characters.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "textWritingMode", "type": "array", "values": [], "description": "The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. For symbol with point placement, the order of elements in an array define priority order for the placement of an orientation variant. For symbol with line placement, the default text writing mode is either ['horizontal', 'vertical'] or ['vertical', 'horizontal'], the order doesn't affect the placement.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textRotate", "type": "number", "values": [], "units": "degrees", "default": 0, "description": "Rotates the text clockwise.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textPadding", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 2, "description": "Size of the additional area around the text bounding box used for detecting symbol collisions.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] } }, { "name": "textKeepUpright", "type": "boolean", "values": [], "default": true, "description": "If true, the text may be flipped vertically to prevent it from being rendered upsideDown.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textTransform", "type": "enum", "values": [ { "value": "none", "doc": "The text is not altered." }, { "value": "uppercase", "doc": "Forces all letters to be displayed in uppercase." }, { "value": "lowercase", "doc": "Forces all letters to be displayed in lowercase." } ], "default": "none", "description": "Specifies how to capitalize text, similar to the CSS `textTransform` property.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom", "feature" ] } }, { "name": "textOffset", "type": "array", "values": [], "units": "ems", "default": [ 0, 0 ], "description": "Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up. If used with textVariableAnchor, input values will be taken as absolute values. Offsets along the x and yAxis will be applied automatically based on the anchor position.", "requires": [ "textField" ], "disabledBy": [ "textRadialOffset" ], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature" ] } }, { "name": "textAllowOverlap", "type": "boolean", "values": [], "default": false, "description": "If true, the text will be visible even if it collides with other previously drawn symbols.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textIgnorePlacement", "type": "boolean", "values": [], "default": false, "description": "If true, other symbols can be visible even if they collide with the text.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textOptional", "type": "boolean", "values": [], "default": false, "description": "If true, icons will display without their corresponding text when the text collides with other symbols and the icon does not.", "requires": [ "textField", "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "visibility", "type": "enum", "values": [ { "value": "visible", "doc": "The layer is shown." }, { "value": "none", "doc": "The layer is not shown." } ], "default": "visible", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [], "allowedFunctionTypes": [] }, { "name": "iconOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity at which the icon will be drawn.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "iconColor", "type": "color", "values": [], "default": "#000000", "description": "The color of the icon. This can only be used with [SDF icons](/help/troubleshooting/usingRecolorableImagesInMapboxMaps/).", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "iconHaloColor", "type": "color", "values": [], "default": "rgba(0, 0, 0, 0)", "description": "The color of the icon's halo. Icon halos can only be used with [SDF icons](/help/troubleshooting/usingRecolorableImagesInMapboxMaps/).", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "iconHaloWidth", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "Distance of halo to the icon outline.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "iconHaloBlur", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "Fade out the halo towards the outside.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "iconTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "Distance that the icon's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.", "requires": [ "iconImage" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "iconTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "Icons are translated relative to the map." }, { "value": "viewport", "doc": "Icons are translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `iconTranslate`.", "requires": [ "iconImage", "iconTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } }, { "name": "textOpacity", "type": "number", "values": [], "minimum": 0, "maximum": 1, "default": 1, "description": "The opacity at which the text will be drawn.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "textColor", "type": "color", "values": [], "default": "#000000", "description": "The color with which the text will be drawn.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "textHaloColor", "type": "color", "values": [], "default": "rgba(0, 0, 0, 0)", "description": "The color of the text's halo, which helps it stand out from backgrounds.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "textHaloWidth", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "textHaloBlur", "type": "number", "values": [], "minimum": 0, "units": "pixels", "default": 0, "description": "The halo's fadeout distance towards the outside.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom", "feature", "feature-state" ] }, "transition": true }, { "name": "textTranslate", "type": "array", "values": [], "units": "pixels", "default": [ 0, 0 ], "description": "Distance that the text's anchor is moved from its original placement. Positive values indicate right and down, while negative values indicate left and up.", "requires": [ "textField" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": true, "parameters": [ "zoom" ] }, "transition": true }, { "name": "textTranslateAnchor", "type": "enum", "values": [ { "value": "map", "doc": "The text is translated relative to the map." }, { "value": "viewport", "doc": "The text is translated relative to the viewport." } ], "default": "map", "description": "Controls the frame of reference for `textTranslate`.", "requires": [ "textField", "textTranslate" ], "disabledBy": [], "allowedFunctionTypes": [], "expression": { "interpolated": false, "parameters": [ "zoom" ] } } ] }, "Terrain": { "description": "A global modifier that elevates layers and markers based on a DEM data source.", "displayName": "Terrain", "methods": [ { "name": "baseProps", "docblock": null, "modifiers": [ "get" ], "params": [], "returns": null } ], "props": [ { "name": "sourceID", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "Name of a source of raster_dem type to be used for terrain elevation." }, { "name": "exaggeration", "required": false, "type": "union", "default": "none", "description": "Optional number between 0 and 1000 inclusive. Defaults to 1. Supports interpolateexpressions. Transitionable.\nExaggerates the elevation of the terrain by multiplying the data from the DEM with this value." } ], "composes": [ "../utils" ], "fileNameWithExt": "Terrain.js", "name": "Terrain" }, "UserLocation": { "description": "", "displayName": "UserLocation", "methods": [ { "name": "setLocationManager", "docblock": "Whether to start or stop listening to the locationManager\n\nNotice, that listening will start automatically when\neither `onUpdate` or `visible` are set\n\n@async\n@param {Object} running - Object with key `running` and `boolean` value\n@return {Promise}", "modifiers": [ "async" ], "params": [ { "name": "{ running }", "type": { "name": null } } ], "returns": { "description": null, "type": { "name": "Promise", "elements": [ { "name": "void" } ] } }, "description": "Whether to start or stop listening to the locationManager\n\nNotice, that listening will start automatically when\neither `onUpdate` or `visible` are set", "examples": [] }, { "name": "needsLocationManagerRunning", "docblock": "If locationManager should be running\n\n@return {boolean}", "modifiers": [], "params": [], "returns": { "description": null, "type": { "name": "boolean" } }, "description": "If locationManager should be running", "examples": [] } ], "props": [ { "name": "animated", "required": false, "type": "bool", "default": "true", "description": "Whether location icon is animated between updates" }, { "name": "renderMode", "required": false, "type": "enum", "default": "'normal'", "description": "Which render mode to use.\nCan either be `normal` or `native`" }, { "name": "androidRenderMode", "required": false, "type": "enum", "default": "none", "description": "native/android only render mode\n\n - normal: just a circle\n - compass: triangle with heading\n - gps: large arrow\n\n@platform android" }, { "name": "visible", "required": false, "type": "bool", "default": "true", "description": "Whether location icon is visible" }, { "name": "onPress", "required": false, "type": "func", "default": "none", "description": "Callback that is triggered on location icon press" }, { "name": "onUpdate", "required": false, "type": "func", "default": "none", "description": "Callback that is triggered on location update" }, { "name": "showsUserHeadingIndicator", "required": false, "type": "bool", "default": "false", "description": "Show or hide small arrow which indicates direction the device is pointing relative to north." }, { "name": "minDisplacement", "required": false, "type": "number", "default": "0", "description": "Minimum amount of movement before GPS location is updated in meters" }, { "name": "children", "required": false, "type": "any", "default": "none", "description": "Custom location icon of type mapbox-gl-native components" } ], "fileNameWithExt": "UserLocation.js", "name": "UserLocation" }, "VectorSource": { "description": "VectorSource is a map content source that supplies tiled vector data in Mapbox Vector Tile format to be shown on the map.\nThe location of and metadata about the tiles are defined either by an option dictionary or by an external file that conforms to the TileJSON specification.", "displayName": "VectorSource", "methods": [ { "name": "features", "docblock": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.\n\n@example\nvectorSource.features(['id1', 'id2'])\n\n@param {Array=} layerIDs - A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.\n@param {Array=} filter - an optional filter statement to filter the returned Features.\n@return {FeatureCollection}", "modifiers": [ "async" ], "params": [ { "name": "layerIDs", "description": "A set of strings that correspond to the names of layers defined in the current style. Only the features contained in these layers are included in the returned array.", "type": { "name": "Array" }, "optional": true }, { "name": "filter", "description": "an optional filter statement to filter the returned Features.", "type": { "name": "Array" }, "optional": true } ], "returns": { "description": null, "type": { "name": "FeatureCollection" } }, "description": "Returns all features that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map. The domain of the query includes all currently-loaded vector tiles\nand GeoJSON source tiles. This function does not check tiles outside of the visible viewport.", "examples": [ "\nvectorSource.features(['id1', 'id2'])\n\n" ] }, { "name": "onPress", "docblock": null, "modifiers": [], "params": [ { "name": "event", "type": { "name": null } } ], "returns": null } ], "props": [ { "name": "id", "required": false, "type": "string", "default": "MapboxGL.StyleSource.DefaultSourceID", "description": "A string that uniquely identifies the source." }, { "name": "url", "required": false, "type": "string", "default": "none", "description": "A URL to a TileJSON configuration file describing the source’s contents and other metadata." }, { "name": "tileUrlTemplates", "required": false, "type": { "name": "array", "value": { "type": "string" } }, "default": "none", "description": "An array of tile URL templates. If multiple endpoints are specified, clients may use any combination of endpoints.\nExample: https://example.com/vector-tiles/{z}/{x}/{y}.pbf" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "An unsigned integer that specifies the minimum zoom level at which to display tiles from the source.\nThe value should be between 0 and 22, inclusive, and less than\nmaxZoomLevel, if specified. The default value for this option is 0." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "An unsigned integer that specifies the maximum zoom level at which to display tiles from the source.\nThe value should be between 0 and 22, inclusive, and less than\nminZoomLevel, if specified. The default value for this option is 22." }, { "name": "tms", "required": false, "type": "bool", "default": "none", "description": "Influences the y direction of the tile coordinates. (tms inverts y axis)" }, { "name": "attribution", "required": false, "type": "string", "default": "none", "description": "An HTML or literal text string defining the buttons to be displayed in an action sheet when the\nsource is part of a map view’s style and the map view’s attribution button is pressed." }, { "name": "onPress", "required": false, "type": "func", "default": "none", "description": "Source press listener, gets called when a user presses one of the children layers only\nif that layer has a higher z-index than another source layers", "params": [ { "name": "event", "description": null, "type": { "name": "Object" }, "optional": false }, { "name": "event.features", "description": "the geojson features that have hit by the press (might be multiple)", "type": { "name": "Array", "elements": [ { "name": "Object" } ] }, "optional": false }, { "name": "event.coordinates", "description": "the coordinates of the click", "type": { "name": "Object" }, "optional": false }, { "name": "event.point", "description": "the point of the click", "type": { "name": "Object" }, "optional": false } ] }, { "name": "hitbox", "required": false, "type": { "name": "shape", "value": [ { "name": "width", "required": true, "type": "number", "default": "none", "description": "`width` of hitbox" }, { "name": "height", "required": true, "type": "number", "default": "none", "description": "`height` of hitbox" } ] }, "default": "none", "description": "Overrides the default touch hitbox(44x44 pixels) for the source layers" } ], "composes": [ "../utils" ], "fileNameWithExt": "VectorSource.js", "name": "VectorSource" }, "Annotation": { "description": "", "displayName": "Annotation", "methods": [ { "name": "onPress", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "symbolStyle", "docblock": null, "modifiers": [ "get" ], "params": [], "returns": null } ], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "FIX ME NO DESCRIPTION" }, { "name": "animated", "required": false, "type": "bool", "default": "false", "description": "FIX ME NO DESCRIPTION" }, { "name": "animationDuration", "required": false, "type": "number", "default": "1000", "description": "FIX ME NO DESCRIPTION" }, { "name": "animationEasingFunction", "required": false, "type": "func", "default": "Easing.linear", "description": "FIX ME NO DESCRIPTION" }, { "name": "coordinates", "required": false, "type": { "name": "array", "value": { "type": "number" } }, "default": "none", "description": "FIX ME NO DESCRIPTION" }, { "name": "onPress", "required": false, "type": "func", "default": "none", "description": "FIX ME NO DESCRIPTION" }, { "name": "children", "required": false, "type": "any", "default": "none", "description": "FIX ME NO DESCRIPTION" }, { "name": "style", "required": false, "type": "any", "default": "none", "description": "FIX ME NO DESCRIPTION" }, { "name": "icon", "required": false, "type": "union", "default": "none", "description": "FIX ME NO DESCRIPTION" } ], "fileNameWithExt": "Annotation.js", "name": "Annotation" }, "offlineManager": { "name": "offlineManager", "fileNameWithExt": "offlineManager.js", "description": "OfflineManager implements a singleton (shared object) that manages offline packs.\nAll of this class’s instance methods are asynchronous, reflecting the fact that offline resources are stored in a database.\nThe shared object maintains a canonical collection of offline packs.", "props": [], "styles": [], "methods": [ { "name": "createPack", "description": "Creates and registers an offline pack that downloads the resources needed to use the given region offline.", "params": [ { "name": "options", "description": "Create options for a offline pack that specifices zoom levels, style url, and the region to download.", "type": { "name": "OfflineCreatePackOptions" }, "optional": false }, { "name": "progressListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { "name": "Callback" }, "optional": true }, { "name": "errorListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { "name": "Callback" }, "optional": true } ], "examples": [ "const progressListener = (offlineRegion, status) => console.log(offlineRegion, status);\nconst errorListener = (offlineRegion, err) => console.log(offlineRegion, err);\n\nawait MapboxGL.offlineManager.createPack({\n name: 'offlinePack',\n styleURL: 'mapbox://...',\n minZoom: 14,\n maxZoom: 20,\n bounds: [[neLng, neLat], [swLng, swLat]]\n}, progressListener, errorListener)" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "invalidatePack", "description": "Invalidates the specified offline pack. This method checks that the tiles in the specified offline pack match those from the server. Local tiles that do not match the latest version on the server are updated.This is more efficient than deleting the offline pack and downloading it again. If the data stored locally matches that on the server, new data will not be downloaded.", "params": [ { "name": "name", "description": "Name of the offline pack.", "type": { "name": "String" }, "optional": false } ], "examples": [ "await MapboxGL.offlineManager.invalidatePack('packName')" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "deletePack", "description": "Unregisters the given offline pack and allows resources that are no longer required by any remaining packs to be potentially freed.", "params": [ { "name": "name", "description": "Name of the offline pack.", "type": { "name": "String" }, "optional": false } ], "examples": [ "await MapboxGL.offlineManager.deletePack('packName')" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "invalidateAmbientCache", "description": "Forces a revalidation of the tiles in the ambient cache and downloads a fresh version of the tiles from the tile server.\nThis is the recommend method for clearing the cache.\nThis is the most efficient method because tiles in the ambient cache are re-downloaded to remove outdated data from a device.\nIt does not erase resources from the ambient cache or delete the database, which can be computationally expensive operations that may carry unintended side effects.", "params": [], "examples": [ "await MapboxGL.offlineManager.invalidateAmbientCache();" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "clearAmbientCache", "description": "Erases resources from the ambient cache.\nThis method clears the cache and decreases the amount of space that map resources take up on the device.", "params": [], "examples": [ "await MapboxGL.offlineManager.clearAmbientCache();" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "migrateOfflineCache", "description": "Migrates the offline cache from pre-v10 SDKs to the new v10 cache location", "params": [], "examples": [ "await MapboxGL.offlineManager.migrateOfflineCache()" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "setMaximumAmbientCacheSize", "description": "Sets the maximum size of the ambient cache in bytes. Disables the ambient cache if set to 0.\nThis method may be computationally expensive because it will erase resources from the ambient cache if its size is decreased.", "params": [ { "name": "size", "description": "Size of ambient cache.", "type": { "name": "Number" }, "optional": false } ], "examples": [ "await MapboxGL.offlineManager.setMaximumAmbientCacheSize(5000000);" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "resetDatabase", "description": "Deletes the existing database, which includes both the ambient cache and offline packs, then reinitializes it.", "params": [], "examples": [ "await MapboxGL.offlineManager.resetDatabase();" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "getPacks", "description": "Retrieves all the current offline packs that are stored in the database.", "params": [], "examples": [ "const offlinePacks = await MapboxGL.offlineManager.getPacks();" ], "returns": { "description": "", "type": { "name": "Array" } } }, { "name": "getPack", "description": "Retrieves an offline pack that is stored in the database by name.", "params": [ { "name": "name", "description": "Name of the offline pack.", "type": { "name": "String" }, "optional": false } ], "examples": [ "const offlinePack = await MapboxGL.offlineManager.getPack();" ], "returns": { "description": "", "type": { "name": "OfflinePack" } } }, { "name": "mergeOfflineRegions", "description": "Sideloads offline db", "params": [ { "name": "path", "description": "Path to offline tile db on file system.", "type": { "name": "String" }, "optional": false } ], "examples": [ "await MapboxGL.offlineManager.mergeOfflineRegions(path);" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "setTileCountLimit", "description": "Sets the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device.\nThe Mapbox Terms of Service prohibit changing or bypassing this limit without permission from Mapbox.", "params": [ { "name": "limit", "description": "Map tile limit count.", "type": { "name": "Number" }, "optional": false } ], "examples": [ "MapboxGL.offlineManager.setTileCountLimit(1000);" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "setProgressEventThrottle", "description": "Sets the period at which download status events will be sent over the React Native bridge.\nThe default is 500ms.", "params": [ { "name": "throttleValue", "description": "event throttle value in ms.", "type": { "name": "Number" }, "optional": false } ], "examples": [ "MapboxGL.offlineManager.setProgressEventThrottle(500);" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "subscribe", "description": "Subscribe to download status/error events for the requested offline pack.\nNote that createPack calls this internally if listeners are provided.", "params": [ { "name": "packName", "description": "Name of the offline pack.", "type": { "name": "String" }, "optional": false }, { "name": "progressListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { "name": "Callback" }, "optional": false }, { "name": "errorListener", "description": "Callback that listens for status events while downloading the offline resource.", "type": { "name": "Callback" }, "optional": false } ], "examples": [ "const progressListener = (offlinePack, status) => console.log(offlinePack, status)\nconst errorListener = (offlinePack, err) => console.log(offlinePack, err)\nMapboxGL.offlineManager.subscribe('packName', progressListener, errorListener)" ], "returns": { "description": "", "type": { "name": "void" } } }, { "name": "unsubscribe", "description": "Unsubscribes any listeners associated with the offline pack.\nIt's a good idea to call this on componentWillUnmount.", "params": [ { "name": "packName", "description": "Name of the offline pack.", "type": { "name": "String" }, "optional": false } ], "examples": [ "MapboxGL.offlineManager.unsubscribe('packName')" ], "returns": { "description": "", "type": { "name": "void" } } } ] }, "snapshotManager": { "name": "snapshotManager", "fileNameWithExt": "snapshotManager.js", "description": "The snapshotManager generates static raster images of the map.\nEach snapshot image depicts a portion of a map defined by an SnapshotOptions object you provide.\nThe snapshotter generates the snapshot asynchronous.", "props": [], "styles": [], "methods": [ { "name": "takeSnap", "description": "Takes a snapshot of the base map using the provided Snapshot options. NOTE pitch, heading, zoomLevel only works when centerCoordinate is set!", "params": [ { "name": "options", "description": "Snapshot options for create a static image of the base map", "type": { "name": "SnapshotOptions" }, "optional": false } ], "examples": [ "// creates a temp file png of base map\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n centerCoordinate: [-74.126410, 40.797968],\n width: width,\n height: height,\n zoomLevel: 12,\n pitch: 30,\n heading: 20,\n styleURL: MapboxGL.StyleURL.Dark,\n writeToDisk: true, // Create a temporary file\n});\n\n// creates base64 png of base map without logo\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n centerCoordinate: [-74.126410, 40.797968],\n width: width,\n height: height,\n zoomLevel: 12,\n pitch: 30,\n heading: 20,\n styleURL: MapboxGL.StyleURL.Dark,\n withLogo: false, // Disable Mapbox logo (Android only)\n});\n\n// creates snapshot with bounds\nconst uri = await MapboxGL.snapshotManager.takeSnap({\n bounds: [[-74.126410, 40.797968], [-74.143727, 40.772177]],\n width: width,\n height: height,\n styleURL: MapboxGL.StyleURL.Dark,\n});" ], "returns": { "description": "", "type": { "name": "Promise" } } } ] } }