{ "BackgroundLayer": { "description": "", "methods": [], "props": [ { "name": "id", "required": false, "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. If the source has not yet been added to the current style, the behavior is undefined." }, { "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" ], "name": "BackgroundLayer", "styles": [ { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "backgroundColor", "type": "color", "description": "The color with which the background will be drawn.", "requires": [], "disabledBy": [ "backgroundPattern" ] }, { "name": "backgroundPattern", "type": "string", "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).", "requires": [], "disabledBy": [] }, { "name": "backgroundOpacity", "type": "number", "description": "The opacity at which the background will be drawn.", "requires": [], "disabledBy": [] } ] }, "Callout": { "description": "Callout that displays information about a selected annotation near the annotation.", "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" ], "name": "Callout" }, "CircleLayer": { "description": "CircleLayer is a style layer that renders one or more filled circles on the map.", "methods": [], "props": [ { "name": "id", "required": false, "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." }, { "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" ], "name": "CircleLayer", "styles": [ { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "circleRadius", "type": "number", "description": "Circle radius.", "requires": [], "disabledBy": [] }, { "name": "circleColor", "type": "color", "description": "The fill color of the circle.", "requires": [], "disabledBy": [] }, { "name": "circleBlur", "type": "number", "description": "Amount to blur the circle. 1 blurs the circle such that only the centerpoint is full opacity.", "requires": [], "disabledBy": [] }, { "name": "circleOpacity", "type": "number", "description": "The opacity at which the circle will be drawn.", "requires": [], "disabledBy": [] }, { "name": "circleTranslate", "type": "array", "description": "The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [] }, { "name": "circleTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "circleTranslate" ], "disabledBy": [] }, { "name": "circlePitchScale", "type": "enum", "description": "Controls the scaling behavior of the circle when the map is pitched.", "requires": [], "disabledBy": [] }, { "name": "circleStrokeWidth", "type": "number", "description": "The width of the circle's stroke. Strokes are placed outside of the `circleRadius`.", "requires": [], "disabledBy": [] }, { "name": "circleStrokeColor", "type": "color", "description": "The stroke color of the circle.", "requires": [], "disabledBy": [] }, { "name": "circleStrokeOpacity", "type": "number", "description": "The opacity of the circle's stroke.", "requires": [], "disabledBy": [] } ] }, "FillExtrusionLayer": { "description": "FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.", "methods": [], "props": [ { "name": "id", "required": false, "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. If the source has not yet been added to the current style, the behavior is undefined." }, { "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" ], "name": "FillExtrusionLayer", "styles": [ { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "fillExtrusionOpacity", "type": "number", "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": [] }, { "name": "fillExtrusionColor", "type": "color", "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" ] }, { "name": "fillExtrusionTranslate", "type": "array", "description": "The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up (on the flat plane), respectively.", "requires": [], "disabledBy": [] }, { "name": "fillExtrusionTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "fillExtrusionTranslate" ], "disabledBy": [] }, { "name": "fillExtrusionPattern", "type": "string", "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).", "requires": [], "disabledBy": [] }, { "name": "fillExtrusionHeight", "type": "number", "description": "The height with which to extrude this layer.", "requires": [], "disabledBy": [] }, { "name": "fillExtrusionBase", "type": "number", "description": "The height with which to extrude the base of this layer. Must be less than or equal to `fillExtrusionHeight`.", "requires": [ "fillExtrusionHeight" ], "disabledBy": [] } ] }, "FillLayer": { "description": "FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.", "methods": [], "props": [ { "name": "id", "required": false, "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. If the source has not yet been added to the current style, the behavior is undefined." }, { "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" ], "name": "FillLayer", "styles": [ { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "fillAntialias", "type": "boolean", "description": "Whether or not the fill should be antialiased.", "requires": [], "disabledBy": [] }, { "name": "fillOpacity", "type": "number", "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": [] }, { "name": "fillColor", "type": "color", "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" ] }, { "name": "fillOutlineColor", "type": "color", "description": "The outline color of the fill. Matches the value of `fillColor` if unspecified.", "requires": [], "disabledBy": [ "fillPattern" ] }, { "name": "fillTranslate", "type": "array", "description": "The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [] }, { "name": "fillTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "fillTranslate" ], "disabledBy": [] }, { "name": "fillPattern", "type": "string", "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).", "requires": [], "disabledBy": [] } ] }, "Light": { "description": "Light represents the light source for extruded geometries", "methods": [], "props": [ { "name": "style", "required": false, "type": "custom", "default": "none", "description": "Customizable style attributes" } ], "composes": [ "../utils" ], "name": "Light", "styles": [ { "name": "anchor", "type": "enum", "description": "Whether extruded geometries are lit relative to the map or viewport.", "requires": [], "disabledBy": [] }, { "name": "position", "type": "array", "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": [] }, { "name": "color", "type": "color", "description": "Color tint for lighting extruded geometries.", "requires": [], "disabledBy": [] }, { "name": "intensity", "type": "number", "description": "Intensity of lighting (on a scale from 0 to 1). Higher numbers will present as more extreme contrast.", "requires": [], "disabledBy": [] } ] }, "LineLayer": { "description": "LineLayer is a style layer that renders one or more stroked polylines on the map.", "methods": [], "props": [ { "name": "id", "required": false, "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." }, { "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" ], "name": "LineLayer", "styles": [ { "name": "lineCap", "type": "enum", "description": "The display of line endings.", "requires": [], "disabledBy": [] }, { "name": "lineJoin", "type": "enum", "description": "The display of lines when joining.", "requires": [], "disabledBy": [] }, { "name": "lineMiterLimit", "type": "number", "description": "Used to automatically convert miter joins to bevel joins for sharp angles.", "requires": [], "disabledBy": [] }, { "name": "lineRoundLimit", "type": "number", "description": "Used to automatically convert round joins to miter joins for shallow angles.", "requires": [], "disabledBy": [] }, { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "lineOpacity", "type": "number", "description": "The opacity at which the line will be drawn.", "requires": [], "disabledBy": [] }, { "name": "lineColor", "type": "color", "description": "The color with which the line will be drawn.", "requires": [], "disabledBy": [ "linePattern" ] }, { "name": "lineTranslate", "type": "array", "description": "The geometry's offset. Values are `{ x: number, y: number }` where negatives indicate left and up, respectively.", "requires": [], "disabledBy": [] }, { "name": "lineTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "lineTranslate" ], "disabledBy": [] }, { "name": "lineWidth", "type": "number", "description": "Stroke thickness.", "requires": [], "disabledBy": [] }, { "name": "lineGapWidth", "type": "number", "description": "Draws a line casing outside of a line's actual path. Value indicates the width of the inner gap.", "requires": [], "disabledBy": [] }, { "name": "lineOffset", "type": "number", "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": [] }, { "name": "lineBlur", "type": "number", "description": "Blur applied to the line, in pixels.", "requires": [], "disabledBy": [] }, { "name": "lineDasharray", "type": "array", "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.", "requires": [], "disabledBy": [ "linePattern" ] }, { "name": "linePattern", "type": "string", "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).", "requires": [], "disabledBy": [] } ] }, "MapView": { "description": "MapView backed by Mapbox Native GL", "methods": [ { "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" } }, { "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" } }, { "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": "fitBounds", "docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.map.fitBounds([lng, lat], [lng, lat])\nthis.map.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.map.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.map.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array} northEastCoordinates - North east coordinate of bound\n@param {Array} southWestCoordinates - South west coordinate of bound\n@param {Number=} padding - Camera padding for bound\n@param {Number=} duration - Duration of camera animation\n@return {void}", "modifiers": [], "params": [ { "name": "northEastCoordinates", "description": "North east coordinate of bound", "type": { "name": "Array" } }, { "name": "southWestCoordinates", "description": "South west coordinate of bound", "type": { "name": "Array" } }, { "name": "padding", "description": "Camera padding for bound", "type": { "name": "Number" }, "optional": true }, { "name": "duration", "description": "Duration of camera animation", "type": { "name": "Number" }, "optional": true } ], "returns": { "description": null, "type": { "name": "void" } }, "description": "Map camera transitions to fit provided bounds", "examples": [ "\nthis.map.fitBounds([lng, lat], [lng, lat])\nthis.map.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.map.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.map.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n" ] }, { "name": "flyTo", "docblock": "Map camera will fly to new coordinate\n\n@example\nthis.map.flyTo([lng, lat])\nthis.map.flyTo([lng, lat], 12000)\n\n @param {Array} coordinates - Coordinates that map camera will jump too\n @param {Number=} duration - Duration of camera animation\n @return {void}", "modifiers": [], "params": [ { "name": "coordinates", "description": "Coordinates that map camera will jump too", "type": { "name": "Array" } }, { "name": "duration", "description": "Duration of camera animation", "type": { "name": "Number" }, "optional": true } ], "returns": { "description": null, "type": { "name": "void" } }, "description": "Map camera will fly to new coordinate", "examples": [ "\nthis.map.flyTo([lng, lat])\nthis.map.flyTo([lng, lat], 12000)\n\n " ] }, { "name": "moveTo", "docblock": "Map camera will move to new coordinate at the same zoom level\n\n@example\nthis.map.moveTo([lng, lat], 200) // eases camera to new location based on duration\nthis.map.moveTo([lng, lat]) // snaps camera to new location without any easing\n\n @param {Array} coordinates - Coordinates that map camera will move too\n @param {Number=} duration - Duration of camera animation\n @return {void}", "modifiers": [], "params": [ { "name": "coordinates", "description": "Coordinates that map camera will move too", "type": { "name": "Array" } }, { "name": "duration", "description": "Duration of camera animation", "type": { "name": "Number" }, "optional": true } ], "returns": { "description": null, "type": { "name": "void" } }, "description": "Map camera will move to new coordinate at the same zoom level", "examples": [ "\nthis.map.moveTo([lng, lat], 200) // eases camera to new location based on duration\nthis.map.moveTo([lng, lat]) // snaps camera to new location without any easing\n\n " ] }, { "name": "zoomTo", "docblock": "Map camera will zoom to specified level\n\n@example\nthis.map.zoomTo(16)\nthis.map.zoomTo(16, 100)\n\n@param {Number} zoomLevel - Zoom level that the map camera will animate too\n@param {Number=} duration - Duration of camera animation\n@return {void}", "modifiers": [], "params": [ { "name": "zoomLevel", "description": "Zoom level that the map camera will animate too", "type": { "name": "Number" } }, { "name": "duration", "description": "Duration of camera animation", "type": { "name": "Number" }, "optional": true } ], "returns": { "description": null, "type": { "name": "void" } }, "description": "Map camera will zoom to specified level", "examples": [ "\nthis.map.zoomTo(16)\nthis.map.zoomTo(16, 100)\n\n" ] }, { "name": "setCamera", "docblock": "Map camera will perform updates based on provided config. Advanced use only!\n\n@example\nthis.map.setCamera({\n centerCoordinate: [lng, lat],\n zoomLevel: 16,\n duration: 2000,\n})\n\nthis.map.setCamera({\n stops: [\n { pitch: 45, duration: 200 },\n { heading: 180, duration: 300 },\n ]\n})\n\n @param {Object} config - Camera configuration", "modifiers": [], "params": [ { "name": "config", "description": "Camera configuration", "type": { "name": "Object" } } ], "returns": null, "description": "Map camera will perform updates based on provided config. Advanced use only!", "examples": [ "\nthis.map.setCamera({\n centerCoordinate: [lng, lat],\n zoomLevel: 16,\n duration: 2000,\n})\n\nthis.map.setCamera({\n stops: [\n { pitch: 45, duration: 200 },\n { heading: 180, duration: 300 },\n ]\n})\n\n " ] } ], "props": [ { "name": "animated", "required": false, "type": "bool", "default": "false", "description": "Animates changes between pitch and bearing" }, { "name": "centerCoordinate", "required": false, "type": "arrayOf", "default": "none", "description": "Initial center coordinate on map [lng, lat]" }, { "name": "showUserLocation", "required": false, "type": "bool", "default": "none", "description": "Shows the users location on the map" }, { "name": "userTrackingMode", "required": false, "type": "number", "default": "MapboxGL.UserTrackingModes.None", "description": "The mode used to track the user location on the map" }, { "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": "heading", "required": false, "type": "number", "default": "0", "description": "Initial heading on map" }, { "name": "pitch", "required": false, "type": "number", "default": "0", "description": "Initial pitch on map" }, { "name": "style", "required": false, "type": "any", "default": "none", "description": "Style for wrapping React Native View" }, { "name": "styleURL", "required": false, "type": "string", "default": "MapboxGL.StyleURL.Street", "description": "Style URL for map" }, { "name": "zoomLevel", "required": false, "type": "number", "default": "16", "description": "Initial zoom level of map" }, { "name": "minZoomLevel", "required": false, "type": "number", "default": "none", "description": "Min zoom level of map" }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "Max zoom level of map" }, { "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": "Enable/Disable attribution on map. For iOS you need to add MGLMapboxMetricsEnabledSettingShownInApp=YES\nto your Info.plist" }, { "name": "logoEnabled", "required": false, "type": "bool", "default": "true", "description": "Enable/Disable the logo on the map." }, { "name": "compassEnabled", "required": false, "type": "bool", "default": "none", "description": "Enable/Disable the compass from appearing on the map" }, { "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": "This event is triggered whenever the currently displayed map region is about to change." }, { "name": "onRegionIsChanging", "required": false, "type": "func", "default": "none", "description": "This event is triggered whenever the currently displayed map region is changing." }, { "name": "onRegionDidChange", "required": false, "type": "func", "default": "none", "description": "This event is triggered whenever the currently displayed map region finished changing" }, { "name": "onWillStartLoadingMap", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map is about to start loading a new map style." }, { "name": "onDidFinishLoadingMap", "required": false, "type": "func", "default": "none", "description": "This is triggered when the map has successfully loaded a new map style." }, { "name": "onDidFailLoadingMap", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map has failed to load a new map style." }, { "name": "onWillStartRenderingFrame", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map will start rendering a frame." }, { "name": "onDidFinishRenderingFrame", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map finished rendering a frame." }, { "name": "onDidFinishRenderingFrameFully", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map fully finished rendering a frame." }, { "name": "onWillStartRenderingMap", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map will start rendering the map." }, { "name": "onDidFinishRenderingMap", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map finished rendering the map." }, { "name": "onDidFinishRenderingMapFully", "required": false, "type": "func", "default": "none", "description": "This event is triggered when the map fully finished rendering the map." }, { "name": "onDidFinishLoadingStyle", "required": false, "type": "func", "default": "none", "description": "This event is triggered when a style has finished loading." }, { "name": "onFlyToComplete", "required": false, "type": "func", "default": "none", "description": "This event is triggered when a fly to animation is cancelled or completed after calling flyTo" }, { "name": "onSetCameraComplete", "required": false, "type": "func", "default": "none", "description": "This event is triggered once the camera is finished after calling setCamera" } ], "composes": [ "../utils" ], "name": "MapView" }, "PointAnnotation": { "description": "PointAnnotation represents a one-dimensional shape located at a single geographical coordinate.", "methods": [], "props": [ { "name": "id", "required": true, "type": "string", "default": "none", "description": "A string that uniquely identifies the annotation" }, { "name": "title", "required": false, "type": "string", "default": "none", "description": "The string containing the annotation’s title. Note this is required to be set if you want to see a callout appear on iOS." }, { "name": "snippet", "required": false, "type": "string", "default": "none", "description": "The string containing the annotation’s snippet(subtitle). Not displayed in the default callout." }, { "name": "selected", "required": false, "type": "bool", "default": "none", "description": "Manually selects/deselects annotation\n@type {[type]}" }, { "name": "coordinate", "required": true, "type": "arrayOf", "default": "none", "description": "The center point (specified as a map coordinate) of the annotation." }, { "name": "anchor", "required": false, "type": "shape", "default": "{ x: 0.5, y: 0.5 }", "description": "Specifies the anchor being set on a particular point of the annotation.\nThe anchor point is specified in the continuous space [0.0, 1.0] x [0.0, 1.0],\nwhere (0, 0) is the top-left corner of the image, and (1, 1) is the bottom-right corner.\nNote this is only for custom annotations not the default pin view.\nDefaults to the center of the view." }, { "name": "onSelected", "required": false, "type": "func", "default": "none", "description": "This callback is fired once this annotation is selected. Returns a Feature as the first param." }, { "name": "onDeselected", "required": false, "type": "func", "default": "none", "description": "This callback is fired once this annotation is deselected." } ], "composes": [ "../utils" ], "name": "PointAnnotation" }, "RasterLayer": { "description": "", "methods": [], "props": [ { "name": "id", "required": false, "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. If the source has not yet been added to the current style, the behavior is undefined." }, { "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" ], "name": "RasterLayer", "styles": [ { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "rasterOpacity", "type": "number", "description": "The opacity at which the image will be drawn.", "requires": [], "disabledBy": [] }, { "name": "rasterHueRotate", "type": "number", "description": "Rotates hues around the color wheel.", "requires": [], "disabledBy": [] }, { "name": "rasterBrightnessMin", "type": "number", "description": "Increase or reduce the brightness of the image. The value is the minimum brightness.", "requires": [], "disabledBy": [] }, { "name": "rasterBrightnessMax", "type": "number", "description": "Increase or reduce the brightness of the image. The value is the maximum brightness.", "requires": [], "disabledBy": [] }, { "name": "rasterSaturation", "type": "number", "description": "Increase or reduce the saturation of the image.", "requires": [], "disabledBy": [] }, { "name": "rasterContrast", "type": "number", "description": "Increase or reduce the contrast of the image.", "requires": [], "disabledBy": [] }, { "name": "rasterFadeDuration", "type": "number", "description": "Fade duration when a new tile is added.", "requires": [], "disabledBy": [] } ] }, "RasterSource": { "description": "RasterSource is a map content source that supplies raster image tiles to be shown on the map.\nThe location of and metadata about the tiles are defined either by an option dictionary\nor by an external file that conforms to the TileJSON specification.", "methods": [], "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": "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": "tileSize", "required": false, "type": "number", "default": "none", "description": "Size of the map tiles.\nMapbox urls default to 256, all others default to 512." }, { "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." } ], "composes": [ "../utils" ], "name": "RasterSource" }, "ShapeSource": { "description": "ShapeSource is a map content source that supplies vector shapes to be shown on the map.\nThe shape may be a url or a GeoJSON object", "methods": [], "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": "An HTTP(S) URL, absolute file URL, or local file URL relative to the current application’s resource bundle." }, { "name": "shape", "required": false, "type": "object", "default": "none", "description": "The contents of the source. A shape can represent a GeoJSON geometry, a feature, or a feature colllection." }, { "name": "cluster", "required": false, "type": "bool", "default": "none", "description": "Enables clustering on the source for point shapes." }, { "name": "clusterRadius", "required": false, "type": "number", "default": "none", "description": "Specifies the radius of each cluster if clustering is enabled.\nA value of 512 produces a radius equal to the width of a tile.\nThe default value is 50." }, { "name": "clusterMaxZoomLevel", "required": false, "type": "number", "default": "none", "description": "Specifies the maximum zoom level at which to cluster points if clustering is enabled.\nDefaults to one zoom level less than the value of maxZoomLevel so that, at the maximum zoom level,\nthe shapes are not clustered." }, { "name": "maxZoomLevel", "required": false, "type": "number", "default": "none", "description": "Specifies the maximum zoom level at which to create vector tiles.\nA greater value produces greater detail at high zoom levels.\nThe default value is 18." }, { "name": "buffer", "required": false, "type": "number", "default": "none", "description": "Specifies the size of the tile buffer on each side.\nA value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.\nLarger values produce fewer rendering artifacts near tile edges and slower performance.\nThe default value is 128." }, { "name": "tolerance", "required": false, "type": "number", "default": "none", "description": "Specifies the Douglas-Peucker simplification tolerance.\nA greater value produces simpler geometries and improves performance.\nThe default value is 0.375." }, { "name": "images", "required": false, "type": "object", "default": "none", "description": "Specifies the external images in key-value pairs required for the shape source.\nIf 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 `{ assets: ['pin'] }`." }, { "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" }, { "name": "hitbox", "required": false, "type": "shape", "default": "none", "description": "Overrides the default touch hitbox(44x44 pixels) for the source layers" } ], "composes": [ "../utils" ], "name": "ShapeSource" }, "SymbolLayer": { "description": "SymbolLayer is a style layer that renders icon and text labels at points or along lines on the map.", "methods": [], "props": [ { "name": "id", "required": false, "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. If the source has not yet been added to the current style, the behavior is undefined." }, { "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" ], "name": "SymbolLayer", "styles": [ { "name": "symbolPlacement", "type": "enum", "description": "Label placement relative to its geometry.", "requires": [], "disabledBy": [] }, { "name": "symbolSpacing", "type": "number", "description": "Distance between two symbol anchors.", "requires": [], "disabledBy": [] }, { "name": "symbolAvoidEdges", "type": "boolean", "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.", "requires": [], "disabledBy": [] }, { "name": "iconAllowOverlap", "type": "boolean", "description": "If true, the icon will be visible even if it collides with other previously drawn symbols.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconIgnorePlacement", "type": "boolean", "description": "If true, other symbols can be visible even if they collide with the icon.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconOptional", "type": "boolean", "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": [] }, { "name": "iconRotationAlignment", "type": "enum", "description": "In combination with `symbolPlacement`, determines the rotation behavior of icons.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconSize", "type": "number", "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": [] }, { "name": "iconTextFit", "type": "enum", "description": "Scales the icon to fit around the associated text.", "requires": [ "iconImage", "textField" ], "disabledBy": [] }, { "name": "iconTextFitPadding", "type": "array", "description": "Size of the additional area added to dimensions determined by `iconTextFit`, in clockwise order: top, right, bottom, left.", "requires": [ "iconImage", "textField" ], "disabledBy": [] }, { "name": "iconImage", "type": "string", "description": "Name of image in sprite to use for drawing an image background. A string with {tokens} replaced, referencing the data property to pull from.", "requires": [], "disabledBy": [] }, { "name": "iconRotate", "type": "number", "description": "Rotates the icon clockwise.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconPadding", "type": "number", "description": "Size of the additional area around the icon bounding box used for detecting symbol collisions.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconKeepUpright", "type": "boolean", "description": "If true, the icon may be flipped to prevent it from being rendered upsideDown.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconOffset", "type": "array", "description": "Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. When combined with `iconRotate` the offset will be as if the rotated direction was up.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "textPitchAlignment", "type": "enum", "description": "Orientation of text when map is pitched.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textRotationAlignment", "type": "enum", "description": "In combination with `symbolPlacement`, determines the rotation behavior of the individual glyphs forming the text.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textField", "type": "string", "description": "Value to use for a text label. Feature properties are specified using tokens like {field_name}. (Token replacement is only supported for literal `textField` valuesNot for property functions.)", "requires": [], "disabledBy": [] }, { "name": "textFont", "type": "array", "description": "Font stack to use for displaying text.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textSize", "type": "number", "description": "Font size.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textMaxWidth", "type": "number", "description": "The maximum line width for text wrapping.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textLineHeight", "type": "number", "description": "Text leading value for multiLine text.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textLetterSpacing", "type": "number", "description": "Text tracking amount.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textJustify", "type": "enum", "description": "Text justification options.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textAnchor", "type": "enum", "description": "Part of the text placed closest to the anchor.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textMaxAngle", "type": "number", "description": "Maximum angle change between adjacent characters.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textRotate", "type": "number", "description": "Rotates the text clockwise.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textPadding", "type": "number", "description": "Size of the additional area around the text bounding box used for detecting symbol collisions.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textKeepUpright", "type": "boolean", "description": "If true, the text may be flipped vertically to prevent it from being rendered upsideDown.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textTransform", "type": "enum", "description": "Specifies how to capitalize text, similar to the CSS `textTransform` property.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textOffset", "type": "array", "description": "Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textAllowOverlap", "type": "boolean", "description": "If true, the text will be visible even if it collides with other previously drawn symbols.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textIgnorePlacement", "type": "boolean", "description": "If true, other symbols can be visible even if they collide with the text.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textOptional", "type": "boolean", "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": [] }, { "name": "visibility", "type": "enum", "description": "Whether this layer is displayed.", "requires": [], "disabledBy": [] }, { "name": "iconOpacity", "type": "number", "description": "The opacity at which the icon will be drawn.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconColor", "type": "color", "description": "The color of the icon. This can only be used with sdf icons.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconHaloColor", "type": "color", "description": "The color of the icon's halo. Icon halos can only be used with SDF icons.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconHaloWidth", "type": "number", "description": "Distance of halo to the icon outline.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconHaloBlur", "type": "number", "description": "Fade out the halo towards the outside.", "requires": [ "iconImage" ], "disabledBy": [] }, { "name": "iconTranslate", "type": "array", "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": [] }, { "name": "iconTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "iconImage", "iconTranslate" ], "disabledBy": [] }, { "name": "textOpacity", "type": "number", "description": "The opacity at which the text will be drawn.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textColor", "type": "color", "description": "The color with which the text will be drawn.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textHaloColor", "type": "color", "description": "The color of the text's halo, which helps it stand out from backgrounds.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textHaloWidth", "type": "number", "description": "Distance of halo to the font outline. Max text halo width is 1/4 of the fontSize.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textHaloBlur", "type": "number", "description": "The halo's fadeout distance towards the outside.", "requires": [ "textField" ], "disabledBy": [] }, { "name": "textTranslate", "type": "array", "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": [] }, { "name": "textTranslateAnchor", "type": "enum", "description": "Controls the translation reference point.", "requires": [ "textField", "textTranslate" ], "disabledBy": [] } ] }, "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.", "methods": [], "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": "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" }, { "name": "hitbox", "required": false, "type": "shape", "default": "none", "description": "Overrides the default touch hitbox(44x44 pixels) for the source layers" } ], "composes": [ "../utils" ], "name": "VectorSource" }, "offlineManager": { "name": "offlineManager", "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": "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": "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": "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 prohibits 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 value at which download status events will be sent over the React Native bridge.\nThese events happening very very fast default is 500ms.", "params": [ { "name": "throttleValue", "description": "event throttle value in ms.", "type": { "name": "Number" }, "optional": false } ], "examples": [ "MapboxGL.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" } } } ] } }