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

Commit

Permalink
[ios] Document how scale bar visibility is determined (#15304)
Browse files Browse the repository at this point in the history
* [ios] document scale bar visibility

* [ios] finished trailing sentence
  • Loading branch information
jmkiley authored Aug 5, 2019
1 parent 8103a2b commit acfcd5c
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions platform/ios/src/MGLMapView.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down

0 comments on commit acfcd5c

Please sign in to comment.