v11.0.0-beta.6

Breaking changes ⚠️

• Style projection can be undefined for styles that do not explicitly specify it, so MapboxMap.projection has become optional.
• View Annotation API is changed:
  • ViewAnnotationOptions.geometry was removed in favor of ViewAnnotationOptions.annotatedFeature.
  • ViewAnnotationOptions.associatedFeatureId was removed. Use AnnotatedFeature.layerFeature(layerId:featureId:) with ViewAnnotationOptions.annotatedFeature to bind View Annotation to features rendered by any layer.
  • [SwiftUI] Use MapViewAnnotation instead of ViewAnnotation to display view annotations in SwiftUI.
  • [SwiftUI] MapViewAnnotation initializer doesn't receive configuration parameters anymore. Use modifier functions to configure annotaiton:

   Map {
     MapViewAnnotation(coordinate: coordinate) {
        Text("🏠")
     }
     .allowOverlap(false)
     .variableAnchors([ViewAnnotationAnchorConfig(anchor: .bottom)])
   }

• OverviewViewportStateOptions.padding is renamed to OverviewViewportStateOptions.coordinatePadding, the OverviewViewportStateOptions.padding now represents the camera padding.

Features ✨ and improvements 🏁

• New ViewAnnotation class is added to simplify work with view annotations, use it instead of ViewAnnotationOptions.
• Support for Dynamic View Annotations. Use them to attach View annotations to any feature rendered by map, for example you can visualize additional information along the routes, areas, or points. The annotations will reposition themselves when user pans the map. Check the ViewAnnotation and MapViewAnnotation documentation or the pre-built DynamicViewAnnotationExample.

• Add MapboxMaps.camera(for:camera:coordinatesPadding:maxZoom:offset).
• Add MapViewDebugOptions.padding debug option.
• Add maxZoom and offset parameters to OverviewViewportStateOptions.
• Add "keep-legacy-style-pack" style pack load extra option that prevents from the style package removal from the legacy storage
• Enable rendering of fill extrusion flood lights on the ground with fully transparent fill extrusions
• Skip location and bearing updates if new value changes are under fixed epsilon
• Add cameraForCoordinates overload so that the padding for map & geometry can be specified separately.
• Disable terrain when zoom-dependent exaggeration expression evaluates to zero.
• Add support for glb 3d tiles
• Align hillshade illumination direction with 3d lights

Bug fixes 🐞

• Fix issue when transition to Overview Viewport resulted in double padding.
• [SwiftUI] Fix issue when Overview Viewport is incorrect if set as initial viewport.
• Improve handling of inlined style fragments
• Do not overwrite style URL when setting invalid style JSON
• Don't store SDK version in TileStore

Dependencies

• Update MapboxCommon to 24.0.0-beta.7.
• Update MapboxCoreMaps to 11.0.0-beta.7.

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v11.0.0-beta.5

⚠️ Known issues ⚠️

• MapboxMap.setProjection(_:) throws an error if the underlying style doesn't define a projection or if a style hasn't completed loading yet.

Breaking changes ⚠️

• Consolidate FetchTileFunctionCallback and CancelTileFunctionCallback by single type TileFunctionCallback.

Features ✨ and improvements 🏁

• Add a new CustomLayer API to simplify manipulation of layers with custom rendering (aka "CustomLayerHost").
• The following APIs have been promoted to stable:
  • LineLayer/lineDepthOcclusionFactor, LineLayer/lineDepthOcclusionFactorTransition, LineLayer/lineEmissiveStrength and LineLayer/lineEmissiveStrengthTransition
  • SymbolLayer/iconImageCrossFade, SymbolLayer/iconImageCrossFadeTransition, SymbolLayer/iconEmissiveStrength, SymbolLayer/iconEmissiveStrengthTransition, SymbolLayer/textEmissiveStrength and SymbolLayer/textEmissiveStrengthTransition
  • BackgroundLayer/backgroundEmissiveStrength and BackgroundLayer/backgroundEmissiveStrengthTransition
  • CircleLayer/circleEmissiveStrength and CircleLayer/circleEmissiveStrengthTransition
  • FillLayer/fillEmissiveStrength and FillLayer/fillEmissiveStrengthTransition
  • AmbientLight, DirectionalLight and related APIs.
• Fix memory leak in SwiftUI.
• Expose MapViewDebugOptions in SwiftUI.
• Improve the caching model for the Custom Raster Source.
• Flood lighting and AO ground contribution in draped mode
• Optimize Custom Raster source data update
• Increase rendering performance of shadows
• Relax style parsing of an unknown style layer properties
• Optimise memory usage in the fill-extrusion layer
• Improve the rendering performance of a symbol layer that uses symbol-sort-key property
• Reduce memory usage in fill-extrusion flood light and ground ambient occlusion

