feat: Added 'addImages' to StyleController and enhanced 'addLayer' #307

gabbopalma · 2025-07-30T10:15:38Z

Features

Added addImages method to support loading multiple images at once
Added aboveLayerId parameter to addLayer method for more flexible layer positioning
Updated example app to demonstrate both features

Changes

StyleController: New addImages method to add multiple images in a single call
StyleController: Extended addLayer to support positioning layers both above and below existing layers
Example pages updated to use new addImages method with multiple pins

Examples

Adding multiple images

// Load multiple pin images at once
final images = <String, Uint8List>{
  'red_pin': await http.readBytes(Uri.parse('red_pin_url')),
  'black_pin': await http.readBytes(Uri.parse('black_pin_url')),
};

await style.addImages(images);

Layer positioning

// Add layer above another layer
await style.addLayer(
  SymbolLayer(
    id: 'markers',
    sourceId: 'points',
    aboveLayerId: 'labels', //! Only supported on Android
  ),
);

// Add layer below another layer
await style.addLayer(
  SymbolLayer(
    id: 'markers',
    sourceId: 'points',
    belowLayerId: 'buildings',
  ),
);

TODO

Implement JNI communication for addImage and addImages methods
Update example app and test to demonstrate the new aboveLayerId parameter
Update documentation with platform-specific details

Note: This PR is currently in draft status while working on the JNI implementation for image handling

… into 'addLayer'.

…le network images

codecov · 2025-07-30T10:17:11Z

Codecov Report

❌ Patch coverage is 63.51351% with 27 lines in your changes missing coverage. Please review.
✅ Project coverage is 50.60%. Comparing base (06e0289) to head (6039876).

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gabbopalma · 2025-07-30T13:28:34Z

Hi @josxha, since we are currently using jni in style_controller.dart for the addLayer method, can we remove the addLayer methods from MapLibreHostApi=
I actually updated them into MapLibreHostApi too, to be safe.

The same applies now that we have switched to JNI for the addImage and addImages methods.
Furthermore, from this PR onwards, MapLibreHostApi is no longer used in StyleControllerAndroid, generating a warning.

…pdated jnigen.yml.

…llerAndroid

Copilot

Pull Request Overview

This PR introduces formatting changes to automatically generated JNI Dart bindings files, improving code readability by adding multi-line parameter formatting for constructors, methods, and function calls. The changes are purely cosmetic, affecting code style without altering functionality.

lib/src/platform/android/jni/org/maplibre/android/maps/Style.dart

lib/src/platform/android/jni/org/maplibre/android/maps/NativeMapView.dart

josxha · 2025-09-21T09:22:05Z

Hi @gabbopalma, thanks for enhancing the functionality. Sorry for taking me that long to respond. You wrote a couple of unchecked bulletpoints in the pr description. What is the current state of this pr?

Hi @josxha, since we are currently using jni in style_controller.dart for the addLayer method, can we remove the addLayer methods from MapLibreHostApi=
I actually updated them into MapLibreHostApi too, to be safe.

Thanks for taking the extra effort. If it's handled by jni, no need to update the kotlin implementation. If it it's no longer required, we can just remove them. In case it is required by iOS but not Android, an empty override should be fine.

Furthermore, from this PR onwards, MapLibreHostApi is no longer used in StyleControllerAndroid, generating a warning.

This is awesome news! Big step to a complete ffi/jni solution. You can remove it or ignore the warning, up to you.

// ignore: unused_field

I included this pr in the v0.3.0 milestone, hope that's alright for you?

gabbopalma · 2025-09-21T11:39:18Z

Hi @josxha, thanks for the review! I will completely remove MapLibreHostApi, in order to improve the goal of full jni/ffi implementation.
The 3.0.0 milestone is good for me 😉

…ions and pigeon files

gabbopalma · 2025-09-22T14:11:50Z

Hi @josxha, I successfully removed MapLibreHostApi, but I noticed that you added the dispose method (which was removed with all the other methods).
Do we want to reintroduce the dispose method? If so, how?
Also, the addImage and addImages methods are currently unavailable on iOS. I tried compiling the app on my iOS simulator to start implementing it and testing all the changes, but I encountered this error:

Semantic Issue (Xcode): Use of undeclared identifier ‘MapLibreIosPlugin’
/Users/gabrielpalmisano/Development/projects/flutter-maplibre/example/ios/Runner/GeneratedPluginRegistrant.m:36:3

josxha · 2025-09-22T14:52:25Z

I successfully removed MapLibreHostApi, but I noticed that you added the dispose method (which was removed with all the other methods).
Do we want to reintroduce the dispose method? If so, how?

Its only usage is currently in the iOS implementation, right? I think I used it in an attempt to get rid of some memory leaks.

flutter-maplibre/maplibre_ios/ios/maplibre_ios/Sources/maplibre_ios/MapViewDelegate.swift

