|
| 1 | +# Mapbox Scale Bar Plugin |
| 2 | + |
| 3 | +The scale bar plugin adds a responsive scale bar on top of the map. The scale bar gives a visual indication of how far various map features are from one another at a certain zoom level. The scale bar can be customized with options such as the text color/size, referesh interval, margins, and border width. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +To use the scale bar plugin, you include it in your `build.gradle` file. |
| 10 | + |
| 11 | +``` |
| 12 | +// In the root build.gradle file |
| 13 | +repositories { |
| 14 | + mavenCentral() |
| 15 | +} |
| 16 | +
|
| 17 | +... |
| 18 | +
|
| 19 | +// In the app build.gradle file |
| 20 | +dependencies { |
| 21 | + implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-scalebar-v8:0.1.0' |
| 22 | +} |
| 23 | +``` |
| 24 | + |
| 25 | +The scale bar plugin is published to Maven Central and nightly SNAPSHOTs are available on Sonatype: |
| 26 | + |
| 27 | +``` |
| 28 | +// In the root build.gradle file |
| 29 | +repositories { |
| 30 | + mavenCentral() |
| 31 | + maven { url "http://oss.sonatype.org/content/repositories/snapshots/" } |
| 32 | +} |
| 33 | +
|
| 34 | +... |
| 35 | +
|
| 36 | +// In the app build.gradle file |
| 37 | +dependencies { |
| 38 | + implementation 'com.mapbox.mapboxsdk:mapbox-android-plugin-scalebar-v8:0.2.0-SNAPSHOT' |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +## Scale bar plugin examples |
| 43 | + |
| 44 | +- [In this repo's test app](https://github.com/mapbox/mapbox-plugins-android/blob/master/app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/activity/scalebar/ScalebarActivity.kt) |
| 45 | + |
| 46 | +## Help and Usage |
| 47 | + |
| 48 | +This repository includes an app that shows how to use each plugins in this repository. [Check out its code](https://github.com/mapbox/mapbox-plugins-android/tree/master/app/src/main/java/com/mapbox/mapboxsdk/plugins/testapp/activity) for ready-to-use snippets. |
| 49 | + |
| 50 | +Plugins are easy to use. A plugin is simply a library module built on top of the Mapbox Maps SDK for Android. Currently, we are not requiring plugins to register themselves or to implement any specific interfaces so that they're simple to consume. |
| 51 | + |
| 52 | +We'd love to [hear your feedback](https://github.com/mapbox/mapbox-plugins-android/issues) as we build more plugins and learn how you use them. |
| 53 | + |
| 54 | +## Why Plugins |
| 55 | + |
| 56 | +Splitting specific functionality into plugins makes our Maps SDK lighter and nimble for you to use, and it also lets us iterate faster. We can release plugins more often than the SDK, which requires a slower pace due to its larger codebase. |
| 57 | + |
| 58 | +The Mapbox Android team creates plugins but this plugins repository is an open-source project similar to the various Mapbox SDKs for Android. |
| 59 | +Plugins' lightweight nature makes them much easier for you and anyone else to contribute rather than trying to add the same feature to the more robust Maps SDK. The Mapbox team can also more easily accept contributed plugins and keep the plugin list growing. |
| 60 | + |
| 61 | +## Contributing |
| 62 | + |
| 63 | +We welcome contributions to this plugin repository! |
| 64 | + |
| 65 | +If you're interested in building and sharing your own plugin, please read [the contribution guide](https://github.com/mapbox/mapbox-plugins-android/blob/master/CONTRIBUTING.md) to learn how to get started. |
0 commit comments