[MAPSNAT-2285] Propagate scale factor param to platform SDKs

GitOrigin-RevId: c78091ceb8359e063c994d37caf3974ee9f6ce4a

Author: dserebriakov

CHANGELOG.md

@@ -6,6 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 
 ## 11.16.0-beta.1 - 23 September, 2025
 
+* Added experimental `scaleFactor` param to `MapOptions`, `MapSnapshotOptions` for scaling icons and texts.
 * Added support for `LandmarkIcons` featureset in Mapbox Standard Style. The `LandmarkIcons` featureset allows querying and configuring landmark building icons that appear on the map. Access landmark properties including landmarkId, name, type, and localized names through the `StandardLandmarkIconsFeature` class.
 * Enhanced `MapStyle.standard()` and `MapStyle.standardSatellite()` with new configuration parameters for color customization, landmark icons visibility, point-of-interest styling, road appearance, and administrative boundaries.
 * Expose `LineLayer.lineCutoutFadeWidth` to control route line cutout fade width.

Sources/MapboxMaps/Foundation/Extensions/Core/MapOptions.swift

@@ -41,13 +41,15 @@ extension MapOptions {
     ///   - size: Size of the map, if nil (the default), a minimal default size will be used.
     ///   - pixelRatio: Pixel scale of the map view; default is the main screen's native scale.
     ///   - glyphsRasterizationOptions: A `GlyphsRasterizationOptions` object.
+    ///   - scaleFactor: Scale factor to scale Map icons and texts; default is `1.0`.
     public convenience init(constrainMode: ConstrainMode = .heightOnly,
                             viewportMode: ViewportMode = .default,
                             orientation: NorthOrientation = .upwards,
                             crossSourceCollisions: Bool = true,
                             size: CGSize? = nil,
                             pixelRatio: CGFloat? = nil,
-                            glyphsRasterizationOptions: GlyphsRasterizationOptions = GlyphsRasterizationOptions(fontFamilies: [])) {
+                            glyphsRasterizationOptions: GlyphsRasterizationOptions = GlyphsRasterizationOptions(fontFamilies: []),
+                            scaleFactor: CGFloat = 1.0) {
 
         let mbmSize: Size?
 
@@ -64,7 +66,8 @@ extension MapOptions {
                   crossSourceCollisions: crossSourceCollisions.NSNumber,
                   size: mbmSize,
                   pixelRatio: Float(pixelRatio ?? ScreenShim.nativeScale),
-                  glyphsRasterizationOptions: glyphsRasterizationOptions)
+                  glyphsRasterizationOptions: glyphsRasterizationOptions,
+                  scaleFactor: Float(scaleFactor))
     }
 
     /// The map constrain mode. This can be used to limit the map to wrap around
@@ -110,6 +113,12 @@ extension MapOptions {
         return CGSize(width: Double(size.width), height: Double(size.height))
     }
 
