summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Kiley <jmkiley@users.noreply.github.com>2019-08-05 10:48:54 -0700
committerGitHub <noreply@github.com>2019-08-05 10:48:54 -0700
commitacfcd5c29c15e91e3bf80b1503d63caef1487149 (patch)
tree0d93a33bc1672036d98252920cd3f3e234a0e5c6
parent8103a2b028358b747fe0f2d6cce2e32ca1424680 (diff)
downloadqtlocation-mapboxgl-acfcd5c29c15e91e3bf80b1503d63caef1487149.tar.gz
[ios] Document how scale bar visibility is determined (#15304)
* [ios] document scale bar visibility * [ios] finished trailing sentence
-rw-r--r--platform/ios/src/MGLMapView.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/platform/ios/src/MGLMapView.h b/platform/ios/src/MGLMapView.h
index f799852fa7..e6f66e39ae 100644
--- a/platform/ios/src/MGLMapView.h
+++ b/platform/ios/src/MGLMapView.h
@@ -289,9 +289,16 @@ MGL_EXPORT
/**
A Boolean value indicating whether the map may display scale information.
- The scale bar may not be shown at all zoom levels. The view controlled by this
- property is available at `scaleBar`. The default value of this property is
- `NO`.
+ The scale bar may not be shown at all zoom levels. The scale bar becomes visible
+ when the maximum distance visible on the map view is less than 400 miles (800
+ kilometers). The zoom level where this occurs depends on the latitude at the map
+ view’s center coordinate, as well as the device screen width. At latitudes
+ farther from the equator, the scale bar becomes visible at lower zoom levels.
+
+ The unit of measurement is determined by the user's device locale.
+
+ The view controlled by this property is available at `scaleBar`. The default value
+ of this property is `NO`.
*/
@property (nonatomic, assign) BOOL showsScale;