Bug fixes 🐞

• Fix a bug where the map would not zoom above a certain threshold on high-pitched views
• Fix crashes if 3D layers are used alone on terrain or globe without any other layer types
• Fix line layer leaking if placed behind the satellite layer
• Fix line and raster layers interop for draped mode
• Fix a crash problem that occurred when consecutive snapshot requests were made
• Correct half-texel misalignment in raster-color lookup texture sampling
• Use the system's default fraction digit setting for currency formatting
• Fix erroneous shadow map sampling of distant landmarks
• Fix incorrect level-of-detail model being chosen for trees in some scenarios
• Fix the style layer minimum and maximum zoom default values

Changes in: 11.0.0-beta.1, 11.0.0-beta.2, 11.0.0-beta.3, 11.0.0-beta.4

Dependencies

• Update MapboxCommon to 24.0.0-beta.6.
• Update MapboxCoreMaps to 11.0.0-beta.6.

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v10.16.1

Features ✨ and improvements 🏁

• Add privacy manifest - PrivacyInfo.xcprivacy.

Bug fixes 🐞

• Fix StyleColor failing to initialize with non-sRGB color spaces by converting supplied UIColors to sRGB color space by default.
• Fix incorrectly set begin timestamp for the RenderFrameFinished event.
• Cache featureState for newly added source in case it is not available in renderer.
• Allow pausing HTTP requests in the background.
• Fix line and raster layers interop for draped mode.
• Fix a crash that occurred when consecutive snapshot requests were made.
• Use the system's default fraction digit setting for currency formatting.

Dependencies

• Update MapboxCommon to 23.8.3.
• Update MapboxCoreMaps to 10.16.1.

Dependency requirements:

• Compatible version of Xcode: 14.1.0.

v11.0.0-beta.4

Changes

Breaking changes ⚠️

• StyleColor.red, StyleColor.green, StyleColor.blue, StyleColor.alpha are not in use anymore and got removed.
• The syncSourceAndLayerIfNeeded method in every annotation manager (e.gPointAnnotationManager and others) was removed from the public API.

Features ✨ and improvements 🏁

• Add MSAA support with the MapInitOptions/antialiasingSampleCount property.
• StyleColor - add support for all color formats as defined by Mapbox Style Spec.
• Introduce experimental Custom Raster Source APIs: StyleManager/addCustomRasterSource, StyleManager/setCustomRasterSourceTileData, StyleManager/invalidateCustomRasterSourceTile, StyleManager/invalidateCustomRasterSourceRegion.
• Introduce new Map Content Gesture System, please refer to Map Content Gestures Guide for more information and guidance.

MapboxCoreMaps to 11.0.0-beta.5:

Features ✨ and improvements 🏁

• Add properties to control fade out of model and fill-extrusion layers when pitch is used
• Improve fog rendering performance
• Add getCenterAltitudeMode function to the public API.
• Improve fill layer and model layer rendering performance on high pitch views.
• Add custom raster source API to support custom raster tiles generated/provided by the client.
• Improve GPU performance by drawing opaque 3D geometry without blending
• Introduce experimental symbol-z-elevate property to elevate symbols along with the buildings that are in the same place. The feature is supported for symbols with point placement only.
• Update Mapbox Common to v24.0.0-beta.5
• Add vertical-range property for fog

Bug fixes 🐞

• Fix issue where the terrain didn't work if defined within a style fragment
• The Custom Geometry Source fetchTileFunction() and cancelTileFunction() callbacks are invoked on the client thread.
• Fixes a rendering error that broke symbol layers on Samsung S22 devices
• Cache featureState for newly added source in case it is not available in renderer
• Fix issue with model layer blending with geometry tile source
• Fix incorrectly set begin timestamp for the RenderFrameFinished event

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v11.0.0-beta.3

Changes

Maps SDK (11.0.0-beta.3)

Breaking changes ⚠️

• MapboxMap.dragStart() and MapboxMap.dragEnd() are not in use anymore and were removed.
• Remove MapOptions/optimizeForTerrain option. Whenever terrain is present layer order is automatically adjusted for better performance.

Features ✨ and improvements 🏁

• Improve map camera and gestures when terrain is used to fix camera bumpiness and map flickering.
• Expose a method to remove tile region with a completion: TileStore.removeTileRegion(forId:completion:).
• Bump core maps version to 11.0.0-beta.4 and common sdk to 24.0.0-beta.4.

Bug fixes 🐞

