MBMTilesetDescriptorOptions

 

@interface MBMTilesetDescriptorOptions : NSObject

Describes the style package load option values for a style.

  • 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)initWithStyleURI:(nonnull NSString *)styleURI
                                 minZoom:(uint8_t)minZoom
                                 maxZoom:(uint8_t)maxZoom
                        stylePackOptions:(nullable MBMStylePackLoadOptions *)stylePackOptions;

    Swift

    init(styleURI: String, minZoom: UInt8, maxZoom: UInt8, stylePack stylePackOptions: MBMStylePackLoadOptions?)

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStyleURI:(nonnull NSString *)styleURI
                                 minZoom:(uint8_t)minZoom
                                 maxZoom:(uint8_t)maxZoom
                              pixelRatio:(float)pixelRatio
                        stylePackOptions:(nullable MBMStylePackLoadOptions *)stylePackOptions;

    Swift

    init(styleURI: String, minZoom: UInt8, maxZoom: UInt8, pixelRatio: Float, stylePack stylePackOptions: MBMStylePackLoadOptions?)

  • The style associated with the tileset descriptor

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *styleURI;

    Swift

    var styleURI: String { get }

  • Minimum zoom level for the tile package.

    Note: the implementation loads and stores the loaded tiles in batches, each batch has a pre-defined zoom range and it contains all child tiles within the range. The zoom leveling scheme for the tile batches can be defined in Tile JSON, otherwise the default scheme is used:

    • Global coverage: 0 - 5
    • Regional information: 6 - 10
    • Local information: 11 - 14
    • Streets detail: 15 - 16

    Internally, the implementation maps the given tile pack zoom range and geometry to a set of pre-defined batches to load, therefore it is highly recommended to choose the minZoom and maxZoom values in accordance with the tile batches zoom ranges (see the list above).

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint8_t minZoom;

    Swift

    var minZoom: UInt8 { get }

  • Maximum zoom level for the tile package.

    maxZoom value cannot exceed the maximum allowed tile batch zoom value,

    See

    minZoom

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint8_t maxZoom;

    Swift

    var maxZoom: UInt8 { get }

  • Pixel ratio to be accounted for when downloading raster tiles.

    The pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.

    Declaration

    Objective-C

    @property (nonatomic, readonly) float pixelRatio;

    Swift

    var pixelRatio: Float { get }

  • Style package load options, associated with the tileset descriptor.

    If provided, offline manager will create a style package while resolving the corresponding tileset descriptor and load all the resources as defined in the provided style package options, i.e. resolving of corresponding the tileset descriptor will be equivalent to calling the loadStylePack method of offline manager. If not provided, resolving of the corresponding tileset descriptor will not cause creating of a new style package but the loaded resources will be stored in the disk cache.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) MBMStylePackLoadOptions *stylePackOptions;

    Swift

    var stylePackOptions: MBMStylePackLoadOptions? { get }