Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: use lower case primitives #579

Merged
merged 1 commit into from
Dec 27, 2024
Merged

docs: use lower case primitives #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/components/Camera.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Map camera will fly to new coordinate
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `coordinates` | `GeoJSON.Position` | `Yes` | Coordinates that map camera will jump to |
| `animationDuration` | `Number` | `No` | Duration of camera animation |
| `animationDuration` | `number` | `No` | Duration of camera animation |



Expand All @@ -74,7 +74,7 @@ Map camera will move to new coordinate at the same zoom level
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `coordinates` | `GeoJSON.Position` | `Yes` | Coordinates that map camera will move too |
| `animationDuration` | `Number` | `No` | Duration of camera animation |
| `animationDuration` | `number` | `No` | Duration of camera animation |



Expand All @@ -92,7 +92,7 @@ Map camera will zoom to specified level
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `zoomLevel` | `number` | `Yes` | Zoom level that the map camera will animate too |
| `animationDuration` | `Number` | `No` | Duration of camera animation |
| `animationDuration` | `number` | `No` | Duration of camera animation |



Expand Down
4 changes: 2 additions & 2 deletions docs/components/MapView.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Takes snapshot of map with current tiles and returns a URI to the image
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `writeToDisk` | `Boolean` | `No` | If true will create a temp file, otherwise it is in base64 |
| `writeToDisk` | `boolean` | `No` | If true will create a temp file, otherwise it is in base64 |


### `getZoom()`
Expand Down Expand Up @@ -153,7 +153,7 @@ Sets the visibility of all the layers referencing the specified `sourceLayerId`
| ---- | :--: | :------: | :----------: |
| `visible` | `boolean` | `Yes` | Visibility of the layers |
| `sourceId` | `string` | `Yes` | Identifier of the target source (e.g. 'composite') |
| `sourceLayerId` | `String` | `No` | Identifier of the target source-layer (e.g. 'building') |
| `sourceLayerId` | `string` | `No` | Identifier of the target source-layer (e.g. 'building') |