Lines 112 to 119 in 60b218e

    
           func dispose() throws { 
        
             print("### dispose MapLibre view ### \(_viewId) ###") 
        
             MapLibreRegistry.removeMap(viewId: _viewId) 
        
             _mapView.removeFromSuperview() 
        
             _mapView.delegate = nil 
        
             _mapView = nil 
        
             _view.removeFromSuperview() 
        
           }

Is it correct that the main scope of this pr is to enhance the FFI capabilities of the StyleController? I'd recommend to keep the dispose() method in place for now. A separate pr might be good.

I tried compiling the app on my iOS simulator to start implementing it and testing all the changes, but I encountered this error:

Did you activate the swift package manager? iOS needs the SwiftPM to run successfully.

flutter config --enable-swift-package-manager

gabbopalma · 2025-09-22T20:42:02Z

Is it correct that the main scope of this pr is to enhance the FFI capabilities of the StyleController? I'd recommend to keep the dispose() method in place for now. A separate pr might be good.

Sure, this is the main scope of the PR. Since we want to restore it, and handle the change in another PR, do we want reintroduce MapLibreHostApi? Just for the dispose method?

Did you activate the swift package manager? iOS needs the SwiftPM to run successfully.

Of course nope ahahah, I just did it, thanks

josxha · 2025-09-22T22:03:16Z

Sure, this is the main scope of the PR. Since we want to restore it, and handle the change in another PR, do we want reintroduce MapLibreHostApi? Just for the dispose method?

Ahh, I see. Probably not for the sake of an unused dispose() method.

    override fun dispose() {
        // free any resources
    }

How about your changes from #162? It makes use of the MapLibreHostApi. I'd like to integrate the functionality at some point into the main branch. Sorry, I waited a bit long with it and how there are numerous conflicts. Do you think a jni integration is feasable here as well or should we keep your implementation with pigeon?

gabbopalma · 2025-09-23T07:53:51Z

How about your changes from #162? It makes use of the MapLibreHostApi. I'd like to integrate the functionality at some point into the main branch.

I'll be a little busy these days because I'm traveling. I'll look at the changes related to #162 and try to integrate them into jni/ffi (unfortunately, it's a very old implementation and, on second thought, there are better ways of doing it)

josxha · 2025-09-23T18:29:28Z

I'll be a little busy these days because I'm traveling. I'll look at the changes related to #162 and try to integrate them into jni/ffi (unfortunately, it's a very old implementation and, on second thought, there are better ways of doing it)

No worries, take your time and enjoy your vacation! Alright, then let's delay the functionality in #162. In that case, what ever is the easiest to you, probably to keep it removed?

gabbopalma · 2025-09-27T13:37:54Z

In that case, what ever is the easiest to you, probably to keep it removed?

Yes, we can leave it removed for now. If you agree, I'll try to implement the drag gestures on the Dart side to remove some platform-specific code and try to don't reintroduce something similar to MapLibreHostApi

josxha

Hi @gabbopalma, I did a code review and added a couple of comments. Could you take a look when you find some time?
I'd like to put out a release by tomorrow but no need to rush, we can merge whenever ready and also release it with a following release.

josxha · 2025-09-28T07:48:26Z

example/lib/layers_marker_page.dart

+          // Each point is displayed as a layer of markers due to the
+          // randomly generated 'iconImage' property.
+          // Do not follow this approach, as it is not efficient.
+          // Instead, use a single 'MarkerLayer' with a list of points.


Please use a more easy and state of the art example implementation for users here.
You can use two MarkerLayers that start with some initial points. When the map gets clicked, update the points of the 2nd layer.

josxha · 2025-09-28T07:52:27Z

lib/src/platform/ios/style_controller.dart

    );*/
-    await _hostApi.addImage(id, bytes);
+    // TODO: implement addImage
+    throw UnimplementedError('addImage is not implemented on iOS yet.');


Removed functionality on ios. Please keep the existing implementation or use an ffi equivalent.

josxha · 2025-09-28T07:54:50Z

lib/src/platform/ios/style_controller.dart

+  Future<void> addImages(Map<String, Uint8List> images) {
+    // TODO: implement addImages
+    throw UnimplementedError('addImages is not implemented on iOS yet.');
+  }


Could you add an implementation here please? You can use multiple calls to addImage().

https://maplibre.org/maplibre-native/ios/latest/documentation/maplibre-native-for-ios/multipleimagesexample

lib/src/platform/web/style_controller.dart

josxha · 2025-09-28T08:17:16Z

lib/src/platform/ios/style_controller.dart

