[ios] Document how scale bar visibility is determined (#15304)

* [ios] document scale bar visibility

* [ios] finished trailing sentence
This commit is contained in:
Jordan Kiley
2019-08-05 10:48:54 -07:00
committed by GitHub
parent 8103a2b028
commit acfcd5c29c

View File

@@ -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;