MMKLayerOptions

@interface MMKLayerOptions : NSObject

Options that are used when adding a layer to the map.

Summary

Class methods

+ (nonnull MMKLayerOptions *)layerOptionsWithActive:( BOOL)active
                                 nightModeAvailable:( BOOL)nightModeAvailable
                                          cacheable:( BOOL)cacheable
                                animateOnActivation:( BOOL)animateOnActivation
                     tileAppearingAnimationDuration:( NSTimeInterval)tileAppearingAnimationDuration
                                       overzoomMode:( MMKOverzoomMode)overzoomMode
                                        transparent:( BOOL)transparent
                                     versionSupport:( BOOL)versionSupport;

Instance methods

- (nonnull MMKLayerOptions *)init;

Properties

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL active;
Inactive layers are not displayed on the map and do not request any tiles from TileProvider

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL nightModeAvailable;

Indicates the availability of night mode for this layer (for example, night mode is disabled for the satellite layer)

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL cacheable;
Determines whether tiles are cached on persistent storage or not

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL animateOnActivation;

Indicates whether layer activation/deactivation should be animated

@property (nonatomic, assign, unsafe_unretained, readwrite)
    NSTimeInterval tileAppearingAnimationDuration;

Specifies duration of tile appearing animation

@property (nonatomic, assign, unsafe_unretained, readwrite)
    MMKOverzoomMode overzoomMode;

Whether to render tiles from adjacent zoom levels in place of absent or translucent tiles

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL transparent;
Set this flag if layer is transparent, that is parts of underlying layers can be seen through it

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL versionSupport;
Determines if layer supports versioning

Class methods

layerOptionsWithActive:nightModeAvailable:cacheable:animateOnActivation:tileAppearingAnimationDuration:overzoomMode:transparent:versionSupport:

+ (nonnull MMKLayerOptions *)layerOptionsWithActive:( BOOL)active
                                 nightModeAvailable:( BOOL)nightModeAvailable
                                          cacheable:( BOOL)cacheable
                                animateOnActivation:( BOOL)animateOnActivation
                     tileAppearingAnimationDuration:( NSTimeInterval)tileAppearingAnimationDuration
                                       overzoomMode:( MMKOverzoomMode)overzoomMode
                                        transparent:( BOOL)transparent
                                     versionSupport:( BOOL)versionSupport;


Instance methods

init

- (nonnull MMKLayerOptions *)init;


Properties

active

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL active;

Inactive layers are not displayed on the map and do not request any tiles from TileProvider.


nightModeAvailable

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL nightModeAvailable;

Indicates the availability of night mode for this layer (for example, night mode is disabled for the satellite layer). Default: true.


cacheable

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL cacheable;

Determines whether tiles are cached on persistent storage or not.


animateOnActivation

@property (nonatomic, assign, unsafe_unretained, readwrite)
    BOOL animateOnActivation;

Indicates whether layer activation/deactivation should be animated.


tileAppearingAnimationDuration

@property (nonatomic, assign, unsafe_unretained, readwrite)
    NSTimeInterval tileAppearingAnimationDuration;

Specifies duration of tile appearing animation. Can be set to 0 to disable animation. Default: 400 ms


overzoomMode

@property (nonatomic, assign, unsafe_unretained, readwrite)
    MMKOverzoomMode overzoomMode;

Whether to render tiles from adjacent zoom levels in place of absent or translucent tiles.


transparent

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL transparent;

Set this flag if layer is transparent, that is parts of underlying layers can be seen through it. This will disable some rendering optimizations that take advantage of layer opacity.


versionSupport

@property (nonatomic, assign, unsafe_unretained, readwrite) BOOL versionSupport;

Determines if layer supports versioning