Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit acfcd5c

Browse files
authored
[ios] Document how scale bar visibility is determined (#15304)
* [ios] document scale bar visibility * [ios] finished trailing sentence
1 parent 8103a2b commit acfcd5c

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

platform/ios/src/MGLMapView.h

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,16 @@ MGL_EXPORT
289289
/**
290290
A Boolean value indicating whether the map may display scale information.
291291
292-
The scale bar may not be shown at all zoom levels. The view controlled by this
293-
property is available at `scaleBar`. The default value of this property is
294-
`NO`.
292+
The scale bar may not be shown at all zoom levels. The scale bar becomes visible
293+
when the maximum distance visible on the map view is less than 400 miles (800
294+
kilometers). The zoom level where this occurs depends on the latitude at the map
295+
view’s center coordinate, as well as the device screen width. At latitudes
296+
farther from the equator, the scale bar becomes visible at lower zoom levels.
297+
298+
The unit of measurement is determined by the user's device locale.
299+
300+
The view controlled by this property is available at `scaleBar`. The default value
301+
of this property is `NO`.
295302
*/
296303
@property (nonatomic, assign) BOOL showsScale;
297304

0 commit comments

Comments
 (0)