Other Classes

The following classes are available globally.

  • Note! This is an experimental feature. It can be changed or removed in future versions.

    CustomLayerHost declares, by returning this from CustomLayerHost’s prerender, what kind of rendering it intends to do in the very next frame. If there is need for rendering to tile textures, declare if all tiles need to be re-rendered because e.g. underlying data changed.

    See more

    Declaration

    Objective-C

    
@interface MBMCustomLayerRenderConfiguration : NSObject

    Swift

    class CustomLayerRenderConfiguration : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMGeoJSONSourceData : NSObject

- (nonnull instancetype)initWithValue:(nonnull id)value __attribute__((deprecated("Please use: '+from{TypeName}:' instead.")));

+ (nonnull instancetype)fromGeometry:(nonnull MBXGeometry *)value;
+ (nonnull instancetype)fromFeature:(nonnull MBXFeature *)value;
+ (nonnull instancetype)fromNSArray:(nonnull NSArray<MBXFeature *> *)value;
+ (nonnull instancetype)fromNSString:(nonnull NSString *)value;

- (BOOL)isGeometry;
- (BOOL)isFeature;
- (BOOL)isNSArray;
- (BOOL)isNSString;

- (nonnull MBXGeometry *)getGeometry __attribute((ns_returns_retained));
- (nonnull MBXFeature *)getFeature __attribute((ns_returns_retained));
- (nonnull NSArray<MBXFeature *> *)getNSArray __attribute((ns_returns_retained));
- (nonnull NSString *)getNSString __attribute((ns_returns_retained));

@property (nonatomic, nonnull) id value;

@property (nonatomic, readonly) MBMGeoJSONSourceDataType type;

@end

    Swift

    class GeoJSONSourceData : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMMapMemoryBudget : NSObject

- (nonnull instancetype)initWithValue:(nonnull id)value __attribute__((deprecated("Please use: '+from{TypeName}:' instead.")));

+ (nonnull instancetype)fromMapMemoryBudgetInMegabytes:(nonnull MBMMapMemoryBudgetInMegabytes *)value;
+ (nonnull instancetype)fromMapMemoryBudgetInTiles:(nonnull MBMMapMemoryBudgetInTiles *)value;

- (BOOL)isMapMemoryBudgetInMegabytes;
- (BOOL)isMapMemoryBudgetInTiles;

- (nonnull MBMMapMemoryBudgetInMegabytes *)getMapMemoryBudgetInMegabytes __attribute((ns_returns_retained));
- (nonnull MBMMapMemoryBudgetInTiles *)getMapMemoryBudgetInTiles __attribute((ns_returns_retained));

@property (nonatomic, nonnull) id value;

@property (nonatomic, readonly) MBMMapMemoryBudgetType type;

@end

    Swift

    class MapMemoryBudget : NSObject

  • Map memory budget in megabytes.

    See more

    Declaration

    Objective-C

    
@interface MBMMapMemoryBudgetInMegabytes : NSObject

    Swift

    class MapMemoryBudgetInMegabytes : NSObject

  • Map memory budget in tiles.

    See more

    Declaration

    Objective-C

    
@interface MBMMapMemoryBudgetInTiles : NSObject

    Swift

    class MapMemoryBudgetInTiles : NSObject

  • Geometry for querying rendered features.

    See more

    Declaration

    Objective-C

    
@interface MBMRenderedQueryGeometry : NSObject

    Swift

    class RenderedQueryGeometry : NSObject

  • Describes the style package load option values for a list of tilesets.

    See more

    Declaration

    Objective-C

    
@interface MBMTilesetDescriptorOptionsForTilesets : NSObject

    Swift

    class TilesetDescriptorOptionsForTilesets : NSObject

  • Various options needed for displaying view annotation.

    See more

    Declaration

    Objective-C

    
@interface MBMViewAnnotationOptions : NSObject

    Swift

    class ViewAnnotationOptions : NSObject

  • Read-only data that is needed to correctly position the single view annotation on screen. Used inside ViewAnnotationPositionsUpdateListener callback to notify the listener about the visible view annotations’ position updates.

    See more

    Declaration

    Objective-C

    
@interface MBMViewAnnotationPositionDescriptor : NSObject

    Swift

    class ViewAnnotationPositionDescriptor : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMMapRecorder : 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;

/**
 * Initializes the map recorder object.
 *
 * @param map The `map` to record.
 */
- (nonnull instancetype)initWithMap:(nonnull MBMMap *)map;

/** Begins the API call sequence recording. */
- (void)startRecording;
/**
 * Stops the current recording session.
 *
 * @return a JSON string which contains the recorded sequence.
 */
- (nonnull NSString *)stopRecording __attribute((ns_returns_retained));
- (void)replayForContent:(nonnull NSString *)content
           playbackCount:(int32_t)playbackCount
 playbackSpeedMultiplier:(double)playbackSpeedMultiplier
                callback:(nonnull MBMPlaybackFinished)callback;
/** Temporarily pauses or resumes playback if already paused. */
- (void)togglePauseReplay;
/** Returns the string description of the current state of playback. */
- (nonnull NSString *)getPlaybackState __attribute((ns_returns_retained));

@end

    Swift

    class MapRecorder : NSObject

  • Undocumented

    See more

    Declaration

    Objective-C

    @interface MBMVersion : 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;

+ (uint32_t)getMajorVersion;
+ (uint32_t)getMinorVersion;
+ (uint32_t)getPatchVersion;
+ (nonnull NSString *)getVersionString __attribute((ns_returns_retained));
+ (nonnull NSString *)getRevisionString __attribute((ns_returns_retained));

@end

    Swift

    class Version : NSObject