+    /// Scale factor to scale map icons and texts. Default is `1.0`.
+    @_spi(Experimental)
+    public var scaleFactor: CGFloat {
+        return CGFloat(__scaleFactor)
+    }
+
     public override func isEqual(_ object: Any?) -> Bool {
         guard let other = object as? MapOptions else {
             return false
@@ -126,7 +135,8 @@ extension MapOptions {
             (crossSourceCollisions == other.crossSourceCollisions) &&
             (size == other.size) &&
             (pixelRatio == other.pixelRatio) &&
-            (glyphsRasterizationOptions == other.glyphsRasterizationOptions)
+            (glyphsRasterizationOptions == other.glyphsRasterizationOptions) &&
+            (scaleFactor == other.scaleFactor)
     }
 
     open override var hash: Int {
@@ -137,6 +147,7 @@ extension MapOptions {
         hasher.combine(crossSourceCollisions)
         hasher.combine(pixelRatio)
         hasher.combine(glyphsRasterizationOptions)
+        hasher.combine(scaleFactor)
         return hasher.finalize()
     }
 }

Sources/MapboxMaps/Foundation/Extensions/Core/MapSnapshotOptions.swift

@@ -10,6 +10,10 @@ public struct MapSnapshotOptions: Sendable {
     /// By default, `GlyphsRasterizationOptions` will use `.ideographsRasterizedLocally`
     public var glyphsRasterizationOptions: GlyphsRasterizationOptions
 
+    /// Scale factor to scale map shapshot icons and texts. Default is `1.0`.
+    @_spi(Experimental)
+    public var scaleFactor: CGFloat
+
     /// Flag that determines if the logo should be shown on the snapshot
     public var showsLogo: Bool
 
@@ -25,12 +29,15 @@ public struct MapSnapshotOptions: Sendable {
     ///         `.ideographsRasterizedLocally`
     ///   - showsLogo: Flag that determines if the logo should be shown on the snapshot
     ///   - showsAttribution: Flag that determines if attribution should be shown on the snapshot
+    ///   - scaleFactor: Scale factor to scale map snapshot icons and texts. Default is `1.0`.
     public init(size: CGSize,
                 pixelRatio: CGFloat,
                 glyphsRasterizationOptions: GlyphsRasterizationOptions = GlyphsRasterizationOptions(),
                 showsLogo: Bool = true,
-                showsAttribution: Bool = true) {
+                showsAttribution: Bool = true,
+                scaleFactor: CGFloat = 1.0) {
         precondition(pixelRatio > 0)
+        precondition(scaleFactor > 0)
         precondition(size.width * pixelRatio <= 8192, "Width or scale too great.")
         precondition(size.height * pixelRatio <= 8192, "Height or scale too great.")
 
@@ -39,14 +46,16 @@ public struct MapSnapshotOptions: Sendable {
         self.glyphsRasterizationOptions = glyphsRasterizationOptions
         self.showsLogo = showsLogo
         self.showsAttribution = showsAttribution
+        self.scaleFactor = scaleFactor
     }
 }
 
 extension MapSnapshotOptions {
     internal init(_ objcValue: CoreMapSnapshotOptions) {
         self.init(size: CGSize(objcValue.__size),
                   pixelRatio: CGFloat(objcValue.pixelRatio),
-                  glyphsRasterizationOptions: objcValue.glyphsRasterizationOptions ?? GlyphsRasterizationOptions())
+                  glyphsRasterizationOptions: objcValue.glyphsRasterizationOptions ?? GlyphsRasterizationOptions(),
+                  scaleFactor: CGFloat(objcValue.__scaleFactor))
     }
 }
 
@@ -56,6 +65,7 @@ extension CoreMapSnapshotOptions {
 
         self.init(__size: Size(width: Float(size.width), height: Float(size.height)),
                   pixelRatio: Float(swiftValue.pixelRatio),
-                  glyphsRasterizationOptions: swiftValue.glyphsRasterizationOptions)
+                  glyphsRasterizationOptions: swiftValue.glyphsRasterizationOptions,
+                  scaleFactor: Float(swiftValue.scaleFactor))
     }
 }

Sources/MapboxMaps/Foundation/MapInitOptions.swift

@@ -102,7 +102,8 @@ extension MapInitOptions {
                 crossSourceCollisions: mapOptions.__crossSourceCollisions,
                 size: Size(width: Float(bounds.width), height: Float(bounds.height)),
                 pixelRatio: mapOptions.pixelRatio,
-                glyphsRasterizationOptions: mapOptions.glyphsRasterizationOptions)
+                glyphsRasterizationOptions: mapOptions.glyphsRasterizationOptions,
+                scaleFactor: mapOptions.__scaleFactor)
 
             // Use the overriding style URI if provided (currently from IB)
             let resolvedStyleURI = overridingStyleURI.map { StyleURI(url: $0) } ?? styleURI

Tests/MapboxMapsTests/Foundation/MapboxMapTests.swift

@@ -56,7 +56,8 @@ final class MapboxMapTests: XCTestCase {
             crossSourceCollisions: mapInitOptions.mapOptions.crossSourceCollisions.NSNumber,
             size: mapInitOptions.mapOptions.size.map(Size.init),
             pixelRatio: mapInitOptions.mapOptions.pixelRatio,
-            glyphsRasterizationOptions: nil) // __map.getOptions() always returns nil for glyphsRasterizationOptions
+            glyphsRasterizationOptions: nil, // __map.getOptions() always returns nil for glyphsRasterizationOptions
+            scaleFactor: 1.0)
 
         let actualMapOptions = mapboxMap.options
 

scripts/api-compatibility-check/breakage_allowlist.txt

@@ -2186,3 +2186,7 @@ Func MapStyle.standard(theme:lightPreset:font:showPointOfInterestLabels:showTran
 Func MapStyle.standard(theme:lightPreset:font:showPointOfInterestLabels:showTransitLabels:showPlaceLabels:showRoadLabels:showPedestrianRoads:show3dObjects:colorBuildingHighlight:colorBuildingSelect:colorMotorways:colorPlaceLabelHighlight:colorPlaceLabelSelect:colorRoads:colorTrunks:showLandmarkIcons:themeData:) has parameter 9 type change from MapboxMaps.StyleColor? to MapboxMaps.StandardBackgroundPointOfInterestLabels?
 Func MapStyle.standardSatellite(lightPreset:font:showPointOfInterestLabels:showTransitLabels:showPlaceLabels:showRoadLabels:showRoadsAndTransit:showPedestrianRoads:colorMotorways:colorPlaceLabelHighlight:colorPlaceLabelSelect:colorRoads:colorTrunks:) has parameter 10 type change from MapboxMaps.StyleColor? to MapboxMaps.StandardColorModePointOfInterestLabels?
 Func MapStyle.standardSatellite(lightPreset:font:showPointOfInterestLabels:showTransitLabels:showPlaceLabels:showRoadLabels:showRoadsAndTransit:showPedestrianRoads:colorMotorways:colorPlaceLabelHighlight:colorPlaceLabelSelect:colorRoads:colorTrunks:) has parameter 8 type change from MapboxMaps.StyleColor? to MapboxMaps.StandardBackgroundPointOfInterestLabels?
+
+/* Removed Decls */
+Constructor MapOptions.init(constrainMode:viewportMode:orientation:crossSourceCollisions:size:pixelRatio:glyphsRasterizationOptions:) has been removed
+Constructor MapSnapshotOptions.init(size:pixelRatio:glyphsRasterizationOptions:showsLogo:showsAttribution:) has been removed