iOS SDK

API Reference

On This Page

NSValue(MGLAdditions)

@interface NSValue (MGLAdditions)

Methods for round-tripping values for Mapbox-defined types.

Working with Geographic Coordinate Values

+valueWithMGLCoordinate:

Creates a new value object containing the specified Core Location geographic coordinate structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLCoordinate:
(CLLocationCoordinate2D)coordinate;

Swift

convenience init(mglCoordinate coordinate: CLLocationCoordinate2D)

Parameters

coordinate

The value for the new object.

Return Value

A new value object that contains the geographic coordinate information.

MGLCoordinateValue

The Core Location geographic coordinate structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) CLLocationCoordinate2D MGLCoordinateValue;

Swift

var mglCoordinateValue: CLLocationCoordinate2D { get }

+valueWithMGLMapPoint:

Creates a new value object containing the specified Mapbox map point structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLMapPoint:(MGLMapPoint)point;

Swift

convenience init(mglMapPoint point: MGLMapPoint)

Parameters

point

The value for the new object.

Return Value

A new value object that contains the coordinate and zoom level information.

MGLMapPointValue

The Mapbox map point structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLMapPoint MGLMapPointValue;

Swift

var mglMapPointValue: MGLMapPoint { get }

+valueWithMGLCoordinateSpan:

Creates a new value object containing the specified Mapbox coordinate span structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLCoordinateSpan:(MGLCoordinateSpan)span;

Swift

convenience init(mglCoordinateSpan span: MGLCoordinateSpan)

Parameters

span

The value for the new object.

Return Value

A new value object that contains the coordinate span information.

MGLCoordinateSpanValue

The Mapbox coordinate span structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLCoordinateSpan MGLCoordinateSpanValue;

Swift

var mglCoordinateSpanValue: MGLCoordinateSpan { get }

+valueWithMGLCoordinateBounds:

Creates a new value object containing the specified Mapbox coordinate bounds structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLCoordinateBounds:
(MGLCoordinateBounds)bounds;

Swift

convenience init(mglCoordinateBounds bounds: MGLCoordinateBounds)

Parameters

bounds

The value for the new object.

Return Value

A new value object that contains the coordinate bounds information.

MGLCoordinateBoundsValue

The Mapbox coordinate bounds structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLCoordinateBounds MGLCoordinateBoundsValue;

Swift

var mglCoordinateBoundsValue: MGLCoordinateBounds { get }

+valueWithMGLCoordinateQuad:

Creates a new value object containing the specified Mapbox coordinate quad structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLCoordinateQuad:(MGLCoordinateQuad)quad;

Swift

convenience init(mglCoordinateQuad quad: MGLCoordinateQuad)

Parameters

quad

The value for the new object.

Return Value

A new value object that contains the coordinate quad information.

-MGLCoordinateQuadValue

The Mapbox coordinate quad structure representation of the value.

Declaration

Objective-C

- (MGLCoordinateQuad)MGLCoordinateQuadValue;

Swift

func mglCoordinateQuadValue() -> MGLCoordinateQuad

Working with Offline Map Values

+valueWithMGLOfflinePackProgress:

Creates a new value object containing the given MGLOfflinePackProgress structure.

Declaration

Objective-C

+ (nonnull NSValue *)valueWithMGLOfflinePackProgress:
(MGLOfflinePackProgress)progress;

Swift

/*not inherited*/ init(mglOfflinePackProgress progress: MGLOfflinePackProgress)

Parameters

progress

The value for the new object.

Return Value

A new value object that contains the offline pack progress information.

MGLOfflinePackProgressValue

The MGLOfflinePackProgress structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLOfflinePackProgress MGLOfflinePackProgressValue;

Swift

var mglOfflinePackProgressValue: MGLOfflinePackProgress { get }

Working with Transition Values

+valueWithMGLTransition:

Creates a new value object containing the given MGLTransition structure.

Declaration

Objective-C

+ (nonnull NSValue *)valueWithMGLTransition:(MGLTransition)transition;

Swift

/*not inherited*/ init(mglTransition transition: MGLTransition)

Parameters

transition

The value for the new object.

Return Value

A new value object that contains the transition information.

MGLTransitionValue

The MGLTransition structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLTransition MGLTransitionValue;

Swift

var mglTransitionValue: MGLTransition { get }

+valueWithMGLSphericalPosition:

Creates a new value object containing the given MGLSphericalPosition structure.

Declaration

Objective-C

+ (nonnull instancetype)valueWithMGLSphericalPosition:
(MGLSphericalPosition)lightPosition;

Swift

convenience init(mglSphericalPosition lightPosition: MGLSphericalPosition)

Parameters

lightPosition

The value for the new object.

Return Value

A new value object that contains the light position information.

MGLSphericalPositionValue

The MGLSphericalPosition structure representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLSphericalPosition MGLSphericalPositionValue;

Swift

var mglSphericalPositionValue: MGLSphericalPosition { get }

+valueWithMGLLightAnchor:

Creates a new value object containing the given MGLLightAnchor enum.

Declaration

Objective-C

+ (nonnull NSValue *)valueWithMGLLightAnchor:(MGLLightAnchor)lightAnchor;

Swift

/*not inherited*/ init(mglLightAnchor lightAnchor: MGLLightAnchor)

Parameters

lightAnchor

The value for the new object.

Return Value

A new value object that contains the light anchor information.

MGLLightAnchorValue

The MGLLightAnchor enum representation of the value.

Declaration

Objective-C

@property (atomic, readonly) MGLLightAnchor MGLLightAnchorValue;

Swift

var mglLightAnchorValue: MGLLightAnchor { get }