Expand Down
42 changes: 21 additions & 21 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@
"methods": [
{
"name": "fitBounds",
"docblock": "Map camera transitions to fit provided bounds\n\n@example\ncameraRef.current?.fitBounds([lng, lat], [lng, lat])\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<Number>} ne - North east coordinate of bound\n@param {Array<Number>} sw - South west coordinate of bound\n@param {Number|Array<Number>|undefined} padding - Padding for the bounds\n@param {Number=} animationDuration - Duration of camera animation\n@return {void}",
"docblock": "Map camera transitions to fit provided bounds\n\n@example\ncameraRef.current?.fitBounds([lng, lat], [lng, lat])\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], 20, 1000) // padding for all sides\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)\ncameraRef.current?.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)\n\n@param {Array<number>} ne - North east coordinate of bound\n@param {Array<number>} sw - South west coordinate of bound\n@param {number|Array<number>|undefined} padding - Padding for the bounds\n@param {number=} animationDuration - Duration of camera animation\n@return {void}",
"modifiers": [],
"params": [
{
Expand Down Expand Up @@ -297,7 +297,7 @@
},
{
"name": "flyTo",
"docblock": "Map camera will fly to new coordinate\n\n@example\ncameraRef.current?.flyTo([lng, lat])\ncameraRef.current?.flyTo([lng, lat], 12000)\n\n @param {Array<Number>} coordinates - Coordinates that map camera will jump to\n @param {Number=} animationDuration - Duration of camera animation\n @return {void}",
"docblock": "Map camera will fly to new coordinate\n\n@example\ncameraRef.current?.flyTo([lng, lat])\ncameraRef.current?.flyTo([lng, lat], 12000)\n\n @param {Array<number>} coordinates - Coordinates that map camera will jump to\n @param {number=} animationDuration - Duration of camera animation\n @return {void}",
"modifiers": [],
"params": [
{
Expand All @@ -312,7 +312,7 @@
"name": "animationDuration",
"description": "Duration of camera animation",
"type": {
"name": "Number"
"name": "number"
},
"optional": true
}
Expand All @@ -329,7 +329,7 @@
},
{
"name": "moveTo",
"docblock": "Map camera will move to new coordinate at the same zoom level\n\n@example\ncameraRef.current?.moveTo([lng, lat], 200) // eases camera to new location based on duration\ncameraRef.current?.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}",
"docblock": "Map camera will move to new coordinate at the same zoom level\n\n@example\ncameraRef.current?.moveTo([lng, lat], 200) // eases camera to new location based on duration\ncameraRef.current?.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": [
{
Expand All @@ -344,7 +344,7 @@
"name": "animationDuration",
"description": "Duration of camera animation",
"type": {
"name": "Number"
"name": "number"
},
"optional": true
}
Expand All @@ -361,7 +361,7 @@
},
{
"name": "zoomTo",
"docblock": "Map camera will zoom to specified level\n\n@example\ncameraRef.current?.zoomTo(16)\ncameraRef.current?.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}",
"docblock": "Map camera will zoom to specified level\n\n@example\ncameraRef.current?.zoomTo(16)\ncameraRef.current?.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": [
{
Expand All @@ -376,7 +376,7 @@
"name": "animationDuration",
"description": "Duration of camera animation",
"type": {
"name": "Number"
"name": "number"
},
"optional": true
}
Expand Down Expand Up @@ -2252,7 +2252,7 @@
},
{
"name": "takeSnap",
"docblock": "Takes snapshot of map with current tiles and returns a URI to the image\n@param {Boolean} writeToDisk If true will create a temp file, otherwise it is in base64\n@return {String}",
"docblock": "Takes snapshot of map with current tiles and returns a URI to the image\n@param {boolean} writeToDisk If true will create a temp file, otherwise it is in base64\n@return {string}",
"modifiers": [
"async"
],
Expand All @@ -2261,7 +2261,7 @@
"name": "writeToDisk",
"description": "If true will create a temp file, otherwise it is in base64",
"type": {
"name": "Boolean"
"name": "boolean"
},
"optional": true
}
Expand All @@ -2282,7 +2282,7 @@
},
{
"name": "getZoom",
"docblock": "Returns the current zoom of the map view.\n\n@example\nconst zoom = await this._map.getZoom();\n\n@return {Number}",
"docblock": "Returns the current zoom of the map view.\n\n@example\nconst zoom = await this._map.getZoom();\n\n@return {number}",
"modifiers": [
"async"
],
Expand All @@ -2305,7 +2305,7 @@
},
{
"name": "getCenter",
"docblock": "Returns the map's geographical centerpoint\n\n@example\nconst center = await this._map.getCenter();\n\n@return {Array<Number>} Coordinates",
"docblock": "Returns the map's geographical centerpoint\n\n@example\nconst center = await this._map.getCenter();\n\n@return {Array<number>} Coordinates",
"modifiers": [
"async"
],
Expand All @@ -2329,7 +2329,7 @@
},
{
"name": "setSourceVisibility",
"docblock": "Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`\n\n@example\nawait this._map.setSourceVisibility(false, 'composite', 'building')\n\n@param {boolean} visible - Visibility of the layers\n@param {String} sourceId - Identifier of the target source (e.g. 'composite')\n@param {String=} sourceLayerId - Identifier of the target source-layer (e.g. 'building')",
"docblock": "Sets the visibility of all the layers referencing the specified `sourceLayerId` and/or `sourceId`\n\n@example\nawait this._map.setSourceVisibility(false, 'composite', 'building')\n\n@param {boolean} visible - Visibility of the layers\n@param {string} sourceId - Identifier of the target source (e.g. 'composite')\n@param {string=} sourceLayerId - Identifier of the target source-layer (e.g. 'building')",
"modifiers": [],
"params": [
{
Expand All @@ -2352,7 +2352,7 @@
"name": "sourceLayerId",
"description": "Identifier of the target source-layer (e.g. 'building')",
"type": {
"name": "String"
"name": "string"
},
"optional": true
}
Expand Down Expand Up @@ -2707,7 +2707,7 @@
"name": "name",
"description": "Name of the offline pack.",
"type": {
"name": "String"
"name": "string"
},
"optional": false
}
Expand All @@ -2730,7 +2730,7 @@
"name": "name",
"description": "Name of the offline pack.",
"type": {
"name": "String"
"name": "string"
},
"optional": false
}
Expand Down Expand Up @@ -2781,7 +2781,7 @@
"name": "size",
"description": "Size of ambient cache.",
"type": {
"name": "Number"
"name": "number"
},
"optional": false
}
Expand Down Expand Up @@ -2832,7 +2832,7 @@
"name": "name",
"description": "Name of the offline pack.",
"type": {
"name": "String"
"name": "string"
},
"optional": false
}
Expand All @@ -2855,7 +2855,7 @@
"name": "path",
"description": "Path to offline tile db on file system.",
"type": {
"name": "String"
"name": "string"
},
"optional": false
}
Expand All @@ -2878,7 +2878,7 @@
"name": "limit",
"description": "Map tile limit count.",
"type": {
"name": "Number"
"name": "number"
},
"optional": false
}
Expand All @@ -2901,7 +2901,7 @@
"name": "throttleValue",
"description": "event throttle value in ms.",
"type": {
"name": "Number"
"name": "number"
},
"optional": false
}
Expand Down Expand Up @@ -2963,7 +2963,7 @@
"name": "packName",
"description": "Name of the offline pack.",
"type": {
"name": "String"
"name": "string"
},
"optional": false
}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/Logger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Sets the amount of logging.

