@goongmaps/goong-map-react-native
Version:
A Goong GL react native module for creating custom maps
1,663 lines • 168 kB
JSON
{
"BackgroundLayer": {
"description": "",
"displayName": "BackgroundLayer",
"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": "GoongSDK.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",
"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"
]
}
},
{
"name": "backgroundPattern",
"type": "string",
"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"
]
}
},
{
"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"
]
}
}
]
},
"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"
],
"name": "Callout"
},
"Camera": {
"description": "",
"displayName": "Camera",
"methods": [
{
"name": "fitBounds",
"docblock": "Map camera transitions to fit provided bounds\n\n@example\nthis.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} northEastCoordinates - North east coordinate of bound\n@param {Array<Number>} southWestCoordinates - South west coordinate of bound\n@param {Number=} padding - Camera padding for bound\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
"modifiers": [],
"params": [
{
"name": "northEastCoordinates",
"description": "North east coordinate of bound",
"type": {
"name": "Array",
"elements": [
{
"name": "Number"
}
]
},
"optional": false
},
{
"name": "southWestCoordinates",
"description": "South west coordinate of bound",
"type": {
"name": "Array",
"elements": [
{
"name": "Number"
}
]
},
"optional": false
},
{
"name": "padding",
"description": "Camera padding for bound",
"type": {
"name": "Number"
},
"optional": true
},
{
"name": "animationDuration",
"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.camera.fitBounds([lng, lat], [lng, lat])\nthis.camera.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\nthis.camera.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\nthis.camera.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.camera.flyTo([lng, lat])\nthis.camera.flyTo([lng, lat], 12000)\n\n @param {Array<Number>} coordinates - Coordinates that map camera will jump too\n @param {Number=} animationDuration - Duration of camera animation\n @return {void}",
"modifiers": [],
"params": [
{
"name": "coordinates",
"description": "Coordinates that map camera will jump too",
"type": {
"name": "Array",
"elements": [
{
"name": "Number"
}
]
},
"optional": false
},
{
"name": "animationDuration",
"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.camera.flyTo([lng, lat])\nthis.camera.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.camera.moveTo([lng, lat], 200) // eases camera to new location based on duration\nthis.camera.moveTo([lng, lat]) // snaps camera to new location without any easing\n\n @param {Array<Number>} coordinates - Coordinates that map camera will move too\n @param {Number=} animationDuration - Duration of camera animation\n @return {void}",
"modifiers": [],
"params": [
{
"name": "coordinates",
"description": "Coordinates that map camera will move too",
"type": {
"name": "Array",
"elements": [
{
"name": "Number"
}
]
},
"optional": false
},
{
"name": "animationDuration",
"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.camera.moveTo([lng, lat], 200) // eases camera to new location based on duration\nthis.camera.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.camera.zoomTo(16)\nthis.camera.zoomTo(16, 100)\n\n@param {Number} zoomLevel - Zoom level that the map camera will animate too\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
"modifiers": [],
"params": [
{
"name": "zoomLevel",
"description": "Zoom level that the map camera will animate too",
"type": {
"name": "Number"
},
"optional": false
},
{
"name": "animationDuration",
"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.camera.zoomTo(16)\nthis.camera.zoomTo(16, 100)\n\n"
]
},
{
"name": "setCamera",
"docblock": "Map camera will perform updates based on provided config. Advanced use only!\n\n@example\nthis.camera.setCamera({\n centerCoordinate: [lng, lat],\n zoomLevel: 16,\n animationDuration: 2000,\n})\n\nthis.camera.setCamera({\n stops: [\n { pitch: 45, animationDuration: 200 },\n { heading: 180, animationDuration: 300 },\n ]\n})\n\n @param {Object} config - Camera configuration",
"modifiers": [],
"params": [
{
"name": "config",
"description": "Camera configuration",
"type": {
"name": "Object"
},
"optional": false
}
],
"returns": null,
"description": "Map camera will perform updates based on provided config. Advanced use only!",
"examples": [
"\nthis.camera.setCamera({\n centerCoordinate: [lng, lat],\n zoomLevel: 16,\n animationDuration: 2000,\n})\n\nthis.camera.setCamera({\n stops: [\n { pitch: 45, animationDuration: 200 },\n { heading: 180, animationDuration: 300 },\n ]\n})\n\n "
]
}
],
"props": [
{
"name": "animationDuration",
"required": false,
"type": "number",
"default": "2000",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "animationMode",
"required": false,
"type": "enum",
"default": "'easeTo'",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "defaultSettings",
"required": false,
"type": {
"name": "shape",
"value": [
{
"name": "centerCoordinate",
"required": false,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "Center coordinate on map [lng, lat]"
},
{
"name": "heading",
"required": false,
"type": "number",
"default": "none",
"description": "Heading on map"
},
{
"name": "pitch",
"required": false,
"type": "number",
"default": "none",
"description": "Pitch on map"
},
{
"name": "bounds",
"required": false,
"type": {
"name": "shape",
"value": [
{
"name": "ne",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "northEastCoordinates - North east coordinate of bound"
},
{
"name": "sw",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "southWestCoordinates - North east coordinate of bound"
},
{
"name": "paddingLeft",
"required": false,
"type": "number",
"default": "none",
"description": "Left camera padding for bounds"
},
{
"name": "paddingRight",
"required": false,
"type": "number",
"default": "none",
"description": "Right camera padding for bounds"
},
{
"name": "paddingTop",
"required": false,
"type": "number",
"default": "none",
"description": "Top camera padding for bounds"
},
{
"name": "paddingBottom",
"required": false,
"type": "number",
"default": "none",
"description": "Bottom camera padding for bounds"
}
]
},
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "zoomLevel",
"required": false,
"type": "number",
"default": "none",
"description": "Zoom level of the map"
}
]
},
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "centerCoordinate",
"required": false,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "Center coordinate on map [lng, lat]"
},
{
"name": "heading",
"required": false,
"type": "number",
"default": "none",
"description": "Heading on map"
},
{
"name": "pitch",
"required": false,
"type": "number",
"default": "none",
"description": "Pitch on map"
},
{
"name": "bounds",
"required": false,
"type": {
"name": "shape",
"value": [
{
"name": "ne",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "northEastCoordinates - North east coordinate of bound"
},
{
"name": "sw",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "southWestCoordinates - North east coordinate of bound"
},
{
"name": "paddingLeft",
"required": false,
"type": "number",
"default": "none",
"description": "Left camera padding for bounds"
},
{
"name": "paddingRight",
"required": false,
"type": "number",
"default": "none",
"description": "Right camera padding for bounds"
},
{
"name": "paddingTop",
"required": false,
"type": "number",
"default": "none",
"description": "Top camera padding for bounds"
},
{
"name": "paddingBottom",
"required": false,
"type": "number",
"default": "none",
"description": "Bottom camera padding for bounds"
}
]
},
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "zoomLevel",
"required": false,
"type": "number",
"default": "none",
"description": "Zoom level of the map"
},
{
"name": "minZoomLevel",
"required": false,
"type": "number",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "maxZoomLevel",
"required": false,
"type": "number",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "maxBounds",
"required": false,
"type": {
"name": "shape",
"value": [
{
"name": "ne",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "northEastCoordinates - North east coordinate of bound"
},
{
"name": "sw",
"required": true,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "southWestCoordinates - South west coordinate of bound"
}
]
},
"default": "none",
"description": "Restrict map panning so that the center is within these bounds"
},
{
"name": "followUserLocation",
"required": false,
"type": "bool",
"default": "none",
"description": "Should the map orientation follow the user's."
},
{
"name": "followUserMode",
"required": false,
"type": "enum",
"default": "none",
"description": "The mode used to track the user location on the map. One of; \"normal\", \"compass\", \"course\". Each mode string is also available as a member on the `GoongSDK.UserTrackingModes` object. `Follow` (normal), `FollowWithHeading` (compass), `FollowWithCourse` (course). NOTE: `followUserLocation` must be set to `true` for any of the modes to take effect. [Example](../example/src/examples/SetUserTrackingModes.js)"
},
{
"name": "followZoomLevel",
"required": false,
"type": "number",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "followPitch",
"required": false,
"type": "number",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "followHeading",
"required": false,
"type": "number",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "triggerKey",
"required": false,
"type": "any",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "alignment",
"required": false,
"type": {
"name": "array",
"value": {
"type": "number"
}
},
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "onUserTrackingModeChange",
"required": false,
"type": "func",
"default": "none",
"description": "FIX ME NO DESCRIPTION"
},
{
"name": "isUserInteraction",
"required": false,
"type": "FIX ME UNKNOWN TYPE",
"default": "false",
"description": "FIX ME NO DESCRIPTION"
}
],
"composes": [
"../utils"
],
"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": 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": "GoongSDK.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",
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
},
{
"name": "circleTranslate",
"type": "array<number>",
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
}
]
},
"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": 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": "GoongSDK.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",
"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"
]
}
},
{
"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"
]
}
},
{
"name": "fillExtrusionTranslate",
"type": "array<number>",
"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"
]
}
},
{
"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": "string",
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
}
]
},
"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": 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": "GoongSDK.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",
"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"
]
}
},
{
"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"
]
}
},
{
"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"
]
}
},
{
"name": "fillTranslate",
"type": "array<number>",
"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"
]
}
},
{
"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": "string",
"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"
]
}
}
]
},
"HeatmapLayer": {
"description": "HeatmapLayer is a style layer that renders one or more filled circles on the map.",
"displayName": "HeatmapLayer",
"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": "GoongSDK.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": "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",
"val