From ce5c77cbd63085d2576aa49163809304d8aed067 Mon Sep 17 00:00:00 2001 From: Kilian Finger Date: Fri, 25 Oct 2024 08:46:52 +0200 Subject: [PATCH] docs: generate --- docs/ShapeSource.md | 6 +++--- docs/docs.json | 26 +++++++++++++------------- style-spec/v8.json | 33 ++++++++++++++++++++++++++++++++- 3 files changed, 48 insertions(+), 17 deletions(-) diff --git a/docs/ShapeSource.md b/docs/ShapeSource.md index a8192eb0d..7d63215a9 100644 --- a/docs/ShapeSource.md +++ b/docs/ShapeSource.md @@ -50,7 +50,7 @@ Returns the zoom needed to expand the cluster. ##### arguments | Name | Type | Required | Description | | ---- | :--: | :------: | :----------: | -| `feature` | `Feature` | `Yes` | The feature cluster to expand. | +| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. | @@ -66,7 +66,7 @@ Returns the FeatureCollection from the cluster. ##### arguments | Name | Type | Required | Description | | ---- | :--: | :------: | :----------: | -| `feature` | `Feature` | `Yes` | The feature cluster to expand. | +| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. | | `limit` | `number` | `Yes` | The number of points to return. | | `offset` | `number` | `Yes` | The amount of points to skip (for pagination). | @@ -84,7 +84,7 @@ Returns the FeatureCollection from the cluster (on the next zoom level). ##### arguments | Name | Type | Required | Description | | ---- | :--: | :------: | :----------: | -| `feature` | `Feature` | `Yes` | The feature cluster to expand. | +| `feature` | `GeoJSON.Feature` | `Yes` | The feature cluster to expand. | diff --git a/docs/docs.json b/docs/docs.json index d2c0d5aa6..7f689779b 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -3078,7 +3078,7 @@ "methods": [ { "name": "features", - "docblock": "Returns all features from the source that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map.\n\n@example\nshapeSource.features()\n\n@param {Array=} filter - an optional filter statement to filter the returned Features.\n@return {FeatureCollection}", + "docblock": "Returns all features from the source that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map.\n\n@example\nshapeSource.features()\n\n@param {Array=} filter - an optional filter statement to filter the returned Features.\n@return {GeoJSON.FeatureCollection}", "modifiers": [ "async" ], @@ -3098,10 +3098,10 @@ "name": "Promise", "elements": [ { - "name": "FeatureCollection" + "name": "GeoJSON.FeatureCollection" } ], - "raw": "Promise" + "raw": "Promise" } }, "description": "Returns all features from the source that match the query parameters regardless of whether or not the feature is\ncurrently rendered on the map.", @@ -3111,7 +3111,7 @@ }, { "name": "getClusterExpansionZoom", - "docblock": "Returns the zoom needed to expand the cluster.\n\n@example\nconst zoom = await shapeSource.getClusterExpansionZoom(clusterId);\n\n@param {Feature} feature - The feature cluster to expand.\n@return {number}", + "docblock": "Returns the zoom needed to expand the cluster.\n\n@example\nconst zoom = await shapeSource.getClusterExpansionZoom(clusterId);\n\n@param {GeoJSON.Feature} feature - The feature cluster to expand.\n@return {number}", "modifiers": [ "async" ], @@ -3120,7 +3120,7 @@ "name": "feature", "description": "The feature cluster to expand.", "type": { - "name": "Feature" + "name": "GeoJSON.Feature" }, "optional": false } @@ -3144,7 +3144,7 @@ }, { "name": "getClusterLeaves", - "docblock": "Returns the FeatureCollection from the cluster.\n\n@example\nconst collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);\n\n@param {Feature} feature - The feature cluster to expand.\n@param {number} limit - The number of points to return.\n@param {number} offset - The amount of points to skip (for pagination).\n@return {FeatureCollection}", + "docblock": "Returns the FeatureCollection from the cluster.\n\n@example\nconst collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);\n\n@param {GeoJSON.Feature} feature - The feature cluster to expand.\n@param {number} limit - The number of points to return.\n@param {number} offset - The amount of points to skip (for pagination).\n@return {GeoJSON.FeatureCollection}", "modifiers": [ "async" ], @@ -3153,7 +3153,7 @@ "name": "feature", "description": "The feature cluster to expand.", "type": { - "name": "Feature" + "name": "GeoJSON.Feature" }, "optional": false }, @@ -3180,10 +3180,10 @@ "name": "Promise", "elements": [ { - "name": "FeatureCollection" + "name": "GeoJSON.FeatureCollection" } ], - "raw": "Promise" + "raw": "Promise" } }, "description": "Returns the FeatureCollection from the cluster.", @@ -3193,7 +3193,7 @@ }, { "name": "getClusterChildren", - "docblock": "Returns the FeatureCollection from the cluster (on the next zoom level).\n\n@example\nconst collection = await shapeSource.getClusterChildren(clusterId);\n\n@param {Feature} feature - The feature cluster to expand.\n@return {FeatureCollection}", + "docblock": "Returns the FeatureCollection from the cluster (on the next zoom level).\n\n@example\nconst collection = await shapeSource.getClusterChildren(clusterId);\n\n@param {GeoJSON.Feature} feature - The feature cluster to expand.\n@return {GeoJSON.FeatureCollection}", "modifiers": [ "async" ], @@ -3202,7 +3202,7 @@ "name": "feature", "description": "The feature cluster to expand.", "type": { - "name": "Feature" + "name": "GeoJSON.Feature" }, "optional": false } @@ -3213,10 +3213,10 @@ "name": "Promise", "elements": [ { - "name": "FeatureCollection" + "name": "GeoJSON.FeatureCollection" } ], - "raw": "Promise" + "raw": "Promise" } }, "description": "Returns the FeatureCollection from the cluster (on the next zoom level).", diff --git a/style-spec/v8.json b/style-spec/v8.json index ea64a9a19..20986b9ea 100644 --- a/style-spec/v8.json +++ b/style-spec/v8.json @@ -52,7 +52,38 @@ "default": 0, "units": "degrees", "doc": "Default pitch, in degrees. Zero is perpendicular to the surface, for a look straight down at the map, while a greater value like 60 looks ahead towards the horizon. The style pitch will be used only if the map has not been positioned by other means (e.g. map options or user interaction).", - "example": 50 + "example": 50, + "sdk-support": { + "0-60 degrees": { + "js": "0.8.0", + "android": "1.0.0", + "ios": "1.0.0" + }, + "0-85 degrees": { + "js": "2.0.0", + "android": "https://github.com/maplibre/maplibre-native/issues/1909", + "ios": "https://github.com/maplibre/maplibre-native/issues/1909" + }, + "0-180 degrees": { + "js": "5.0.0", + "android": "https://github.com/maplibre/maplibre-native/issues/1909", + "ios": "https://github.com/maplibre/maplibre-native/issues/1909" + } + } + }, + "roll": { + "type": "number", + "default": 0, + "units": "degrees", + "doc": "Default roll, in degrees. The roll angle is measured counterclockwise about the camera boresight. The style roll will be used only if the map has not been positioned by other means (e.g. map options or user interaction).", + "example": 45, + "sdk-support": { + "basic functionality": { + "js": "5.0.0", + "android": "https://github.com/maplibre/maplibre-native/issues/2941", + "ios": "https://github.com/maplibre/maplibre-native/issues/2941" + } + } }, "light": { "type": "light",