iOS SDK
Tutorials
API Reference
- MGLTileCoordinateSystem
- MGLComputedShapeSource
- MGLSphericalPosition
- MGLUserLocationAnnotationViewStyle
- MGLDistanceFormatter
- MGLStyleLayer
- MGLMapDebugMaskOptions
- MGLSymbolZOrder
- MGLShape
- MGLLineTranslationAnchor
- MGLMultiPoint
- MGLOfflinePack
- Style Primitives
- MGLMultiPolyline
- MGLTextAnchor
- Primitive Shapes
- MGLIconTranslationAnchor
- NSValue(MGLFillStyleLayerAdditions)
- MGLAnnotation
- NSExpression(MGLAdditions)
- MGLTextJustification
- MGLUserLocationAnnotationView
- MGLMultiPolygon
- MGLCircleStyleLayer
- MGLCoordinateSpan
- MGLNetworkConfiguration
- MGLTextWritingMode
- Other Enumerations
- MGLUserLocation
- MGLCalloutView
- MGLAttributedExpression
- MGLImageSource
- MGLOfflinePackProgress
- MGLIconAnchor
- MGLFillStyleLayer
- MGLFillTranslationAnchor
- Appendices
- MGLOfflinePackProgress
- MGLComputedShapeSourceDataSource
- NSValue(MGLLineStyleLayerAdditions)
- MGLStylable
- MGLRasterResamplingMode
- Geometry
- MGLPolygon
- Location Updates
- MGLClockDirectionFormatter
- NSValue(MGLFillExtrusionStyleLayerAdditions)
- MGLCoordinateSpan
- MGLCluster
- MGLErrorCode
- MGLAccountManager
- MGLForegroundStyleLayer
- MGLRasterTileSource
- MGLTextPitchAlignment
- MGLResourceKind
- MGLMapSnapshotterDelegate
- MGLAnnotationImage
- MGLHillshadeStyleLayer
- MGLOrnamentPosition
- MGLAnnotationViewDragState
- MGLDEMEncoding
- MGLSource
- MGLIconPitchAlignment
- MGLCalloutViewDelegate
- MGLVectorStyleLayer
- MGLRasterStyleLayer
- MGLLoggingConfiguration
- MGLLightAnchor
- Other Categories
- MGLTransition
- MGLLocationManager
- MGLLoggingLevel
- MGLTextTranslationAnchor
- MGLCompassButton
- MGLShapeSource
- NSValue(MGLRasterStyleLayerAdditions)
- MGLAnnotationVerticalAlignment
- MGLPolyline
- Maps
- MGLMapCamera
- MGLOfflineStorage
- Other Type Definitions
- MGLSphericalPosition
- MGLShapeCollection
- NSValue(MGLAdditions)
- Style Content
- MGLSymbolPlacement
- MGLTransition
- Other Classes
- MGLPointCollection
- MGLMapViewDelegate
- Style Layers
- MGLMapSnapshotOverlay
- MGLCoordinateQuad
- MGLTextTransform
- MGLOverlay
- MGLUserTrackingMode
- MGLTileSource
- MGLHillshadeIlluminationAnchor
- MGLTextRotationAlignment
- NSValue(MGLHillshadeStyleLayerAdditions)
- MGLOfflinePackState
- Formatters
- MGLLocationManagerDelegate
- MGLAttributionInfoStyle
- MGLBackgroundStyleLayer
- Styling the Map
- MGLCoordinateBounds
- MGLFillExtrusionTranslationAnchor
- Offline Maps
- MGLCoordinateFormatter
- MGLOrnamentVisibility
- MGLStyle
- MGLFeature
- MGLOfflineRegion
- MGLMapView
- MGLShapeOfflineRegion
- Other Structures
- MGLCirclePitchAlignment
- NSValue(MGLCircleStyleLayerAdditions)
- MGLMapSnapshot
- MGLFillExtrusionStyleLayer
- MGLCoordinateQuad
- MGLMapSnapshotOptions
- Other Protocols
- MGLLineCap
- MGLSymbolStyleLayer
- Other Functions
- MGLCircleTranslationAnchor
- MGLLineJoin
- MGLAnnotationView
- MGLCircleScaleAlignment
- MGLPointAnnotation
- MGLMapSnapshotter
- MGLLineStyleLayer
- MGLAttributionInfo
- MGLCompassDirectionFormatter
- MGLCoordinateBounds
- MGLTilePyramidOfflineRegion
- MGLIconRotationAlignment
- MGLIconTextFit
- Other Constants
- NSValue(MGLSymbolStyleLayerAdditions)
- Annotations
- MGLLight
- MGLHeatmapStyleLayer
- MGLOfflineStorageDelegate
- MGLVectorTileSource
- User Interaction
On This Page
MGLCompassDirectionFormatter
@interface MGLCompassDirectionFormatter : NSFormatter
The MGLCompassDirectionFormatter
class provides properly formatted descriptions of absolute headings. For example, a value of 90
may be formatted as “east”, depending on the locale.
Use this class to create localized heading strings when displaying directions irrespective of the user’s current location. To format a direction relative to the user’s current location, use MGLClockDirectionFormatter
instead.
unitStyle
The unit style used by this formatter.
This property defaults to NSFormattingUnitStyleMedium
.
Declaration
Objective-C
@property (nonatomic, assign, unsafe_unretained, readwrite)
NSFormattingUnitStyle unitStyle;
Swift
var unitStyle: Formatter.UnitStyle { get set }
-stringFromDirection:
Returns a heading string for the provided value.
Declaration
Objective-C
- (nonnull NSString *)stringFromDirection:(CLLocationDirection)direction;
Swift
func string(fromDirection direction: CLLocationDirection) -> String
Parameters
direction
The heading, measured in degrees, where 0° means “due north” and 90° means “due east”.
Return Value
The heading string appropriately formatted for the formatter’s locale.
-getObjectValue:forString:errorDescription:
This method is not supported for the MGLDirectionFormatter
class.
Declaration
Objective-C
- (BOOL)getObjectValue:(out id _Nullable *_Nullable)obj
forString:(nonnull NSString *)string
errorDescription:(out NSString *_Nullable *_Nullable)error;
Swift
func getObjectValue(_ obj: AutoreleasingUnsafeMutablePointer<AnyObject?>?, for string: String, errorDescription error: AutoreleasingUnsafeMutablePointer<NSString?>?) -> Bool