+ +### π₯ Future of this repo: participate in the [discussion thread](https://github.com/react-native-mapbox-gl/maps/discussions/1680) π₯ + + +## Call for additional maintainers +Hey you, yes _you_! +Do you like this repo, are you using it (are you using it for production apps?! It's cool, we do too!)? + +If you have some time to spare, we'd love to get your help! +I hear you ask "**Yes, _YES_, but How?!**" (in deafening silence), +well...here are some examples: +* check our docs (still up to date? need some edits?) +* review issue tickets and reply with helpful answers +* join the Gitter chat and engage with other users +* review PRs and comment on things you notice +* actively help move the project forward by submitting PRs that introduce fixes and features + +You don't need to be a full-fledged maintainer to do those things, however, +if you are interested in becoming one, don't hesitate to reply in [this discussion](https://github.com/react-native-mapbox-gl/maps/discussions/1551). + +Thanks π + +
+ +--- + +
+ # Mapbox Maps SDK for React Native -_An unofficial React Native library for building maps with the [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) and [Mapbox Maps SDK for Android](https://www.mapbox.com/android-sdk/)_ +_An unofficial React Native library for building maps with +the [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) and [Mapbox Maps SDK for Android](https://www.mapbox.com/android-sdk/)_ -[](https://badge.fury.io/js/%40react-native-mapbox-gl%2Fmaps) - -[](https://depfu.com/github/react-native-mapbox-gl/maps?project_id=8248) -## Installation -### Prerequisit -On Android we support from version 6 (API 23) upwards +We also support [MapLibre](https://github.com/maplibre/maplibre-gl-native) flavors of Mapbox SDKs now π + + +--- + + +[](https://badge.fury.io/js/%40react-native-mapbox-gl%2Fmaps) +[](https://github.com/react-native-mapbox-gl/maps/actions/workflows/android-actions.yml) +[](https://github.com/react-native-mapbox-gl/maps/actions/workflows/ios-actions.yml) + +--- + +
+ +
+
+
+## Prerequisite
+1. On Android we support from version 6 (API 23) upwards
+2. Please [Sign Up to Mapbox](https://account.mapbox.com/auth/signup/) to get the Mapbox Access Token.
-### Dependencies
+
+## Dependencies
- [node](https://nodejs.org)
- [npm](https://www.npmjs.com/)
- [React Native](https://facebook.github.io/react-native/) (0.60+)
-### Git
-```
-git clone git@github.com:react-native-mapbox-gl/maps.git
-cd maps
-```
+## Installation
-### Yarn
+### Step 1 - Install Package:
-```
+```sh
+# install with Yarn
yarn add @react-native-mapbox-gl/maps
-```
-### Npm
-```
+# or install with NPM
npm install @react-native-mapbox-gl/maps --save
```
-## Installation Guides
+### Step 2 - Installation Guides:
- [Android](/android/install.md)
- [iOS](/ios/install.md)
+- [Expo](/plugin/install.md)
- [Example](/example)
-## [Getting Started](/docs/GettingStarted.md)
+
+### Getting Started
+For more information, check out our [Getting Started](/docs/GettingStarted.md) section
+
+## Run Project
+Before you run your project be sure you have completeded the Installation Guides for Android or iOS.
+
+### Run iOS Simulator
+```sh
+# Run with yarn
+yarn run ios
+
+# or Run with NPM
+npm run ios
+```
+
+### Run Android Emulator
+```sh
+# Run with yarn
+yarn run android
+
+# or Run with NPM
+npm run android
+```
+
+## Adding a map
+
+```js
+import React, { Component } from 'react';
+import { StyleSheet, View } from 'react-native';
+import MapboxGL from '@react-native-mapbox-gl/maps';
+
+MapboxGL.setAccessToken('+ +--- + +
+ +## Mapbox Maps SDK (pre v10) + +We've set up default Mapbox dependencies for you. +Feel free to check em out [here](https://github.com/react-native-mapbox-gl/maps/blob/eca4858744cab134b06ae455bcdacc63233318a5/android/rctmgl/build.gradle#L55-L76) + +However, it is also possible to set a custom version of the [Mapbox SDK](https://github.com/mapbox/mapbox-gl-native-android) +Which will overwrite our defaults. + +Add something like the following to your `android/build.gradle > buildscript > ext` section: + +```groovy +// android/build.gradle + +buildscript { + // ... stuff + ext { + // ... stuff + rnmbglMapboxLibs = { + implementation 'com.mapbox.mapboxsdk:mapbox-android-sdk:9.7.1' + implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:5.8.0' + implementation 'com.mapbox.mapboxsdk:mapbox-sdk-turf:5.8.0' + implementation 'com.mapbox.mapboxsdk:mapbox-android-gestures:0.7.0' + } + + rnmbglMapboxPlugins = { + implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-annotation-v9:0.8.0' + implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-localization-v9:0.14.0' + implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-markerview-v9:0.4.0' + } + // ... more stuff? + } +} +``` + +NOTICE, If you are using newer versions of the SDK, you will need to authorize your download of the Maps SDK via a secret access token with the `DOWNLOADS:READ` scope. +This [guide](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials) explains how to `Configure credentials` and `Configure your secret token`. + +Then under section `allprojects/repositories` add your data: + +```groovy +// android/build.gradle + +allprojects { + repositories { + // ...other repos + maven { + url 'https://api.mapbox.com/downloads/v2/releases/maven' + authentication { + basic(BasicAuthentication) + } + credentials { + // Do not change the username below. + // This should always be `mapbox` (not your username). + username = 'mapbox' + // Use the secret token you stored in gradle.properties as the password + password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: "" + } + } + // ...even more repos? + } +} +``` + +Feel free to check out the `/example` projects [`android/build.gradle`](https://github.com/react-native-mapbox-gl/maps/blob/master/example/android/build.gradle) for inspiration! + +
+ +--- + +
+ +## Using MapLibre + +[MapLibre](https://github.com/maplibre/maplibre-gl-native) is an OSS fork of MapboxGL + +Overwrite mapbox dependecies within your `android/build.gradle > buildscript > ext` section + +```groovy +buildscript { + ext { + // ... + + rnmbglMapboxLibs = { + implementation ("org.maplibre.gl:android-sdk:9.2.1") + implementation ("com.mapbox.mapboxsdk:mapbox-sdk-turf:5.3.0") + } + + rnmbglMapboxPlugins = { + implementation ("com.mapbox.mapboxsdk:mapbox-android-gestures:0.7.0") + implementation ("com.mapbox.mapboxsdk:mapbox-android-plugin-localization-v9:0.12.0") { + exclude group: 'com.mapbox.mapboxsdk', module: 'mapbox-android-sdk' + } + implementation ("com.mapbox.mapboxsdk:mapbox-android-plugin-annotation-v9:0.8.0") { + exclude group: 'com.mapbox.mapboxsdk', module: 'mapbox-android-sdk' + } + implementation ("com.mapbox.mapboxsdk:mapbox-android-plugin-markerview-v9:0.4.0") { + exclude group: 'com.mapbox.mapboxsdk', module: 'mapbox-android-sdk' + } + } + } +} + +allprojects { + repositories { + // ... + maven { + url = "https://dl.bintray.com/maplibre/maplibre-gl-native" + } + } +} +``` + +Feel free to check out the `/example` projects [`android/build.gradle`](https://github.com/react-native-mapbox-gl/maps/blob/master/example/android/build.gradle) for inspiration! diff --git a/android/rctmgl/build.gradle b/android/rctmgl/build.gradle index 14fe2c8a33..362db0b568 100644 --- a/android/rctmgl/build.gradle +++ b/android/rctmgl/build.gradle @@ -28,6 +28,23 @@ android { } } +def customizableDependencies(name, defaultDependencies) { + if (rootProject.ext.has(name)) { + def libs = rootProject.ext.get(name) + if (libs instanceof CharSequence) { + libs.split(';').each { + implementation it + } + } else { + libs.delegate = defaultDependencies.owner.delegate + libs.call() + } + } else { + defaultDependencies.delegate = defaultDependencies.owner.delegate + defaultDependencies.call() + } +} + dependencies { implementation fileTree(dir: 'libs', include: ['*.jar']) @@ -35,13 +52,10 @@ dependencies { implementation "com.facebook.react:react-native:+" // Mapbox SDK - if (rootProject.ext.has('rnmbglMapboxLibs')) { - rootProject.ext.get('rnmbglMapboxLibs').split(';').each { - implementation it - } - } else { + customizableDependencies('rnmbglMapboxLibs') { implementation 'com.mapbox.mapboxsdk:mapbox-sdk-services:5.1.0' implementation 'com.mapbox.mapboxsdk:mapbox-android-sdk:9.1.0' + implementation 'com.mapbox.mapboxsdk:mapbox-android-telemetry:6.1.0' implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-annotation-v9:0.8.0' } @@ -49,14 +63,12 @@ dependencies { implementation "com.android.support:support-vector-drawable:${safeExtGet('supportLibVersion', '28.0.0')}" implementation "com.android.support:support-annotations:${safeExtGet('supportLibVersion', '28.0.0')}" implementation "com.android.support:appcompat-v7:${safeExtGet('supportLibVersion', '28.0.0')}" - implementation "com.squareup.okhttp3:okhttp:${safeExtGet('okhttpVersion', '3.12.1')}" + implementation "com.squareup.okhttp3:okhttp:${safeExtGet('okhttpVersion', '4.9.0')}" + implementation "com.squareup.okhttp3:okhttp-urlconnection:${safeExtGet('okhttpVersion', '4.9.0')}" + // Mapbox plugins - if (rootProject.ext.has('rnmbglMapboxPlugins')) { - rootProject.ext.get('rnmbglMapboxPlugins').split(';').each { - implementation it - } - } else { + customizableDependencies('rnmbglMapboxPlugins') { implementation 'com.mapbox.mapboxsdk:mapbox-android-gestures:0.6.0' implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-localization-v9:0.12.0' implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-markerview-v9:0.4.0' diff --git a/android/rctmgl/src/main/java/com/mapbox/rctmgl/components/annotation/MarkerViewManager.java b/android/rctmgl/src/main/java/com/mapbox/rctmgl/components/annotation/MarkerViewManager.java index 900083a0e3..ed806704c5 100644 --- a/android/rctmgl/src/main/java/com/mapbox/rctmgl/components/annotation/MarkerViewManager.java +++ b/android/rctmgl/src/main/java/com/mapbox/rctmgl/components/annotation/MarkerViewManager.java @@ -8,17 +8,26 @@ import java.util.ArrayList; import java.util.List; +import java.lang.reflect.InvocationTargetException; + /** * Subclass of MarkerViewManager implementing removeViews and restoreViews */ public class MarkerViewManager extends com.mapbox.mapboxsdk.plugins.markerview.MarkerViewManager { private final List
If the source has not yet been added to the current style, the behavior is undefined.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/Camera.md b/docs/Camera.md index 2819b010d0..5a2e245f65 100644 --- a/docs/Camera.md +++ b/docs/Camera.md @@ -5,32 +5,43 @@ ### props | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | +| allowUpdates | `bool` | `true` | `false` | If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true. | | animationDuration | `number` | `2000` | `false` | The duration a camera update takes (in ms) | -| animationMode | `enum` | `'easeTo'` | `false` | The animationstyle when the camara updates. One of; `flyTo`, `easeTo`, `moveTo` | +| animationMode | `enum` | `'easeTo'` | `false` | The animationstyle when the camara updates. One of: `flyTo`, `easeTo`, `linearTo`, `moveTo` | | defaultSettings | `shape` | `none` | `false` | Default view settings applied on camera | | centerCoordinate | `array` | `none` | `false` | Center coordinate on map [lng, lat] | +| padding | `shape` | `none` | `false` | Padding around edges of map in points | +| paddingLeft | `number` | `none` | `false` | Left padding in points | +| paddingRight | `number` | `none` | `false` | Right padding in points | +| paddingTop | `number` | `none` | `false` | Top padding in points | +| paddingBottom | `number` | `none` | `false` | Bottom padding in points | | heading | `number` | `none` | `false` | Heading on map | | pitch | `number` | `none` | `false` | Pitch on map | -| bounds | `shape` | `none` | `false` | Represents a rectangle in geographical coordinates marking the visible area of the map. | +| bounds | `shape` | `none` | `false` | Represents a rectangle in geographical coordinates marking the visible area of the map.
The `bounds.padding*` properties are deprecated; use root `padding` property instead. | | ne | `array` | `none` | `true` | North east coordinate of bound | | sw | `array` | `none` | `true` | South west coordinate of bound | -| paddingLeft | `number` | `none` | `false` | Left camera padding for bounds | -| paddingRight | `number` | `none` | `false` | Right camera padding for bounds | -| paddingTop | `number` | `none` | `false` | Top camera padding for bounds | -| paddingBottom | `number` | `none` | `false` | Bottom camera padding for bounds | -| onUserTrackingModeChange | `func` | `none` | `false` | Callback that is triggered on user tracking mode changes | +| paddingLeft | `number` | `none` | `false` | Left padding in points (deprecated; use root `padding` property instead) | +| paddingRight | `number` | `none` | `false` | Right padding in points (deprecated; use root `padding` property instead) | +| paddingTop | `number` | `none` | `false` | Top padding in points (deprecated; use root `padding` property instead) | +| paddingBottom | `number` | `none` | `false` | Bottom padding in points (deprecated; use root `padding` property instead) | +| onUserTrackingModeChange | `func` | `none` | `false` | Callback that is triggered on user tracking mode changes | | zoomLevel | `number` | `none` | `false` | Zoom level of the map | | centerCoordinate | `array` | `none` | `false` | Center coordinate on map [lng, lat] | +| padding | `shape` | `none` | `false` | Padding around edges of map in points | +| paddingLeft | `number` | `none` | `false` | Left padding in points | +| paddingRight | `number` | `none` | `false` | Right padding in points | +| paddingTop | `number` | `none` | `false` | Top padding in points | +| paddingBottom | `number` | `none` | `false` | Bottom padding in points | | heading | `number` | `none` | `false` | Heading on map | | pitch | `number` | `none` | `false` | Pitch on map | -| bounds | `shape` | `none` | `false` | Represents a rectangle in geographical coordinates marking the visible area of the map. | +| bounds | `shape` | `none` | `false` | Represents a rectangle in geographical coordinates marking the visible area of the map.
The `bounds.padding*` properties are deprecated; use root `padding` property instead. | | ne | `array` | `none` | `true` | North east coordinate of bound | | sw | `array` | `none` | `true` | South west coordinate of bound | -| paddingLeft | `number` | `none` | `false` | Left camera padding for bounds | -| paddingRight | `number` | `none` | `false` | Right camera padding for bounds | -| paddingTop | `number` | `none` | `false` | Top camera padding for bounds | -| paddingBottom | `number` | `none` | `false` | Bottom camera padding for bounds | -| onUserTrackingModeChange | `func` | `none` | `false` | Callback that is triggered on user tracking mode changes | +| paddingLeft | `number` | `none` | `false` | Left padding in points (deprecated; use root `padding` property instead) | +| paddingRight | `number` | `none` | `false` | Right padding in points (deprecated; use root `padding` property instead) | +| paddingTop | `number` | `none` | `false` | Top padding in points (deprecated; use root `padding` property instead) | +| paddingBottom | `number` | `none` | `false` | Bottom padding in points (deprecated; use root `padding` property instead) | +| onUserTrackingModeChange | `func` | `none` | `false` | Callback that is triggered on user tracking mode changes | | zoomLevel | `number` | `none` | `false` | Zoom level of the map | | minZoomLevel | `number` | `none` | `false` | The minimun zoom level of the map | | maxZoomLevel | `number` | `none` | `false` | The maximun zoom level of the map | @@ -43,7 +54,6 @@ | followPitch | `number` | `none` | `false` | The pitch on map while followUserLocation is set to `true` | | followHeading | `number` | `none` | `false` | The heading on map while followUserLocation is set to `true` | | triggerKey | `any` | `none` | `false` | Manually update the camera - helpful for when props did not update, however you still want the camera to move | -| onUserTrackingModeChange | `func` | `none` | `false` | FIX ME NO DESCRIPTION | ### methods #### fitBounds(northEastCoordinates, southWestCoordinates[, padding][, animationDuration]) diff --git a/docs/CircleLayer.md b/docs/CircleLayer.md index 94dec76b4c..872e9f18c3 100644 --- a/docs/CircleLayer.md +++ b/docs/CircleLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property
from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/CustomHttpHeaders.md b/docs/CustomHttpHeaders.md index bc9487c1e1..dda8f7affd 100644 --- a/docs/CustomHttpHeaders.md +++ b/docs/CustomHttpHeaders.md @@ -20,11 +20,10 @@ Suggested location is `[AppDelegate application: didFinishLaunchingWithOptions:] #### Working example (AppDelegate.m) ```obj-c -@implementation AppDelegate - // (1) Include the header file #import "MGLCustomHeaders.h" +@implementation AppDelegate - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { diff --git a/docs/FillExtrusionLayer.md b/docs/FillExtrusionLayer.md index 5b22ffe569..f743d27421 100644 --- a/docs/FillExtrusionLayer.md +++ b/docs/FillExtrusionLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/FillLayer.md b/docs/FillLayer.md index a2b30376e7..bb188d32ee 100644 --- a/docs/FillLayer.md +++ b/docs/FillLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/HeatmapLayer.md b/docs/HeatmapLayer.md index 04c8c1dfd8..7a628d01d2 100644 --- a/docs/HeatmapLayer.md +++ b/docs/HeatmapLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property
from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/LineLayer.md b/docs/LineLayer.md index 206f25b086..c204239c97 100644 --- a/docs/LineLayer.md +++ b/docs/LineLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/Logger.md b/docs/Logger.md new file mode 100644 index 0000000000..c7c5f2fca4 --- /dev/null +++ b/docs/Logger.md @@ -0,0 +1,23 @@ +## Logger +### + +### methods +#### setLogLevel(LogLevel) + +##### arguments +| Name | Type | Required | Description | +| ---- | :--: | :------: | :----------: | +| `LogLevel` | `String` | `Yes` | required level of logging, can be `"error" | "warning" | "info" | "debug" | "verbose"` | + +##### Description +sets the amount of logging + +#### setLogCallback(LogCallback) + +##### arguments +| Name | Type | Required | Description | +| ---- | :--: | :------: | :----------: | +| `LogCallback` | `function` | `Yes` | callback taking a log object `{ message: String, level: LogLevel, tag: String }` as param. If callback return falsy value then default logging will take place. | + +##### Description +overwrite logging - good to mute specific errors/ warnings \ No newline at end of file diff --git a/docs/MapView.md b/docs/MapView.md index 429e7fa564..dabefbb1bb 100644 --- a/docs/MapView.md +++ b/docs/MapView.md @@ -7,7 +7,8 @@ | ---- | :--: | :-----: | :------: | :----------: | | contentInset | `union` | `none` | `false` | The distance from the edges of the map viewβs frame to the edges of the map viewβs logical viewport. | | style | `any` | `none` | `false` | Style for wrapping React Native View | -| styleURL | `string` | `MapboxGL.StyleURL.Street` | `false` | Style URL for map | +| styleURL | `string` | `none` | `false` | Style URL for map - notice, if non is set it _will_ default to `MapboxGL.StyleURL.Street` | +| styleJSON | `string` | `none` | `false` | StyleJSON for map - according to TileJSON specs: https://github.com/mapbox/tilejson-spec | | preferredFramesPerSecond | `number` | `none` | `false` | iOS: The preferred frame rate at which the map view is rendered.
The default value for this property is MGLMapViewPreferredFramesPerSecondDefault,
which will adaptively set the preferred frame rate based on the capability of
the userβs device to maintain a smooth experience. This property can be set to arbitrary integer values.
Android: The maximum frame rate at which the map view is rendered, but it can't excess the ability of device hardware.
This property can be set to arbitrary integer values. | | localizeLabels | `bool` | `false` | `false` | Automatically change the language of the map labels to the systemβs preferred language,
this is not something that can be toggled on/off | | zoomEnabled | `bool` | `none` | `false` | Enable/Disable zoom on the map | @@ -16,8 +17,9 @@ | rotateEnabled | `bool` | `true` | `false` | Enable/Disable rotation on map | | attributionEnabled | `bool` | `true` | `false` | The Mapbox terms of service, which governs the use of Mapbox-hosted vector tiles and styles,
[requires](https://www.mapbox.com/help/how-attribution-works/) these copyright notices to accompany any map that features Mapbox-designed styles, OpenStreetMap data, or other Mapbox data such as satellite or terrain data.
If that applies to this map view, do not hide this view or remove any notices from it.
You are additionally [required](https://www.mapbox.com/help/how-mobile-apps-work/#telemetry) to provide users with the option to disable anonymous usage and location sharing (telemetry).
If this view is hidden, you must implement this setting elsewhere in your app. See our website for [Android](https://www.mapbox.com/android-docs/map-sdk/overview/#telemetry-opt-out) and [iOS](https://www.mapbox.com/ios-sdk/#telemetry_opt_out) for implementation details.
Enable/Disable attribution on map. For iOS you need to add MGLMapboxMetricsEnabledSettingShownInApp=YES
to your Info.plist | | attributionPosition | `union` | `none` | `false` | Adds attribution offset, e.g. `{top: 8, left: 8}` will put attribution button in top-left corner of the map | -| tintColor | `union` | `none` | `false` | MapView's tintColor - ios only
@platform ios | +| tintColor | `union` | `none` | `false` | MapView's tintColor | | logoEnabled | `bool` | `true` | `false` | Enable/Disable the logo on the map. | +| logoPosition | `union` | `none` | `false` | Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map | | compassEnabled | `bool` | `none` | `false` | Enable/Disable the compass from appearing on the map | | compassViewPosition | `number` | `none` | `false` | Change corner of map the compass starts at. 0: TopLeft, 1: TopRight, 2: BottomLeft, 3: BottomRight | | compassViewMargins | `object` | `none` | `false` | Add margins to the compass with x and y values | diff --git a/docs/OfflineManager.md b/docs/OfflineManager.md index 72bdd91bab..539f7dcb3e 100644 --- a/docs/OfflineManager.md +++ b/docs/OfflineManager.md @@ -177,7 +177,7 @@ await MapboxGL.offlineManager.mergeOfflineRegions(path); #### setTileCountLimit(limit) -Sets the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device.
The Mapbox Terms of Service prohibits changing or bypassing this limit without permission from Mapbox. +Sets the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device.
The Mapbox Terms of Service prohibit changing or bypassing this limit without permission from Mapbox. ##### arguments | Name | Type | Required | Description | @@ -193,7 +193,7 @@ MapboxGL.offlineManager.setTileCountLimit(1000); #### setProgressEventThrottle(throttleValue) -Sets the value at which download status events will be sent over the React Native bridge.
These events happening very very fast default is 500ms. +Sets the period at which download status events will be sent over the React Native bridge.
The default is 500ms. ##### arguments | Name | Type | Required | Description | @@ -203,7 +203,7 @@ Sets the value at which download status events will be sent over the React Nativ ```javascript -MapboxGL.setProgressEventThrottle(500); +MapboxGL.offlineManager.setProgressEventThrottle(500); ``` diff --git a/docs/RasterLayer.md b/docs/RasterLayer.md index 3b47172155..321ccea183 100644 --- a/docs/RasterLayer.md +++ b/docs/RasterLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/ShapeSource.md b/docs/ShapeSource.md index 348e595c38..f6e7dbc795 100644 --- a/docs/ShapeSource.md +++ b/docs/ShapeSource.md @@ -14,6 +14,7 @@ | maxZoomLevel | `number` | `none` | `false` | Specifies the maximum zoom level at which to create vector tiles.
A greater value produces greater detail at high zoom levels.
The default value is 18. | | buffer | `number` | `none` | `false` | Specifies the size of the tile buffer on each side.
A value of 0 produces no buffer. A value of 512 produces a buffer as wide as the tile itself.
Larger values produce fewer rendering artifacts near tile edges and slower performance.
The default value is 128. | | tolerance | `number` | `none` | `false` | Specifies the Douglas-Peucker simplification tolerance.
A greater value produces simpler geometries and improves performance.
The default value is 0.375. | +| lineMetrics | `bool` | `none` | `false` | Whether to calculate line distance metrics.
This is required for line layers that specify lineGradient values.
The default value is false. | | onPress | `func` | `none` | `false` | Source press listener, gets called when a user presses one of the children layers only
if that layer has a higher z-index than another source layers | | hitbox | `shape` | `none` | `false` | Overrides the default touch hitbox(44x44 pixels) for the source layers | | width | `number` | `none` | `true` | `width` of hitbox | @@ -36,6 +37,56 @@ shapeSource.features() ``` +#### getClusterExpansionZoom(feature) + +Returns the zoom needed to expand the cluster. + +##### arguments +| Name | Type | Required | Description | +| ---- | :--: | :------: | :----------: | +| `feature` | `Feature` | `Yes` | The feature cluster to expand. | + + + +```javascript +const zoom = await shapeSource.getClusterExpansionZoom(clusterId); +``` + + +#### getClusterLeaves(feature, limit, offset) + +Returns the FeatureCollection from the cluster. + +##### arguments +| Name | Type | Required | Description | +| ---- | :--: | :------: | :----------: | +| `feature` | `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). | + + + +```javascript +const collection = await shapeSource.getClusterLeaves(clusterId, limit, offset); +``` + + +#### getClusterChildren(feature) + +Returns the FeatureCollection from the cluster (on the next zoom level). + +##### arguments +| Name | Type | Required | Description | +| ---- | :--: | :------: | :----------: | +| `feature` | `Feature` | `Yes` | The feature cluster to expand. | + + + +```javascript +const collection = await shapeSource.getClusterChildren(clusterId); +``` + + #### onPress(event) diff --git a/docs/StyleSheet.md b/docs/StyleSheet.md index 7ce2fe0587..4d54c76094 100644 --- a/docs/StyleSheet.md +++ b/docs/StyleSheet.md @@ -228,7 +228,7 @@ const layerStyles = { circleColor: [ 'interpolate', ['exponential', 1.5], - ['get' 'point_count'], + ['get','point_count'], 25, 'yellow', 50, 'red', 75, 'blue', @@ -240,7 +240,7 @@ const layerStyles = { circleRadius: [ 'interpolate', ['exponential', 1.5], - ['get' 'point_count'], + ['get','point_count'], [0, 15], [100, 20], [750, 30], diff --git a/docs/SymbolLayer.md b/docs/SymbolLayer.md index 238884bf25..1453c3dd2e 100644 --- a/docs/SymbolLayer.md +++ b/docs/SymbolLayer.md @@ -6,7 +6,7 @@ | Prop | Type | Default | Required | Description | | ---- | :--: | :-----: | :------: | :----------: | | id | `string` | `none` | `true` | A string that uniquely identifies the source in the style to which it is added. | -| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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. | +| sourceID | `string` | `MapboxGL.StyleSource.DefaultSourceID` | `false` | 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.
Inferred from parent source only if the layer is a direct child to it. | | sourceLayerID | `string` | `none` | `false` | Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. | | aboveLayerID | `string` | `none` | `false` | Inserts a layer above aboveLayerID. | | belowLayerID | `string` | `none` | `false` | Inserts a layer below belowLayerID | diff --git a/docs/docs.json b/docs/docs.json index d999b6413b..5cd835867b 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -16,7 +16,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -402,6 +402,13 @@ } ], "props": [ + { + "name": "allowUpdates", + "required": false, + "type": "bool", + "default": "true", + "description": "If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true." + }, { "name": "animationDuration", "required": false, @@ -414,7 +421,7 @@ "required": false, "type": "enum", "default": "'easeTo'", - "description": "The animationstyle when the camara updates. One of; `flyTo`, `easeTo`, `moveTo`" + "description": "The animationstyle when the camara updates. One of: `flyTo`, `easeTo`, `linearTo`, `moveTo`" }, { "name": "defaultSettings", @@ -434,6 +441,45 @@ "default": "none", "description": "Center coordinate on map [lng, lat]" }, + { + "name": "padding", + "required": false, + "type": { + "name": "shape", + "value": [ + { + "name": "paddingLeft", + "required": false, + "type": "number", + "default": "none", + "description": "Left padding in points" + }, + { + "name": "paddingRight", + "required": false, + "type": "number", + "default": "none", + "description": "Right padding in points" + }, + { + "name": "paddingTop", + "required": false, + "type": "number", + "default": "none", + "description": "Top padding in points" + }, + { + "name": "paddingBottom", + "required": false, + "type": "number", + "default": "none", + "description": "Bottom padding in points" + } + ] + }, + "default": "none", + "description": "Padding around edges of map in points" + }, { "name": "heading", "required": false, @@ -483,40 +529,40 @@ "required": false, "type": "number", "default": "none", - "description": "Left camera padding for bounds" + "description": "Left padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingRight", "required": false, "type": "number", "default": "none", - "description": "Right camera padding for bounds" + "description": "Right padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingTop", "required": false, "type": "number", "default": "none", - "description": "Top camera padding for bounds" + "description": "Top padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingBottom", "required": false, "type": "number", "default": "none", - "description": "Bottom camera padding for bounds" - }, - { - "name": "onUserTrackingModeChange", - "required": false, - "type": "func", - "default": "none", - "description": "Callback that is triggered on user tracking mode changes" + "description": "Bottom padding in points (deprecated; use root `padding` property instead)" } ] }, "default": "none", - "description": "Represents a rectangle in geographical coordinates marking the visible area of the map." + "description": "Represents a rectangle in geographical coordinates marking the visible area of the map.\nThe `bounds.padding*` properties are deprecated; use root `padding` property instead." + }, + { + "name": "onUserTrackingModeChange", + "required": false, + "type": "func", + "default": "none", + "description": "Callback that is triggered on user tracking mode changes" }, { "name": "zoomLevel", @@ -542,6 +588,45 @@ "default": "none", "description": "Center coordinate on map [lng, lat]" }, + { + "name": "padding", + "required": false, + "type": { + "name": "shape", + "value": [ + { + "name": "paddingLeft", + "required": false, + "type": "number", + "default": "none", + "description": "Left padding in points" + }, + { + "name": "paddingRight", + "required": false, + "type": "number", + "default": "none", + "description": "Right padding in points" + }, + { + "name": "paddingTop", + "required": false, + "type": "number", + "default": "none", + "description": "Top padding in points" + }, + { + "name": "paddingBottom", + "required": false, + "type": "number", + "default": "none", + "description": "Bottom padding in points" + } + ] + }, + "default": "none", + "description": "Padding around edges of map in points" + }, { "name": "heading", "required": false, @@ -591,40 +676,40 @@ "required": false, "type": "number", "default": "none", - "description": "Left camera padding for bounds" + "description": "Left padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingRight", "required": false, "type": "number", "default": "none", - "description": "Right camera padding for bounds" + "description": "Right padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingTop", "required": false, "type": "number", "default": "none", - "description": "Top camera padding for bounds" + "description": "Top padding in points (deprecated; use root `padding` property instead)" }, { "name": "paddingBottom", "required": false, "type": "number", "default": "none", - "description": "Bottom camera padding for bounds" - }, - { - "name": "onUserTrackingModeChange", - "required": false, - "type": "func", - "default": "none", - "description": "Callback that is triggered on user tracking mode changes" + "description": "Bottom padding in points (deprecated; use root `padding` property instead)" } ] }, "default": "none", - "description": "Represents a rectangle in geographical coordinates marking the visible area of the map." + "description": "Represents a rectangle in geographical coordinates marking the visible area of the map.\nThe `bounds.padding*` properties are deprecated; use root `padding` property instead." + }, + { + "name": "onUserTrackingModeChange", + "required": false, + "type": "func", + "default": "none", + "description": "Callback that is triggered on user tracking mode changes" }, { "name": "zoomLevel", @@ -723,13 +808,6 @@ "type": "any", "default": "none", "description": "Manually update the camera - helpful for when props did not update, however you still want the camera to move" - }, - { - "name": "onUserTrackingModeChange", - "required": false, - "type": "func", - "default": "none", - "description": "FIX ME NO DESCRIPTION" } ], "composes": [ @@ -754,7 +832,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -1095,7 +1173,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -1346,7 +1424,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -1606,7 +1684,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -2005,7 +2083,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -2736,8 +2814,15 @@ "name": "styleURL", "required": false, "type": "string", - "default": "MapboxGL.StyleURL.Street", - "description": "Style URL for map" + "default": "none", + "description": "Style URL for map - notice, if non is set it _will_ default to `MapboxGL.StyleURL.Street`" + }, + { + "name": "styleJSON", + "required": false, + "type": "string", + "default": "none", + "description": "StyleJSON for map - according to TileJSON specs: https://github.com/mapbox/tilejson-spec" }, { "name": "preferredFramesPerSecond", @@ -2800,7 +2885,7 @@ "required": false, "type": "union", "default": "none", - "description": "MapView's tintColor - ios only\n@platform ios" + "description": "MapView's tintColor" }, { "name": "logoEnabled", @@ -2809,6 +2894,13 @@ "default": "true", "description": "Enable/Disable the logo on the map." }, + { + "name": "logoPosition", + "required": false, + "type": "union", + "default": "none", + "description": "Adds logo offset, e.g. `{top: 8, left: 8}` will put the logo in top-left corner of the map" + }, { "name": "compassEnabled", "required": false, @@ -3221,7 +3313,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -3566,6 +3658,103 @@ "\nshapeSource.features()\n\n" ] }, + { + "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}", + "modifiers": [ + "async" + ], + "params": [ + { + "name": "feature", + "description": "The feature cluster to expand.", + "type": { + "name": "Feature" + }, + "optional": false + } + ], + "returns": { + "description": null, + "type": { + "name": "number" + } + }, + "description": "Returns the zoom needed to expand the cluster.", + "examples": [ + "\nconst zoom = await shapeSource.getClusterExpansionZoom(clusterId);\n\n" + ] + }, + { + "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}", + "modifiers": [ + "async" + ], + "params": [ + { + "name": "feature", + "description": "The feature cluster to expand.", + "type": { + "name": "Feature" + }, + "optional": false + }, + { + "name": "limit", + "description": "The number of points to return.", + "type": { + "name": "number" + }, + "optional": false + }, + { + "name": "offset", + "description": "The amount of points to skip (for pagination).", + "type": { + "name": "number" + }, + "optional": false + } + ], + "returns": { + "description": null, + "type": { + "name": "FeatureCollection" + } + }, + "description": "Returns the FeatureCollection from the cluster.", + "examples": [ + "\nconst collection = await shapeSource.getClusterLeaves(clusterId, limit, offset);\n\n" + ] + }, + { + "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}", + "modifiers": [ + "async" + ], + "params": [ + { + "name": "feature", + "description": "The feature cluster to expand.", + "type": { + "name": "Feature" + }, + "optional": false + } + ], + "returns": { + "description": null, + "type": { + "name": "FeatureCollection" + } + }, + "description": "Returns the FeatureCollection from the cluster (on the next zoom level).", + "examples": [ + "\nconst collection = await shapeSource.getClusterChildren(clusterId);\n\n" + ] + }, { "name": "onPress", "docblock": null, @@ -3643,6 +3832,13 @@ "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": "lineMetrics", + "required": false, + "type": "bool", + "default": "none", + "description": "Whether to calculate line distance metrics.\nThis is required for line layers that specify lineGradient values.\nThe default value is false." + }, { "name": "onPress", "required": false, @@ -3756,7 +3952,7 @@ "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." + "description": "The source from which to obtain the data to style.\nIf the source has not yet been added to the current style, the behavior is undefined.\nInferred from parent source only if the layer is a direct child to it." }, { "name": "sourceLayerID", @@ -5759,7 +5955,7 @@ }, { "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.", + "description": "Sets the maximum number of Mapbox-hosted tiles that may be downloaded and stored on the current device.\nThe Mapbox Terms of Service prohibit changing or bypassing this limit without permission from Mapbox.", "params": [ { "name": "limit", @@ -5782,7 +5978,7 @@ }, { "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.", + "description": "Sets the period at which download status events will be sent over the React Native bridge.\nThe default is 500ms.", "params": [ { "name": "throttleValue", @@ -5794,7 +5990,7 @@ } ], "examples": [ - "MapboxGL.setProgressEventThrottle(500);" + "MapboxGL.offlineManager.setProgressEventThrottle(500);" ], "returns": { "description": "", diff --git a/example/.eslintrc.js b/example/.eslintrc.js deleted file mode 100644 index ceb62ef512..0000000000 --- a/example/.eslintrc.js +++ /dev/null @@ -1,138 +0,0 @@ -module.exports = { - root: true, - parser: '@typescript-eslint/parser', - env: { - jest: true, - es6: true, - browser: true, - node: true, - }, - extends: [ - 'plugin:@typescript-eslint/recommended', - 'plugin:react-native/all', - 'prettier', - 'prettier/@typescript-eslint', - "eslint:recommended", - "plugin:react/recommended" - ], - parserOptions: { - ecmaFeatures: { - experimentalObjectRestSpread: true, - jsx: true - }, - project: './tsconfig.json', - sourceType: 'module' - }, - plugins: [ - '@typescript-eslint', - 'react', - 'react-native', - 'import', - 'prettier', - ], - settings: { - "import/resolver": { - "node": { - "extensions": [ - ".js", - ".jsx", - ".ts", - ".tsx" - ] - } - }, - "react": { - "version": "detect", // React version. "detect" automatically picks the version you have installed. - // You can also use `16.0`, `16.3`, etc, if you want to override the detected value. - // default to latest and warns if missing - // It will default to "detect" in the future - }, - }, - rules: { - camelcase: 0, - 'linebreak-style': ['error', 'unix'], - quotes: ['error', 'single'], - semi: ['error', 'always'], - 'global-require': 0, - 'no-underscore-dangle': 0, - 'consistent-return': 0, - 'jsx-quotes': ['error', 'prefer-double'], - 'import/no-extraneous-dependencies': ['error', { packageDir: './' }], - 'import/prefer-default-export': 'off', - 'import/first': 1, - 'import/order': ['error', { groups: ['external', 'internal'] }], - 'import/extensions': [ - 'error', - 'ignorePackages', - { - 'js': 'never', - 'jsx': 'never', - 'ts': 'never', - 'tsx': 'never' - } - ], - 'arrow-body-style': 0, - 'no-plusplus': 0, - 'function-paren-newline': 0, - 'no-unused-expressions': 0, - 'import/no-cycle': 0, - 'no-use-before-define': 0, - 'prefer-promise-reject-errors': 0, - 'comma-dangle': 0, - 'class-methods-use-this': 0, - 'react/display-name': 0, - 'react/prefer-stateless-function': 0, - 'react/destructuring-assignment': 0, - 'react/no-unescaped-entities': 0, - 'react-native/split-platform-components': 0, - 'react-native/no-color-literals': 0, - 'react/jsx-filename-extension': [ - 1, - { extensions: ['.js', '.jsx', '.tsx'] } - ], - 'react/jsx-boolean-value': 0, - 'react/jsx-tag-spacing': [ - 'error', - { - closingSlash: 'never', - beforeSelfClosing: 'always', - afterOpening: 'never' - } - ], - 'react/jsx-props-no-spreading': 0, // we like our speads just fine, thank you very much - 'react/static-property-placement': 0, // we can ignore this - soon to be removed anyways - 'react/jsx-curly-newline': 0, - 'react/state-in-constructor': 0, // it is ok to initialize state as a class prop - 'react/prop-types': 0, - 'react/sort-comp': 0, - 'prettier/prettier': 'error', - 'react/jsx-one-expression-per-line': 0, - '@typescript-eslint/camelcase': 'off', - '@typescript-eslint/explicit-member-accessibility': 'off', - '@typescript-eslint/explicit-function-return-type': 'off', - '@typescript-eslint/no-var-requires': 'off', - '@typescript-eslint/no-explicit-any': 'off', - '@typescript-eslint/no-use-before-define': 'off', - '@typescript-eslint/no-non-null-assertion': 'off', - '@typescript-eslint/explicit-function-return-type': 'off', - '@typescript-eslint/explicit-module-boundary-types': 'off', // donΒ΄t want to type every argument again like getState or dispatch (and many more) - }, - 'overrides': [ - { - // enable the rule specifically for TypeScript files - 'files': ['*.ts', '*.tsx'], - 'rules': { - // turn these one to check where all the return types are missing - // and where arguments of functions are not typed - '@typescript-eslint/explicit-function-return-type': ['error'], - '@typescript-eslint/explicit-module-boundary-types': ['error'] - } - } - ], - globals: { - __DEV__: true, - element: true, - by: true, - waitFor: true // detox e2e - } -}; diff --git a/example/.gitattributes b/example/.gitattributes index d42ff18354..45a3dcb2a2 100644 --- a/example/.gitattributes +++ b/example/.gitattributes @@ -1 +1,3 @@ -*.pbxproj -text +# Windows files should use crlf line endings +# https://help.github.com/articles/dealing-with-line-endings/ +*.bat text eol=crlf diff --git a/example/.gitignore b/example/.gitignore index ad6db8935e..8a4c58b264 100644 --- a/example/.gitignore +++ b/example/.gitignore @@ -2,6 +2,12 @@ # .DS_Store +# MAPBOX token ENVs +# generated on set-up +# +accesstoken +env.json + # Xcode # build/ @@ -29,6 +35,7 @@ build/ .gradle local.properties *.iml +*.hprof # node.js # @@ -59,3 +66,4 @@ buck-out/ # CocoaPods /ios/Pods/ +/ios/Podfile.lock diff --git a/example/.nvmrc b/example/.nvmrc new file mode 100644 index 0000000000..4fe96938e5 --- /dev/null +++ b/example/.nvmrc @@ -0,0 +1,2 @@ +v14.15.0 + diff --git a/example/README.md b/example/README.md index 14feb2b378..ca50e54a41 100644 --- a/example/README.md +++ b/example/README.md @@ -1,5 +1,27 @@ + +
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ + -
+
# React Native Mapbox GL Demo
@@ -8,38 +30,47 @@ Demo Application for [React Native Mapbox GL](../README.md)
*Note:* this app is using [non trivial babel/metro configs](https://github.com/react-native-mapbox-gl/maps/pull/778), so we can consume the `maps` library from parent directory directly. Regular apps don't need this complicated setup.
++ ## What is Mapbox? -Mapbox is the location data platform for mobile and web applications. We provide [building blocks](https://www.mapbox.com/products/) to add location features like maps, search, and navigation into any experience you create. Use our simple and powerful APIs & SDKs and our open source libraries for interactivity and control. +[Mapbox](https://www.mapbox.com/) is the location data platform for mobile and web applications. + +
## Sign up for Mapbox Not a Mapbox user yet? [Sign up for an account here](https://www.mapbox.com/signup/). Once youβre signed in, all you need to start building is a Mapbox access token. Use this same short code with all of our interactive mapping libraries, Python and JavaScript SDKs, and directly against our REST APIs. You can create and manage your access tokens on your [Mapbox Account page](https://www.mapbox.com/account/). +
+ ## Installation * Make sure you are in the example directory ``` cd example ``` -* Create a file called `accesstoken` in the root of the example project and just paste in your [Mapbox access token](https://www.mapbox.com/studio/account/tokens/). (The `accesstoken` file is processed in postinstall, so you need to run `npm install` after adding/changing accesstoken.) +* Create a file called `accesstoken` in the root of the example project and just paste in your [Mapbox access token](https://www.mapbox.com/studio/account/tokens/). (The `accesstoken` file is processed in postinstall, so you need to run `yarn install` after adding/changing accesstoken.) + +* Install our dependencies using `yarn install`. -* Install our dependencies using `npm install`. +
-## Start React Native Packager +## Start React Native Packager (or not, it starts automatically π€·ββοΈ) Open up another tab in your Terminal and run ``` -npm start +yarn start ``` -*Note*: if modules were added to base lib you might need to run `npm start --reset-cache` because we're using `babel` to [rewrite imports](https://github.com/react-native-mapbox-gl/maps/pull/778) +*Note*: if modules were added to base lib you might need to run `yarn start --reset-cache` because we're using `babel` to [rewrite imports](https://github.com/react-native-mapbox-gl/maps/pull/778) -## Run Android Simulator +
+ +## Run Android Emulator * Start Android emulator -* Run `adb reverse tcp:8081 tcp:8081` to forward port to packager(needed for hot reloading, if you're not developing you can skip this step). -* Run `react-native run-android` from `example` directory +* Run `yarn android` from `example` directory **NOTE** @@ -49,12 +80,13 @@ cd android chmod +x gradlew ``` +
+ ## Run iOS Simulator You can run this with the react-native cli or Xcode -* Run `cd ios && pod install && cd ..` from `example` directory to install cocoapods pods -* Run `react-native run-ios` from `example` directory +* Run `yarn ios` from `example` directory **NOTE** diff --git a/example/__tests__/App-test.js b/example/__tests__/App-test.js deleted file mode 100644 index 3d690bae56..0000000000 --- a/example/__tests__/App-test.js +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @format - */ - -import 'react-native'; -import React from 'react'; -import renderer from 'react-test-renderer'; - -import App from '../App'; - -// Note: test renderer must be required after react-native. - -it('renders correctly', () => { - renderer.create(
(coordinates: Position, properties?: P, options?: PositionsOptions): Feature (coordinates: Position, properties?: P, options?: PositionsOptions): Feature (coordinates: Position[], properties?: P, options?: PositionsOptions): Feature
+
+The following is required for every following setup
+
+Add the following to your `ios/Podfile`:
```ruby
- # Mapbox
- pod 'react-native-mapbox-gl', :path => '../node_modules/@react-native-mapbox-gl/maps'
+ pre_install do |installer|
+ $RNMBGL.pre_install(installer)
+ ... other pre install hooks
+ end
+```
+```ruby
+ post_install do |installer|
+ $RNMBGL.post_install(installer)
+ ... other post install hooks
+ end
```
-Then run `pod install` and rebuild your project.
+Running `pod install` will add Mapbox iOS SDK `5.8.0`
+
+```sh
+# Go to the ios folder
+cd ios
+
+# Run Pod Install
+pod install
+```
-## use_frameworks!
+You are good to go!
-Mapbox normally [requires](https://github.com/mapbox/mapbox-gl-native-ios/issues/154) `use_frameworks!` in cocoapods. By default we implement a [workaround](https://github.com/react-native-mapbox-gl/maps/pull/714). In case you need `use_frameworks!` for some reason, you can use the mapbox pod without the workaround with the `DynamicLibrary` subspec:
+Read on if you want to edit your Mapbox version or flavor.
+
+
+## Mapbox Maps SDK
+
+It is possible to set a custom version of the Mapbox SDK:
+
+### New version - since `8.1rc5`
+
+Add the following to you `ios/Podfile`:
```ruby
- # Mapbox
- pod 'react-native-mapbox-gl/DynamicLibrary', :path => '../node_modules/@react-native-mapbox-gl/maps'
+$ReactNativeMapboxGLIOSVersion = '~> 6.1'
+```
+
+Check the current version of the SDK [here](https://docs.mapbox.com/ios/maps/overview/).
+
+### Mapbox Maps SDK > `v6.0.0`
+
+If you are using version `v6.0.0` of the SDK or later, you will need to authorize your download of the Maps SDK with a secret access token with the `DOWNLOADS:READ` scope. This [guide](https://docs.mapbox.com/ios/maps/guides/install/#configure-credentials) explains how to configure the secret token under section `Configure your secret token`.
+
+
- ...
+## Maplibre
- use_frameworks!
+[MapLibre](https://github.com/maplibre/maplibre-gl-native) is an OSS fork of MapboxGL
+Current default MapLibre version is `5.12.0`
+
+If you want to use that, simply add this to your `ios/Podfile`
+
+```ruby
+$RNMBGL_Use_SPM = true
+$RNMGL_USE_MAPLIBRE = true
+```
+
+If you want to adjust/ edit your MapLibre version you can also pass a hash
+
+Example overwrite within your `ios/Podfile`:
+
+```ruby
+$RNMBGL_Use_SPM = {
+ url: "https://github.com/maplibre/maplibre-gl-native-distribution",
+ requirement: {
+ kind: "upToNextMajorVersion",
+ minimumVersion: "5.12.0"
+ },
+ product_name: "Mapbox"
+}
+$RNMGL_USE_MAPLIBRE = true
```
+
+
+## React-Native < `0.60.0`
+
+### Using CocoaPods without autolink
+
+To install with CocoaPods, add the following to your `Podfile`:
+
+```ruby
+ # Mapbox
+ pod 'react-native-mapbox-gl', :path => '../node_modules/@react-native-mapbox-gl/maps'
+
+```
+
+Then run `pod install` and rebuild your project.
diff --git a/javascript/components/BackgroundLayer.js b/javascript/components/BackgroundLayer.js
index 85ad495390..e1cf1cf9aa 100644
--- a/javascript/components/BackgroundLayer.js
+++ b/javascript/components/BackgroundLayer.js
@@ -21,7 +21,9 @@ class BackgroundLayer extends AbstractLayer {
id: PropTypes.string.isRequired,
/**
- * 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.
+ * 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.
+ * Inferred from parent source only if the layer is a direct child to it.
*/
sourceID: PropTypes.string,
diff --git a/javascript/components/Camera.js b/javascript/components/Camera.js
index 91b69d29b7..4dd55ea039 100644
--- a/javascript/components/Camera.js
+++ b/javascript/components/Camera.js
@@ -15,6 +15,31 @@ const SettingsPropTypes = {
*/
centerCoordinate: PropTypes.arrayOf(PropTypes.number),
+ /**
+ * Padding around edges of map in points
+ */
+ padding: PropTypes.shape({
+ /**
+ * Left padding in points
+ */
+ paddingLeft: PropTypes.number,
+
+ /**
+ * Right padding in points
+ */
+ paddingRight: PropTypes.number,
+
+ /**
+ * Top padding in points
+ */
+ paddingTop: PropTypes.number,
+
+ /**
+ * Bottom padding in points
+ */
+ paddingBottom: PropTypes.number,
+ }),
+
/**
* Heading on map
*/
@@ -27,6 +52,7 @@ const SettingsPropTypes = {
/**
* Represents a rectangle in geographical coordinates marking the visible area of the map.
+ * The `bounds.padding*` properties are deprecated; use root `padding` property instead.
*/
bounds: PropTypes.shape({
/**
@@ -40,31 +66,31 @@ const SettingsPropTypes = {
sw: PropTypes.arrayOf(PropTypes.number).isRequired,
/**
- * Left camera padding for bounds
+ * Left padding in points (deprecated; use root `padding` property instead)
*/
paddingLeft: PropTypes.number,
/**
- * Right camera padding for bounds
+ * Right padding in points (deprecated; use root `padding` property instead)
*/
paddingRight: PropTypes.number,
/**
- * Top camera padding for bounds
+ * Top padding in points (deprecated; use root `padding` property instead)
*/
paddingTop: PropTypes.number,
/**
- * Bottom camera padding for bounds
+ * Bottom padding in points (deprecated; use root `padding` property instead)
*/
paddingBottom: PropTypes.number,
-
- /**
- * Callback that is triggered on user tracking mode changes
- */
- onUserTrackingModeChange: PropTypes.func,
}),
+ /**
+ * Callback that is triggered on user tracking mode changes
+ */
+ onUserTrackingModeChange: PropTypes.func,
+
/**
* Zoom level of the map
*/
@@ -75,15 +101,20 @@ class Camera extends React.Component {
static propTypes = {
...viewPropTypes,
+ /**
+ * If false, the camera will not send any props to the native module. Intended to be used to prevent unnecessary tile fetching and improve performance when the map is not visible. Defaults to true.
+ */
+ allowUpdates: PropTypes.bool,
+
/**
* The duration a camera update takes (in ms)
*/
animationDuration: PropTypes.number,
/**
- * The animationstyle when the camara updates. One of; `flyTo`, `easeTo`, `moveTo`
+ * The animationstyle when the camara updates. One of: `flyTo`, `easeTo`, `linearTo`, `moveTo`
*/
- animationMode: PropTypes.oneOf(['flyTo', 'easeTo', 'moveTo']),
+ animationMode: PropTypes.oneOf(['flyTo', 'easeTo', 'linearTo', 'moveTo']),
/**
* Default view settings applied on camera
@@ -153,6 +184,7 @@ class Camera extends React.Component {
};
static defaultProps = {
+ allowUpdates: true,
animationMode: 'easeTo',
animationDuration: 2000,
};
@@ -161,6 +193,7 @@ class Camera extends React.Component {
Flight: 'flyTo',
Move: 'moveTo',
Ease: 'easeTo',
+ Linear: 'linearTo',
};
UNSAFE_componentWillReceiveProps(nextProps) {
@@ -172,47 +205,90 @@ class Camera extends React.Component {
}
_handleCameraChange(currentCamera, nextCamera) {
- const hasCameraChanged = this._hasCameraChanged(currentCamera, nextCamera);
+ const c = currentCamera;
+ const n = nextCamera;
+
+ if (!n.allowUpdates) {
+ return;
+ }
+
+ const hasCameraChanged = this._hasCameraChanged(c, n);
if (!hasCameraChanged) {
return;
}
- if (currentCamera.followUserLocation && !nextCamera.followUserLocation) {
+ if (c.followUserLocation && !n.followUserLocation) {
this.refs.camera.setNativeProps({followUserLocation: false});
return;
}
- if (!currentCamera.followUserLocation && nextCamera.followUserLocation) {
+ if (!c.followUserLocation && n.followUserLocation) {
this.refs.camera.setNativeProps({followUserLocation: true});
}
- if (nextCamera.followUserLocation) {
+ if (n.followUserLocation) {
this.refs.camera.setNativeProps({
- followUserMode: nextCamera.followUserMode,
- followPitch: nextCamera.followPitch || nextCamera.pitch,
- followHeading: nextCamera.followHeading || nextCamera.heading,
- followZoomLevel: nextCamera.followZoomLevel || nextCamera.zoomLevel,
+ followUserMode: n.followUserMode,
+ followPitch: n.followPitch || n.pitch,
+ followHeading: n.followHeading || n.heading,
+ followZoomLevel: n.followZoomLevel || n.zoomLevel,
});
return;
}
+ if (n.maxBounds) {
+ this.refs.camera.setNativeProps({
+ maxBounds: this._getMaxBounds(),
+ });
+ }
+ if (n.minZoomLevel) {
+ this.refs.camera.setNativeProps({
+ minZoomLevel: this.props.minZoomLevel,
+ });
+ }
+ if (n.maxZoomLevel) {
+ this.refs.camera.setNativeProps({
+ maxZoomLevel: this.props.maxZoomLevel,
+ });
+ }
+
const cameraConfig = {
- animationMode: nextCamera.animationMode,
- animationDuration: nextCamera.animationDuration,
- zoomLevel: nextCamera.zoomLevel,
- pitch: nextCamera.pitch,
- heading: nextCamera.heading,
+ bounds: undefined,
+ centerCoordinate: undefined,
+ padding: n.padding,
+ zoomLevel: n.zoomLevel,
+ pitch: n.pitch,
+ heading: n.heading,
+ animationMode: n.animationMode,
+ animationDuration: n.animationDuration,
};
- if (
- nextCamera.bounds &&
- this._hasBoundsChanged(currentCamera, nextCamera)
- ) {
- cameraConfig.bounds = nextCamera.bounds;
- } else {
- cameraConfig.centerCoordinate = nextCamera.centerCoordinate;
+ const boundsChanged = this._hasBoundsChanged(c.bounds, n.bounds);
+ const centerCoordinateChanged = this._hasCenterCoordinateChanged(
+ c.centerCoordinate,
+ n.centerCoordinate,
+ );
+ const paddingChanged = this._hasPaddingChanged(c.padding, n.padding);
+ const zoomChanged = this._hasNumberChanged(c.zoomLevel, n.zoomLevel);
+ const pitchChanged = this._hasNumberChanged(c.pitch, n.pitch);
+ const headingChanged = this._hasNumberChanged(c.heading, n.heading);
+
+ let shouldUpdate = false;
+
+ if (n.bounds && boundsChanged) {
+ cameraConfig.bounds = n.bounds;
+ shouldUpdate = true;
+ } else if (n.centerCoordinate && centerCoordinateChanged) {
+ cameraConfig.centerCoordinate = n.centerCoordinate;
+ shouldUpdate = true;
}
- this._setCamera(cameraConfig);
+ if (paddingChanged || zoomChanged || pitchChanged || headingChanged) {
+ shouldUpdate = true;
+ }
+
+ if (shouldUpdate) {
+ this._setCamera(cameraConfig);
+ }
}
_hasCameraChanged(currentCamera, nextCamera) {
@@ -221,8 +297,12 @@ class Camera extends React.Component {
const hasDefaultPropsChanged =
c.heading !== n.heading ||
- this._hasCenterCoordinateChanged(c, n) ||
- this._hasBoundsChanged(c, n) ||
+ this._hasCenterCoordinateChanged(
+ c.centerCoordinate,
+ n.centerCoordinate,
+ ) ||
+ this._hasBoundsChanged(c.bounds, n.bounds) ||
+ this._hasPaddingChanged(c.padding, n.padding) ||
c.pitch !== n.pitch ||
c.zoomLevel !== n.zoomLevel ||
c.triggerKey !== n.triggerKey;
@@ -238,36 +318,34 @@ class Camera extends React.Component {
c.animationMode !== n.animationMode ||
c.animationDuration !== n.animationDuration;
+ const hasNavigationConstraintsPropsChanged =
+ this._hasBoundsChanged(c.maxBounds, n.maxBounds) ||
+ c.minZoomLevel !== n.minZoomLevel ||
+ c.maxZoomLevel !== n.maxZoomLevel;
+
return (
hasDefaultPropsChanged ||
hasFollowPropsChanged ||
- hasAnimationPropsChanged
+ hasAnimationPropsChanged ||
+ hasNavigationConstraintsPropsChanged
);
}
- _hasCenterCoordinateChanged(currentCamera, nextCamera) {
- const cC = currentCamera.centerCoordinate;
- const nC = nextCamera.centerCoordinate;
+ _hasCenterCoordinateChanged(cC, nC) {
+ if (!cC && !nC) {
+ return false;
+ }
if (existenceChange(cC, nC)) {
return true;
}
- if (!cC && !nC) {
- return false;
- }
-
- const isLngDiff =
- currentCamera.centerCoordinate[0] !== nextCamera.centerCoordinate[0];
- const isLatDiff =
- currentCamera.centerCoordinate[1] !== nextCamera.centerCoordinate[1];
+ const isLngDiff = cC[0] !== nC[0];
+ const isLatDiff = cC[1] !== nC[1];
return isLngDiff || isLatDiff;
}
- _hasBoundsChanged(currentCamera, nextCamera) {
- const cB = currentCamera.bounds;
- const nB = nextCamera.bounds;
-
+ _hasBoundsChanged(cB, nB) {
if (!cB && !nB) {
return false;
}
@@ -288,6 +366,35 @@ class Camera extends React.Component {
);
}
+ _hasPaddingChanged(cP, nP) {
+ if (!cP && !nP) {
+ return false;
+ }
+
+ if (existenceChange(cP, nP)) {
+ return true;
+ }
+
+ return (
+ cP.paddingTop !== nP.paddingTop ||
+ cP.paddingLeft !== nP.paddingLeft ||
+ cP.paddingRight !== nP.paddingRight ||
+ cP.paddingBottom !== nP.paddingBottom
+ );
+ }
+
+ _hasNumberChanged(prev, next) {
+ if (existenceChange(prev, next)) {
+ return true;
+ }
+
+ if (!prev && !next) {
+ return false;
+ }
+
+ return prev !== next;
+ }
+
/**
* Map camera transitions to fit provided bounds
*
@@ -339,8 +446,8 @@ class Camera extends React.Component {
bounds: {
ne: northEastCoordinates,
sw: southWestCoordinates,
- ...pad,
},
+ padding: pad,
animationDuration,
animationMode: Camera.Mode.Ease,
});
@@ -377,7 +484,7 @@ class Camera extends React.Component {
* @return {void}
*/
moveTo(coordinates, animationDuration = 0) {
- return this._setCamera({
+ return this.setCamera({
centerCoordinate: coordinates,
animationDuration,
});
@@ -395,7 +502,7 @@ class Camera extends React.Component {
* @return {void}
*/
zoomTo(zoomLevel, animationDuration = 2000) {
- return this._setCamera({
+ return this.setCamera({
zoomLevel,
animationDuration,
animationMode: Camera.Mode.Flight,
@@ -479,21 +586,19 @@ class Camera extends React.Component {
}
if (config.bounds && config.bounds.ne && config.bounds.sw) {
- const {
- ne,
- sw,
- paddingLeft,
- paddingRight,
- paddingTop,
- paddingBottom,
- } = config.bounds;
+ const {ne, sw} = config.bounds;
stopConfig.bounds = toJSONString(geoUtils.makeLatLngBounds(ne, sw));
- stopConfig.boundsPaddingTop = paddingTop || 0;
- stopConfig.boundsPaddingRight = paddingRight || 0;
- stopConfig.boundsPaddingBottom = paddingBottom || 0;
- stopConfig.boundsPaddingLeft = paddingLeft || 0;
}
+ stopConfig.paddingTop =
+ config.padding?.paddingTop || config.bounds?.paddingTop || 0;
+ stopConfig.paddingRight =
+ config.padding?.paddingRight || config.bounds?.paddingRight || 0;
+ stopConfig.paddingBottom =
+ config.padding?.paddingBottom || config.bounds?.paddingBottom || 0;
+ stopConfig.paddingLeft =
+ config.padding?.paddingLeft || config.bounds?.paddingLeft || 0;
+
return stopConfig;
}
@@ -503,6 +608,8 @@ class Camera extends React.Component {
return MapboxGL.CameraModes.Flight;
case Camera.Mode.Move:
return MapboxGL.CameraModes.None;
+ case Camera.Mode.Linear:
+ return MapboxGL.CameraModes.Linear;
default:
return MapboxGL.CameraModes.Ease;
}
diff --git a/javascript/components/CircleLayer.js b/javascript/components/CircleLayer.js
index 70a8072372..1b414f32ed 100644
--- a/javascript/components/CircleLayer.js
+++ b/javascript/components/CircleLayer.js
@@ -26,6 +26,7 @@ class CircleLayer extends AbstractLayer {
/**
* 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.
+ * Inferred from parent source only if the layer is a direct child to it.
*/
sourceID: PropTypes.string,
diff --git a/javascript/components/FillExtrusionLayer.js b/javascript/components/FillExtrusionLayer.js
index e1532db71f..8f581f50e9 100644
--- a/javascript/components/FillExtrusionLayer.js
+++ b/javascript/components/FillExtrusionLayer.js
@@ -24,7 +24,9 @@ class FillExtrusionLayer extends AbstractLayer {
id: PropTypes.string.isRequired,
/**
- * 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.
+ * 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.
+ * Inferred from parent source only if the layer is a direct child to it.
*/
sourceID: PropTypes.string,
diff --git a/javascript/components/FillLayer.js b/javascript/components/FillLayer.js
index dfc4252325..8750b5e2ab 100644
--- a/javascript/components/FillLayer.js
+++ b/javascript/components/FillLayer.js
@@ -24,7 +24,9 @@ class FillLayer extends AbstractLayer {
id: PropTypes.string.isRequired,
/**
- * 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.
+ * 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.
+ * Inferred from parent source only if the layer is a direct child to it.
*/
sourceID: PropTypes.string,
diff --git a/javascript/components/HeadingIndicator.js b/javascript/components/HeadingIndicator.js
index 9de1d17522..91e6100f0e 100644
--- a/javascript/components/HeadingIndicator.js
+++ b/javascript/components/HeadingIndicator.js
@@ -9,9 +9,10 @@ const style = {
iconImage: headingIcon,
iconAllowOverlap: true,
iconPitchAlignment: 'map',
+ iconRotationAlignment: 'map',
};
-const HeadingIndicator = (heading) => (
+const HeadingIndicator = heading => (