Map

  • Map class provides map rendering functionality.

    See more

    Declaration

    Objective-C

    
    @interface MBMMap : MBMCameraManager

    Swift

    class Map : CameraManager
  • Describes the map option values.

    See more

    Declaration

    Objective-C

    
    @interface MBMMapOptions : NSObject

    Swift

    class MapOptions : NSObject
  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMMapsResourceOptions : NSObject
    
    // This class provides custom init which should be called
    - (nonnull instancetype)init NS_UNAVAILABLE;
    
    // This class provides custom init which should be called
    + (nonnull instancetype)new NS_UNAVAILABLE;
    
    /**
     * Set the base URL that would be used by the Maps engine to make HTTP requests.
     * The value of the key must be a string that is a valid URL.
     *
     * By default the engine uses the base URL `https://api.mapbox.com`
     *
     * @param baseURL base URL
     */
    + (void)setBaseURLForBaseURL:(nonnull NSString *)baseURL NS_REFINED_FOR_SWIFT;
    /**
     * Get the base URL resource option
     *
     * @return base URL
     */
    + (nonnull NSString *)getBaseURL __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;
    /**
     * Set the path to the Maps data folder.
     *
     * The engine will use this folder for storing offline style packages and temporary data.
     *
     * The application must have sufficient permissions to create files within the provided directory.
     * If a DataPath is not provided, the default location will be used.
     *
     * @param dataPath data path
     */
    + (void)setDataPathForDataPath:(nonnull NSString *)dataPath NS_REFINED_FOR_SWIFT;
    /**
     * Get the data path resource option
     *
     * @return data path
     */
    + (nonnull NSString *)getDataPath __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;
    /**
     * Set the path to the Maps asset folder.
     *
     * The path to the folder where application assets are located. Resources whose protocol is `asset://`
     * will be fetched from an asset folder or asset management system provided by respective platform.
     * This option is ignored for Android platform. An iOS application may provide path to an application bundle's path.
     *
     * @param assetPath asset path
     */
    + (void)setAssetPathForAssetPath:(nonnull NSString *)assetPath NS_REFINED_FOR_SWIFT;
    /**
     * Get the asset path resource option
     *
     * @return asset path
     */
    + (nonnull NSString *)getAssetPath __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;
    /**
     * Set the tile store usage mode for the Maps API objects.
     *
     * The `ReadOnly` mode is used by default.
     *
     * @param tileStoreUsageMode tile store usage mode
     */
    + (void)setTileStoreUsageModeForTileStoreUsageMode:(MBMTileStoreUsageMode)tileStoreUsageMode NS_REFINED_FOR_SWIFT;
    /**
     * Get tile store usage mode
     *
     * @return tile store usage mode
     */
    + (MBMTileStoreUsageMode)getTileStoreUsageMode NS_REFINED_FOR_SWIFT;
    /**
     * Set the tile store instance for the Maps API objects.
     *
     * This resource option is taken into consideration by the Maps API objects only if tile store usage is enabled.
     *
     * If null is set, but tile store usage is enabled, a tile store at the default location will be created and used.
     */
    + (void)setTileStoreForTileStore:(nullable MBXTileStore *)tileStore NS_REFINED_FOR_SWIFT;
    /**
     * Get tile store instance
     *
     * @return tile store or null if store usage is not enabled
     */
    + (nullable MBXTileStore *)getTileStore __attribute((ns_returns_retained)) NS_REFINED_FOR_SWIFT;
    + (void)clearDataForCallback:(nonnull MBMAsyncOperationResultCallback)callback NS_REFINED_FOR_SWIFT;
    
    @end

    Swift

    class MapsResourceOptions : NSObject
  • Describes the map context mode. We can make some optimizations if we know that the drawing context is not shared with other code.

    See more

    Declaration

    Objective-C

    enum MBMContextMode : NSInteger {}

    Swift

    enum ContextMode : Int, @unchecked Sendable
  • Describes whether to constrain the map in both axes or only vertically e.g. while panning.

    See more

    Declaration

    Objective-C

    enum MBMConstrainMode : NSInteger {}

    Swift

    enum ConstrainMode : Int, @unchecked Sendable
  • Satisfies embedding platforms that requires the viewport coordinate systems to be set according to its standards.

    See more

    Declaration

    Objective-C

    enum MBMViewportMode : NSInteger {}

    Swift

    enum ViewportMode : Int, @unchecked Sendable
  • Describes the glyphs rasterization option values.

    See more

    Declaration

    Objective-C

    
    @interface MBMGlyphsRasterizationOptions : NSObject

    Swift

    class GlyphsRasterizationOptions : NSObject
  • Describes glyphs rasterization modes.

    See more

    Declaration

    Objective-C

    enum MBMGlyphsRasterizationMode : NSInteger {}

    Swift

    enum GlyphsRasterizationMode : Int, @unchecked Sendable
  • Describes the map orientation.

    See more

    Declaration

    Objective-C

    enum MBMNorthOrientation : NSInteger {}

    Swift

    enum NorthOrientation : Int, @unchecked Sendable
  • Describes the coordinate on the screen, measured from top to bottom and from left to right. Note: the map uses screen coordinate units measured in platform pixels.

    See more

    Declaration

    Objective-C

    
    @interface MBMScreenCoordinate : NSObject

    Swift

    class ScreenCoordinate : NSObject
  • Describes the coordinate box on the screen, measured in platform pixels from top to bottom and from left to right.

    See more

    Declaration

    Objective-C

    
    @interface MBMScreenBox : NSObject

    Swift

    class ScreenBox : NSObject
  • A coordinate bounds and zoom.

    See more

    Declaration

    Objective-C

    
    @interface MBMCoordinateBoundsZoom : NSObject

    Swift

    class CoordinateBoundsZoom : NSObject
  • Options for enabling debugging features in a map.

    See more

    Declaration

    Objective-C

    enum MBMMapDebugOptions : NSInteger {}

    Swift

    enum MapDebugOptions : Int, @unchecked Sendable
  • Collection of useful constants.

    See more

    Declaration

    Objective-C

    
    @interface MBMMapConstants : NSObject

    Swift

    class MapConstants : NSObject
  • Size type.

    See more

    Declaration

    Objective-C

    
    @interface MBMSize : NSObject

    Swift

    class Size : NSObject