• Fix modelCastShadows and modelReceiveShadows options of Puck3DConfiguration being ignored.

Changes in 11.0.0-beta.2
Changes in 11.0.0-beta.1

MapboxCoreMaps (11.0.0-beta.4)

Features ✨ and improvements 🏁

• Use a fallback glyph URL if a style does not define one. This enables the addition of Symbol layers to an empty style or to the style that doesn't use Symbol layers.
• Use ETC2 compression for raster tiles to support transparency.
• Add runtime styling API.

Bug fixes 🐞

• Fix fallback rules for the style's transition property. The change fixes style transitions when style imports are modified for the Standard style.
• Improve camera behavior on terrain. This change fixes jumpy camera animations on platforms.
• Fix a crash on application exit when multiple maps were rendered in a single thread.
• Fix terrain rendering for the Terrarium-encoded tiles.
• Fixes an issue that causes view annotations to be placed on the sky when high pitch and mercator projection is used.

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v10.16.0

Bug fixes 🐞

• Fix race condition for Metal library initialization. The fix allows developers to create multiple MapSnapshotter instances without hitting race condition that raises an exception and terminates the application.
• Avoid excessive relayout of the symbol layer when no properties depend on the image changes. This fix eliminates the symbol layer flickering when styles are switched.
• Fix possible crash on mutex lock after library unload.
• Don't emit MapLoadingError if an offline tilepack has no tiles.
• Fix terrain rendering for the Terrarium-encoded tiles.
• Fix a crash on application exit when rendering multiple maps in a single thread.
• Fix an issue that causes view annotations to be placed on the sky when high pitch and mercator projection is used.

Dependencies

• Update MapboxCommon to 23.8.0.
• Update MapboxCoreMaps to 10.16.0.

Dependency requirements:

• Compatible version of Xcode: 14.1.0.

v11.0.0-beta.2

Changes

Maps SDK (11.0.0-beta.2)

Features ✨ and improvements 🏁

SwiftUI support 🥳 . We introduce preliminary support for iOS SwiftUI. Read more about it in the SwiftUI User Guide.

Bug fixes 🐞

• Introduce experimental MapboxRecorder, which allows recording of the map and replaying custom scenarios.
• Expose slot property on Layer protocol.
• Add privacy policy attribution dialog action.
• Show SDK version in the attribution dialog title.
• Fixed an issue when Annotations could be shuffled when updated.

Changes in 11.0.0-beta.1

MapboxCoreMaps (11.0.0-beta.3)

Features ✨ and improvements 🏁

• Reduce segment overlap in flood lighting to improve rendering performance
• Enable offline support for the Standard style
• Reduce vertex buffer size in flood lighting and ground AO when rounded edges are enabled to improve performance
• Add wireframe rendering debug feature (note: only supported on Android at the moment)

Bug fixes 🐞

• Fix race condition for Metal library initialization. The fix allows developers to create multiple MapSnapshotter instances without hitting race condition that raises an exception and terminates the application.
• Fix Tileset descriptor resolving on network error. The issue prevented the downloading of style and tilepacks in case of a network error.
• Avoid excessive relayout of the symbol layer when no properties depend on the image changes. This fix eliminates the symbol layer flickering when styles are switched.
• Don't emit MapLoadingError if an offline tilepack for 3D landmarks has no tiles
• Fix a bug where the cameraForGeometry method returned incorrect values for the globe projection

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v10.16.0-rc.1

Changes

Bug fixes 🐞

• Don't emit MapLoadingError if an offline tilepack has no tiles

Dependencies

• Update MapboxCommon to 23.8.0-rc.2.
• Update MapboxCoreMaps to 10.16.0-rc.2:

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v10.16.0-beta.1

Changes

Bug fixes 🐞

• Fix race condition for Metal library initialization. The fix allows developers to create multiple MapSnapshotter instances without hitting race condition that raises an exception and terminates the application.
• Avoid excessive relayout of the symbol layer when no properties depend on the image changes. This fix eliminates the symbol layer flickering when styles are switched.
• Fix possible crash on mutex lock after library unload.

Dependencies

• Update MapboxCommon to 23.8.0-beta.1.
• Update MapboxCoreMaps to 10.16.0-beta.1:

Dependency requirements:

• Compatible version of Xcode: 14.1.0

v11.0.0-beta.1

Changes

⚠️ More info on migrating from v10 to v11 can be found here: Mapbox Maps v11 Migration Guide.

