MBMMap

 

@interface MBMMap : MBMCameraManager

Map class provides map rendering functionality.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Creates the infrastructure needed for rendering the map. It should be called before any call to render method. Must be called on the render thread.

    Declaration

    Objective-C

    - (void)createRenderer;

    Swift

    func createRenderer()

  • Destroys the infrastructure needed for rendering the map, releasing resources. Must be called on the render thread.

    Declaration

    Objective-C

    - (void)destroyRenderer;

    Swift

    func destroyRenderer()

  • Renders the map.

    Declaration

    Objective-C

    - (void)render;

    Swift

    func render()

  • Sets the size of the map.

    Declaration

    Objective-C

    - (void)setSizeForSize:(nonnull MBMSize *)size;

    Swift

    func setSizeFor(_ size: MBMSize)

    Parameters

    size

    The new size of the map in platform pixels.

  • Gets the size of the map.

    Declaration

    Objective-C

    - (nonnull MBMSize *)getSize;

    Swift

    func getSize() -> MBMSize

    Return Value

    The size of the map in platform pixels.

  • Triggers a repaint of the map.

    Declaration

    Objective-C

    - (void)triggerRepaint;

    Swift

    func triggerRepaint()

  • Tells the map rendering engine that there is currently a gesture in progress. This affects how the map renders labels, as it will use different texture filters if a gesture is ongoing.

    Declaration

    Objective-C

    - (void)setGestureInProgressForInProgress:(BOOL)inProgress;

    Swift

    func setGestureInProgressForInProgress(_ inProgress: Bool)

    Parameters

    inProgress

    The boolean value representing if a gesture is in progress.

  • Returns true if a gesture is currently in progress.

    Declaration

    Objective-C

    - (BOOL)isGestureInProgress;

    Swift

    func isGestureInProgress() -> Bool

    Return Value

    true if a gesture is currently in progress, false otherwise.

  • Tells the map rendering engine that the animation is currently performed by the user (e.g. with a setCamera calls series). It adjusts the engine for the animation use case. In particular, it brings more stability to symbol placement and rendering.

    Declaration

    Objective-C

    - (void)setUserAnimationInProgressForInProgress:(BOOL)inProgress;

    Swift

    func setUserAnimationInProgressForInProgress(_ inProgress: Bool)

    Parameters

    inProgress

    The boolean value representing if user animation is in progress

  • Returns true if user animation is currently in progress.

    Declaration

    Objective-C

    - (BOOL)isUserAnimationInProgress;

    Swift

    func isUserAnimationInProgress() -> Bool

    Return Value

    true if a user animation is currently in progress, false otherwise.

  • When loading a map, if prefetch zoom delta is set to any number greater than 0, the map will first request a tile at zoom level lower than zoom - delta, with requested zoom level a multiple of delta, in an attempt to display a full map at lower resolution as quick as possible.

    Declaration

    Objective-C

    - (void)setPrefetchZoomDeltaForDelta:(uint8_t)delta;

    Swift

    func setPrefetchZoomDeltaForDelta(_ delta: UInt8)

    Parameters

    delta

    The new prefetch zoom delta.

  • Returns the map’s prefetch zoom delta.

    Declaration

    Objective-C

    - (uint8_t)getPrefetchZoomDelta;

    Swift

    func getPrefetchZoomDelta() -> UInt8

    Return Value

    The map’s prefetch zoom delta.

  • Sets the north orientation mode.

    Declaration

    Objective-C

    - (void)setNorthOrientationForOrientation:(MBMNorthOrientation)orientation;

    Swift

    func setNorthOrientationFor(_ orientation: NorthOrientation)

  • Sets the map constrain mode.

    Declaration

    Objective-C

    - (void)setConstrainModeForMode:(MBMConstrainMode)mode;

    Swift

    func setConstrainModeFor(_ mode: ConstrainMode)

  • Sets the viewport mode.

    Declaration

    Objective-C

    - (void)setViewportModeForMode:(MBMViewportMode)mode;

    Swift

    func setViewportModeFor(_ mode: ViewportMode)

  • Sets the map center altitude mode that defines behavior of the center point altitude for all subsequent camera manipulations.

    Declaration

    Objective-C

    - (void)setCenterAltitudeModeForMode:(MBMMapCenterAltitudeMode)mode;

    Swift

    func setCenterAltitudeModeFor(_ mode: MapCenterAltitudeMode)

  • Returns the map’s center altitude mode.

    Declaration

    Objective-C

    - (MBMMapCenterAltitudeMode)getCenterAltitudeMode;

    Swift

    func getCenterAltitudeMode() -> MapCenterAltitudeMode

    Return Value

    The map’s center altitude mode.

  • Returns the map options.

    Declaration

    Objective-C

    - (nonnull MBMMapOptions *)getMapOptions;

    Swift

    func getOptions() -> MBMMapOptions

    Return Value

    The map’s map options.

  • Returns the map debug options.

    Declaration

    Objective-C

    - (nonnull NSArray<NSNumber *> *)getDebug;

    Swift

    func getDebug() -> [NSNumber]

    Return Value

    An array of map debug options flags currently set to the map.

  • Sets the map debug options and enables debug mode based on the passed value.

    Declaration

    Objective-C

    - (void)setDebugForDebugOptions:(nonnull NSArray<NSNumber *> *)debugOptions
                          value:(BOOL)value;

    Swift

    func setDebugForDebugOptions(_ debugOptions: [NSNumber], value: Bool)

    Parameters

    debugOptions

    An array of map debug options to be set.
    value

    A boolean value representing the state for a given map debug options.

  • Reduces memory use. Useful to call when the application gets paused or sent to background.

    Declaration

    Objective-C

    - (void)reduceMemoryUse;

    Swift

    func reduceMemoryUse()

  • Gets elevation for the given coordinate. Note: Elevation is only available for the visible region on the screen.

    Declaration

    Objective-C

    - (nullable NSNumber *)getElevationForCoordinate:
    (CLLocationCoordinate2D)coordinate;

    Swift

    func getElevationFor(_ coordinate: CLLocationCoordinate2D) -> NSNumber?

    Parameters

    coordinate

    The coordinate defined as longitude-latitude pair.

    Return Value

    The elevation (in meters) multiplied by current terrain exaggeration, or empty if elevation for the coordinate is not available.

  • Configure the performance statistics collection preferences.

    If a non-empty samplerOptions array gets passed in PerfStatsCollectionOptions it enables statistics collection. To disable it, call setPerfStatsCollection again with an empty samplerOptions array.

    The resulting stats will be included in a PerfStatsCollected event which can be observed through the map instance. Turning the sampling on and off does not require resubscription to the event. However, canceling the subscription does not turn off the statistics collection.

    By default all samplers are disabled. Using this API might affect the runtime performance of the map, therefore it’s not recommended to enable it in production.

    Declaration

    Objective-C

    - (void)setPerfStatsCollectionForOptions:
    (nonnull MBMPerfStatsCollectionOptions *)options;

    Swift

    func setPerfStatsCollectionFor(_ options: MBMPerfStatsCollectionOptions)

    Parameters

    options

    The configuration options to be set.

  • Returns attributions for the data used by the Map’s style.

    Declaration

    Objective-C

    - (nonnull NSArray<NSString *> *)getAttributions;

    Swift

    func getAttributions() -> [String]

    Return Value

    An array of attributions for the data sources used by the Map’s style.

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithClient:(nonnull id<MBMMapClient>)client
                            mapOptions:(nonnull MBMMapOptions *)mapOptions;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)queryRenderedFeaturesForGeometry:(nonnull MBMRenderedQueryGeometry *)geometry
                                                      options:(nonnull MBMRenderedQueryOptions *)options
                                                     callback:(nonnull MBMQueryRenderedFeaturesCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)querySourceFeaturesForSourceId:(nonnull NSString *)sourceId
                                                    options:(nonnull MBMSourceQueryOptions *)options
                                                   callback:(nonnull MBMQuerySourceFeaturesCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)queryFeatureExtensionsForSourceIdentifier:(nonnull NSString *)sourceIdentifier
                                                               feature:(nonnull MBXFeature *)feature
                                                             extension:(nonnull NSString *)extension
                                                        extensionField:(nonnull NSString *)extensionField
                                                                  args:(nullable NSDictionary<NSString *, id> *)args
                                                              callback:(nonnull MBMQueryFeatureExtensionCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)setFeatureStateForSourceId:(nonnull NSString *)sourceId
                                          sourceLayerId:(nullable NSString *)sourceLayerId
                                              featureId:(nonnull NSString *)featureId
                                                  state:(nonnull id)state
                                               callback:(nonnull MBMFeatureStateOperationCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)getFeatureStateForSourceId:(nonnull NSString *)sourceId
                                          sourceLayerId:(nullable NSString *)sourceLayerId
                                              featureId:(nonnull NSString *)featureId
                                               callback:(nonnull MBMQueryFeatureStateCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)removeFeatureStateForSourceId:(nonnull NSString *)sourceId
                                             sourceLayerId:(nullable NSString *)sourceLayerId
                                                 featureId:(nonnull NSString *)featureId
                                                  stateKey:(nullable NSString *)stateKey
                                                  callback:(nonnull MBMFeatureStateOperationCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull id<MBXCancelable>)resetFeatureStatesForSourceId:(nonnull NSString *)sourceId
                                             sourceLayerId:(nullable NSString *)sourceLayerId
                                                  callback:(nonnull MBMFeatureStateOperationCallback)callback __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (void)setTileCacheBudgetForTileCacheBudget:(nullable MBMTileCacheBudget *)tileCacheBudget NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (void)setViewAnnotationPositionsUpdateListenerForListener:(nullable id<MBMViewAnnotationPositionsUpdateListener>)listener;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull MBXExpected<NSNull *, NSString *> *)addViewAnnotationForIdentifier:(nonnull NSString *)identifier
                                                                      options:(nonnull MBMViewAnnotationOptions *)options __attribute((ns_returns_retained));

    Swift

    func addViewAnnotation(forIdentifier identifier: String, options: MBMViewAnnotationOptions) -> MBXExpected

  • Undocumented

    Declaration

    Objective-C

    - (nonnull MBXExpected<NSNull *, NSString *> *)updateViewAnnotationForIdentifier:(nonnull NSString *)identifier
                                                                         options:(nonnull MBMViewAnnotationOptions *)options __attribute((ns_returns_retained));

    Swift

    func updateViewAnnotation(forIdentifier identifier: String, options: MBMViewAnnotationOptions) -> MBXExpected

  • Undocumented

    Declaration

    Objective-C

    - (nonnull MBXExpected<NSNull *, NSString *> *)removeViewAnnotationForIdentifier:(nonnull NSString *)identifier __attribute((ns_returns_retained));

    Swift

    func removeViewAnnotation(forIdentifier identifier: String) -> MBXExpected

  • Undocumented

    Declaration

    Objective-C

    - (nonnull MBXExpected<MBMViewAnnotationOptions *, NSString *> *)getViewAnnotationOptionsForIdentifier:(nonnull NSString *)identifier __attribute((ns_returns_retained));

    Swift

    func getViewAnnotationOptions(forIdentifier identifier: String) -> MBXExpected