MBMMapOptions

 

@interface MBMMapOptions : NSObject

Describes the map option values.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContextMode:(nullable NSNumber *)contextMode
                              constrainMode:(nullable NSNumber *)constrainMode
                               viewportMode:(nullable NSNumber *)viewportMode
                                orientation:(nullable NSNumber *)orientation
                      crossSourceCollisions:(nullable NSNumber *)crossSourceCollisions
                         optimizeForTerrain:(nullable NSNumber *)optimizeForTerrain
                                       size:(nullable MBMSize *)size
                 glyphsRasterizationOptions:(nullable MBMGlyphsRasterizationOptions *)glyphsRasterizationOptions NS_REFINED_FOR_SWIFT;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithContextMode:(nullable NSNumber *)contextMode
                              constrainMode:(nullable NSNumber *)constrainMode
                               viewportMode:(nullable NSNumber *)viewportMode
                                orientation:(nullable NSNumber *)orientation
                      crossSourceCollisions:(nullable NSNumber *)crossSourceCollisions
                         optimizeForTerrain:(nullable NSNumber *)optimizeForTerrain
                                       size:(nullable MBMSize *)size
                                 pixelRatio:(float)pixelRatio
                 glyphsRasterizationOptions:(nullable MBMGlyphsRasterizationOptions *)glyphsRasterizationOptions NS_REFINED_FOR_SWIFT;

  • The map context mode. This can be used to optimizations if we know that the drawing context is not shared with other code.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *contextMode;

  • The map constrain mode. This can be used to limit the map to wrap around the globe horizontally. By default, it is set to HeightOnly.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *constrainMode;

  • The viewport mode. This can be used to flip the vertical orientation of the map as some devices may use inverted orientation.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *viewportMode;

  • The orientation of the Map. By default, it is set to Upwards.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *orientation;

  • Specify whether to enable cross-source symbol collision detection or not. By default, it is set to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *crossSourceCollisions;

  • With terrain on, if true, the map will render for performance priority, which may lead to layer reordering allowing to maximize performance (layers that are draped over terrain will be drawn first, including fill, line, background, hillshade and raster). Any layers that are positioned after symbols are draped last, over symbols. Otherwise, if set to false, the map will always be drawn for layer order priority. By default, it is set to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSNumber *optimizeForTerrain;

  • The size to resize the map object and renderer backend. The size is given in platform pixel units. macOS and iOS platforms use device-independent pixel units, while other platforms, such as Android, use screen pixel units.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) MBMSize *size;

  • The custom pixel ratio. By default, it is set to 1.0

    Declaration

    Objective-C

    @property (nonatomic, readonly) float pixelRatio;

    Swift

    var pixelRatio: Float { get }

  • Glyphs rasterization options to use for client-side text rendering.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) MBMGlyphsRasterizationOptions *glyphsRasterizationOptions;

    Swift

    var glyphsRasterizationOptions: MBMGlyphsRasterizationOptions? { get }