• Introduce hsl, hsla color expression.
• Introduce random expression.
• Introduce measureLight expression lights configuration property.
• Introduce LineLayer/lineBorderColor, LineLayer/lineBorderWidth APIs.
• Introduce SymbolLayer/iconImageCrossFade API.
• Introduce experimental BackgroundLayer/backgroundEmissiveStrength, CircleLayer/circleEmissiveStrength, FillLayer/fillEmissiveStrength, LineLayer/lineEmissiveStrength, SymbolLayer/iconEmissiveStrength, SymbolLayer/textEmissiveStrength, ModelLayer/modelEmissiveStrength, ModelLayer/modelRoughness, ModelLayer/modelHeightBasedEmissiveStrengthMultiplier APIs.
• Introduce experimental FillExtrusionLayer/fillExtrusionAmbientOcclusionWallRadius, FillExtrusionLayer/fillExtrusionAmbientOcclusionGroundRadius, FillExtrusionLayer/fillExtrusionAmbientOcclusionGroundAttenuation, FillExtrusionLayer/fillExtrusionFloodLightColor, FillExtrusionLayer/fillExtrusionFloodLightIntensity, FillExtrusionLayer/fillExtrusionFloodLightWallRadius, FillExtrusionLayer/fillExtrusionFloodLightGroundRadius, FillExtrusionLayer/fillExtrusionFloodLightGroundAttenuation, FillExtrusionLayer/fillExtrusionVerticalScale APIs.
• Rename Viewport to ViewportManager.
• Apply ModelScaleMode.viewport to Puck3D configuration and remove the custom expression for the modelScale of the puck. This means if you are using a constant for Puck3DConfiguration/modelScale in v10, you need to adjust this model-scale constant so the puck would be rendered correctly in v11, while this value depends on other configurations of your puck, we have found the new adjusted model-scale to fall between 10x-100x of the old value.
• Add experimental tileCover method to the Snapshotter that returns tile ids covering the map.
• Add optional maxZoom and offset parameters to MapboxMap.camera(for coordinateBounds:). MapboxMap.camera(for coordinateBounds:), MapboxMap.camera(for coordinates:), and MapboxMap.camera(for geometry:) no longer return a padding value.
• Location is splitted into Location and Heading structs, the location and heading data are now animated individually.
• Replace loadStyleJSON(_:completion:)/loadStyleJSON(_:completion:) with overloaded loadStyle(_:completion:).
• Mark Expression.Operator.activeAnchor as experimental.
• Add transition options as a parameter to loadStyle(...) methods.
• Expression.Operator is now a struct with static variables instead of enum.
• Add MapboxMap.coordinate(s)Info(for:) for converting offscreen points into geographical coordinates.
• Fixed an issue when MapboxMap.point(for:) could return false negative result.
• Remove source, sourceLayer, filter properties from the Layer protocol requirement.
• Refactor style Light API: introduce AmbientLight, DirectionalLight, FlatLight and methods to set them.
• Add expression support to Layer.visibility.
• Expose new APIs for working with style importing and configuration: getStyleImports(), removeStyleImport(forImportId:), getStyleImportSchema(forImportId:), getStyleImportConfigProperties(forImportId:), setStyleImportConfigPropertiesForImportId(:configs:), getStyleImportConfigProperty(forImportId:config:), setStyleImportConfigPropertyForImportId(:config:value:)
• Expose slot property for all Layers to link layers from imported styles.
• Convert Style properties enums into structs.
• Bump core maps version to 11.0.0-beta.2 and common sdk to 24.0.0-beta.2.
• Remove MetaKit reexport.
• Remove unnecessary check before updating a geo json source.
• Remove deprecated LocationManager.updateHeadingForCurrentDeviceOrientation() method.
• Remove deprecated MapEvents.EventKind.
• Make NSNumber extension internal.
• Remove experimental MapboxMap.setRenderCache(_:) method.
• Remove deprecated GestureOptions.pinchRotateEnabled.
• Remove deprecated Location initializer.
• Remove deprecated transition properties from layers.
• Make easeTo/flyTo return non-optional cancelable token.
• Add rotation case to GestureType to be able to detect rotation separately from other gestures.
• Enable zoom during a drag gesture.
• Fix bearing value is fluctuating between initial value and correct value during a rotation gesture.
• Allows animation during any ongoing gestures.
• Sync map size to the size of the metal view.
• Fix missing feature properties for nil/null values.
• Added experimental tileCover method to MapboxMap that returns tile ids covering the map.
• Expose owner property for CameraAnimator protocol
• Updated core styles to the latest versions.
• Merge TilesetDescriptorOptions and TilesetDescriptorOptionsForTilesets. To enable tileset descriptor creation for a list of tilesets that are not part of the original style use TilesetDescriptorOptions.
• Use DataRef to pass snapshot and style image data by reference, improving performance
• Bumped min iOS version to 12.0
• Expose a subset of ModelLayer APIs.
• Protocol LocationProvider now requires class semantic for implementation.
• The Map events have been reworked:
  • Now all Map events payloads are serialize-free, which brings more type safety and eliminates possible deserialization errors;
  • The MapboxMap and Snapshotter now expose on-prefixed properties that allows you to subscribe to map events via observe and observeNext methods:

    mapboxMap.onCameraChanged.observe { [weak self] event in
      self?.camera = event.cameraState
    }.store(in: &cancelables)
    
    mapboxMap.onStyleLoaded.observeNext { [weak self] _ in
      self?.configureStyle()
    }.store(in: &cancelables)

  • The AnyCancelable object returned from observe and observeNext should be stored, otherwise the subscription will be immediately canceled;
  • The same on-prefixed properties can now be used as Combine.Publisher:

    import Combine
    mapboxMap.onCameraChanged
      .debounce(for: .milliseconds(500), scheduler: DispatchQueue.main)
      .map(\.cameraState)
      .sink { [weak self] cameraState in
        self?.camera = cameraState
      }.store(in: &cancellables)

  • Methods MapboxMap.onEvery, MapboxMap.onNext, Snapshotter.onEvery, Snapshotter.onNext have been deprecated;
  • Methods MapboxMap.observe and Snapshotter.observe have been removed.