| Name | Type | Required | Description |
| ---------- | :------: | :------: | :----------------------------------------: | --------- | ------ | ------- | ---------- |
| `LogLevel` | `String` | `Yes` | required level of logging, can be `"error" | "warning" | "info" | "debug" | "verbose"` |
| `LogLevel` | `string` | `Yes` | required level of logging, can be `"error" | "warning" | "info" | "debug" | "verbose"` |

### `setLogCallback(LogCallback)`

Expand Down
16 changes: 8 additions & 8 deletions docs/modules/OfflineManager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Invalidates the specified offline pack. This method checks that the tiles in the
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `name` | `String` | `Yes` | Name of the offline pack. |
| `name` | `string` | `Yes` | Name of the offline pack. |



Expand All @@ -55,7 +55,7 @@ Unregisters the given offline pack and allows resources that are no longer requi
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `name` | `String` | `Yes` | Name of the offline pack. |
| `name` | `string` | `Yes` | Name of the offline pack. |



Expand Down Expand Up @@ -95,7 +95,7 @@ Sets the maximum size of the ambient cache in bytes. Disables the ambient cache
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `size` | `Number` | `Yes` | Size of ambient cache. |
| `size` | `number` | `Yes` | Size of ambient cache. |



Expand Down Expand Up @@ -135,7 +135,7 @@ Retrieves an offline pack that is stored in the database by name.
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `name` | `String` | `Yes` | Name of the offline pack. |
| `name` | `string` | `Yes` | Name of the offline pack. |



Expand All @@ -151,7 +151,7 @@ Sideloads offline db
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `path` | `String` | `Yes` | Path to offline tile db on file system. |
| `path` | `string` | `Yes` | Path to offline tile db on file system. |



Expand All @@ -167,7 +167,7 @@ Sets the maximum number of tiles that may be downloaded and stored on the curren
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `limit` | `Number` | `Yes` | Map tile limit count. |
| `limit` | `number` | `Yes` | Map tile limit count. |



Expand All @@ -183,7 +183,7 @@ Sets the period at which download status events will be sent over the React Nati
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `throttleValue` | `Number` | `Yes` | event throttle value in ms. |
| `throttleValue` | `number` | `Yes` | event throttle value in ms. |



Expand Down Expand Up @@ -219,7 +219,7 @@ Unsubscribes any listeners associated with the offline pack.<br/>It's a good ide
#### Arguments
| Name | Type | Required | Description |
| ---- | :--: | :------: | :----------: |
| `packName` | `String` | `Yes` | Name of the offline pack. |
| `packName` | `string` | `Yes` | Name of the offline pack. |



Expand Down
20 changes: 10 additions & 10 deletions src/components/Camera.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,10 +399,10 @@ export const Camera = memo(
* cameraRef.current?.fitBounds([lng, lat], [lng, lat], [verticalPadding, horizontalPadding], 1000)
* cameraRef.current?.fitBounds([lng, lat], [lng, lat], [top, right, bottom, left], 1000)
*
* @param {Array<Number>} ne - North east coordinate of bound
* @param {Array<Number>} sw - South west coordinate of bound
* @param {Number|Array<Number>|undefined} padding - Padding for the bounds
* @param {Number=} animationDuration - Duration of camera animation
* @param {Array<number>} ne - North east coordinate of bound
* @param {Array<number>} sw - South west coordinate of bound
* @param {number|Array<number>|undefined} padding - Padding for the bounds
* @param {number=} animationDuration - Duration of camera animation
* @return {void}
*/
fitBounds,
Expand All @@ -413,8 +413,8 @@ export const Camera = memo(
* cameraRef.current?.flyTo([lng, lat])
* cameraRef.current?.flyTo([lng, lat], 12000)
*
* @param {Array<Number>} coordinates - Coordinates that map camera will jump to
* @param {Number=} animationDuration - Duration of camera animation
* @param {Array<number>} coordinates - Coordinates that map camera will jump to
* @param {number=} animationDuration - Duration of camera animation
* @return {void}
*/
flyTo,
Expand All @@ -425,8 +425,8 @@ export const Camera = memo(
* cameraRef.current?.moveTo([lng, lat], 200) // eases camera to new location based on duration
* cameraRef.current?.moveTo([lng, lat]) // snaps camera to new location without any easing
*
* @param {Array<Number>} coordinates - Coordinates that map camera will move too
* @param {Number=} animationDuration - Duration of camera animation
* @param {Array<number>} coordinates - Coordinates that map camera will move too
* @param {number=} animationDuration - Duration of camera animation
* @return {void}
*/
moveTo,
Expand All @@ -437,8 +437,8 @@ export const Camera = memo(
* cameraRef.current?.zoomTo(16)
* cameraRef.current?.zoomTo(16, 100)
*
* @param {Number} zoomLevel - Zoom level that the map camera will animate too
* @param {Number=} animationDuration - Duration of camera animation
* @param {number} zoomLevel - Zoom level that the map camera will animate too
* @param {number=} animationDuration - Duration of camera animation
* @return {void}
*/
zoomTo,
Expand Down
Loading
Loading