+  @override
+  Future<void> addLayer(
+    StyleLayer layer, {
+    String? aboveLayerId,


aboveLayerId has currently no implementation. Please either add an implementation or add an assert and todo.

lib/src/style_controller.dart

josxha · 2025-09-28T08:25:43Z

maplibre_ios/ios/maplibre_ios/Sources/maplibre_ios/MapViewDelegate.swift

 import MapLibre

 class MapLibreView: NSObject, FlutterPlatformView, MLNMapViewDelegate,
-  MapLibreHostApi, UIGestureRecognizerDelegate


We don't need the MapLibreHostApi on Android but still need to have on it on iOS for the dispose method until we can get rid of the dispose() method.

flutter-maplibre/maplibre_ios/ios/maplibre_ios/Sources/maplibre_ios/MapViewDelegate.swift

Lines 112 to 119 in 22a9d55

func dispose() throws {

print("### dispose MapLibre view ### \(_viewId) ###")

MapLibreRegistry.removeMap(viewId: _viewId)

_mapView.removeFromSuperview()

_mapView.delegate = nil

_mapView = nil

_view.removeFromSuperview()

}

lib/src/platform/web/style_controller.dart

gabbopalma added 4 commits July 30, 2025 10:30

feat: Introduced new methods in Style: 'addImages' and 'aboveLayerId'…

0cc7572

… into 'addLayer'.

Merge remote-tracking branch 'origin/main' into feat-images-handling

79147cd

chore: runned pigeon generation after merge

1130f1b

feat: Update exaples to use new 'addImages' method and support multip…

b4c468b

…le network images

github-project-automation bot added this to maplibre dev Jul 30, 2025

github-project-automation bot moved this to Backlog in maplibre dev Jul 30, 2025

fix: ktlint format

df1b6c7

gabbopalma added 4 commits July 30, 2025 16:06

chore: runned jnigen to introduce Bitmap and BitmapFactory classes. U…

59f85f2

…pdated jnigen.yml.

feat: implement JNI for addImage and addImages methods in StyleContro…

9099042

…llerAndroid

fix: remove unnecessary logging in MapLibreMapController

97ec49e

feat: add tests for addImage and addImages methods in controller_test

60c3ac5

gabbopalma marked this pull request as ready for review July 30, 2025 14:53

Copilot AI review requested due to automatic review settings July 30, 2025 14:53

Copilot AI reviewed Jul 30, 2025

View reviewed changes

josxha added this to the v0.3.0 milestone Sep 1, 2025

josxha added 2 commits September 20, 2025 23:33

Merge branch 'main' into pr/307

4a45cdf

code gen

b226503

Merge remote-tracking branch 'origin/main' into feat-images-handling

3e62a0b

josxha moved this from Backlog to In Progress in maplibre dev Sep 22, 2025

gabbopalma added 3 commits September 22, 2025 16:01

Removed MapLibreHostApi and its methods from all platform implementat…

e1f40e7

…ions and pigeon files

Merge branch 'main' into feat-images-handling

dbe6576

feat: Add missing import for graphics package in MapLibreMapStateAndroid

5099c98

josxha requested changes Sep 28, 2025

View reviewed changes

Merge branch 'main' into feat-images-handling

95d5bf3

josxha removed this from the v0.3.0 milestone Sep 29, 2025

josxha marked this pull request as draft September 29, 2025 11:32

Merge branch 'main' into feat-images-handling

6039876

	func dispose() throws {
	print("### dispose MapLibre view ### \(_viewId) ###")
	MapLibreRegistry.removeMap(viewId: _viewId)
	_mapView.removeFromSuperview()
	_mapView.delegate = nil
	_mapView = nil
	_view.removeFromSuperview()
	}

Uh oh!

feat: Added 'addImages' to StyleController and enhanced 'addLayer' #307

Are you sure you want to change the base?

feat: Added 'addImages' to StyleController and enhanced 'addLayer' #307

Uh oh!

Conversation

gabbopalma commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Features

Changes

Examples

Adding multiple images

Layer positioning

TODO

Uh oh!

codecov bot commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gabbopalma commented Jul 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josxha commented Sep 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gabbopalma commented Sep 21, 2025

Uh oh!

gabbopalma commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

josxha commented Sep 22, 2025

Uh oh!

gabbopalma commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

josxha commented Sep 22, 2025

Uh oh!

gabbopalma commented Sep 23, 2025

Uh oh!

josxha commented Sep 23, 2025

Uh oh!

gabbopalma commented Sep 27, 2025

Uh oh!

josxha left a comment

Choose a reason for hiding this comment

Uh oh!

josxha Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

josxha Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

josxha Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

josxha Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

josxha Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

gabbopalma commented Jul 30, 2025 •

edited

Loading

codecov bot commented Jul 30, 2025 •

edited

Loading

gabbopalma commented Jul 30, 2025 •

edited

Loading

josxha commented Sep 21, 2025 •

edited

Loading

gabbopalma commented Sep 22, 2025 •

edited

Loading

gabbopalma commented Sep 22, 2025 •

edited

Loading