• Deprecate PointAnnotationManager.iconTextFit and PointAnnotationManager.iconTextFitPadding in favor of PointAnnotation.iconTextFit and PointAnnotation.iconTextFitPadding.
• Remove deprecated PuckBearingSourceand related APIs.
• Experimental API MapboxMap/setMemoryBudget was renamed to MapboxMaps/setTileCacheBudget and promoted to stable.
• Location consumer methods have been renamed to align with Swift API Design Guidelines. Use addLocationConsumer(_:) and removeLocationConsumer(_:) rather than addLocationConsumer(newConsumer:) and removeLocationConsumer(consumer:).
• SourceType and LayerType are now structs with static variables instead of enums
• Remove ResourceOptions and ResourceOptionsManager. Introduce MapboxOptions and MapboxMapsOptions to handle application-level access token and other generic options.
  • Mapbox's access token can now be set with MapboxCommon.MapboxOptions. By default, MapboxMaps SDK will try to read the access token from app bundle's property list or MapboxAccessToken file when Maps service are initialized; if you wish to set access token programmatically, it is highly recommended to set it before initializing a MapView.

    import MapboxMaps
    
    MapboxOptions.accessToken = accessToken

  • TileStoreno longer requires TileStoreOptions.mapboxAccessToken to be explicitly set.
  • Configurations for the external resources used by Maps API can now be set with MapboxMapsOptions:

    import MapboxMaps
    
    MapboxMapsOptions.dataPath = customDataPathURL
    MapboxMapsOptions.assetPath = customAssetPathURL
    MapboxMapsOptions.tileStoreUsageMode = .readOnly
    MapboxMapsOptions.tileStore = tileStore

  • To clear the temporary map data, you can use MapboxMap.clearData(completion:)
• Expose new 3D Lights API: AmbientLight and DirectionalLight.
• TypeConversionError, SnapshotError, and ViewAnnotationManagerError are now structs with static variables instead of enums
• Extend Layer protocol with visibility property.
• Add required id property to Source. After that change id should be specified for source upon creation:

  let terrainSource = RasterDemSource(id: "terrain-source")
  mapView.mapboxMap.addSource(terrainSource)

• Support string option in GeoJSONSourceData.
• Allows passing extraOptions (which must be a valid JSON object) when creating StylePackLoadOptionsand TilesetDescriptorOptions.
• Deprecate MapboxMap/style and Snapshotter/style, from now on you can access Style APIs directly from MapboxMap and Snapshotter instance.
• Add a new API to enable Tracing with Tracing.status = .enabled. Checkout Tracing reference to see more.
• Introduce FillExtrusionLayer.fillExtrusionRoundedRoof , FillExtrusionLayer.fillExtrusionEdgeRadius API.
• Introduce line-depth-occlusion API.
• Introduce FillExtrusionLayer/fillExtrusionRoundedRoof, FillExtrusionLayer/fillExtrusionEdgeRadius API.
• Introduce lineDepthOcclusionFactor API for LineLayers and PolylineAnnotiationManager.
• Add Codable support to CameraOptions, CameraState, FollowPuckViewportStateBearing, FollowPuckViewportStateOptions.
• Expose new Style APIs for partial GeoJSON update:

MapboxMap.addGeoJSONSou...