Skip to content

Latest commit

 

History

History
78 lines (60 loc) · 4.67 KB

README.md

File metadata and controls

78 lines (60 loc) · 4.67 KB
Raw

Android Google Maps Floating Marker Titles

This library is useful if you want to see the titles of the markers on the map floating next to the marker. It attempts to reproduce the behavior for points of interest shown on the map in Google Maps. Since there is no way to draw directly into the map component, it works as a view to apply on top of the map as an overlay.

I initially created this library for the Android version of Map Marker when it was still using Android native code, I've since then moved to Flutter. You can still download the APK of the last version of Map Marker still using this library here.

Note: If you're looking for a cross-platform implementation, I've created the flutter_map_floating_marker_titles library for Flutter.

Visual Preview

Project structure

The library project is the googlemapsfloatingmarkertitles folder. The root of the repository is also an Android studio project with a sample app's code.

Sample app setup

To make the sample app work, you will need to update the Android manifest file app/src/main/AndroidManifest.xml and update this section with your Google Maps API key:

<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="YOUR_API_KEY_GOES_HERE" />

How to use this library in your code

  1. You will have to add the library folder manually to your Android project
  2. Add a FloatingMarkerTitlesOverlay view on top of your map view in your XML layout
  3. In your code, retrieve the FloatingMarkerTitlesOverlay view and initialize it like this
private FloatingMarkerTitlesOverlay floatingMarkersOverlay;
@Override
public void onMapReady(GoogleMap googleMap) {
    //Code related to initializing googleMap related attributes

    //Initializing FloatingMarkerTitlesOverlay
    floatingMarkersOverlay = findViewById(R.id.map_floating_markers_overlay);
    floatingMarkersOverlay.setSource(googleMap);

    //From now on, you can add markers to be tracked by floatingMarkersOverlay
}
  1. Add a marker to the map
final long id = 0;
final LatLng latLng = new LatLng(-34, 151);
final String title = "A cool marker";
final int color = Color.GREEN;
final MarkerInfo mi = new MarkerInfo(latLng, title, color);
googleMap.addMarker(new MarkerOptions().position(mi.getCoordinates()));
//Adding the marker to track by the overlay
//To remove that marker, you will need to call floatingMarkersOverlay.removeMarker(id)
floatingMarkersOverlay.addMarker(id, mi);

Main library features

  • Display floating markers titles on top of the map
  • Works with ancient versions of Android: minSdkVersion 9
  • Automatically avoids overlap between floating marker titles, will not display a title if overlapping with others
  • Set z-indexes for floating marker titles to specify which title has the most priority for display: MarkerInfo.setZIndex(...)
  • Set whether floating marker titles should be written in bold: MarkerInfo.setBoldText(...)
  • Marker title text transparent outline for better visuals: the text will be readable no matter the map background and the outline color will adapt to white or black depending on the text color's luminance (perceived brightness)
  • Marker title fade-in animation for better visuals
  • Set the text size: FloatingMarkerTitlesOverlay.setTextSizeDIP(...)
  • Set the distance between the text and the marker center: FloatingMarkerTitlesOverlay.setTextPaddingToMarkerDIP(...)
  • Set the maximum number of floating titles: FloatingMarkerTitlesOverlay.setMaxFloatingTitlesCount(...)
  • No performance drop with more markers once the maximum number of floating titles has been reached, since the library only scans for a limited number of markers per frame, which can be set with FloatingMarkerTitlesOverlay.setSetMaxNewMarkersCheckPerFrame(...)
  • Set the maximum width of floating titles: FloatingMarkerTitlesOverlay.setMaxTextWidthDIP(...)
  • Set the maximum height of floating titles: FloatingMarkerTitlesOverlay.setMaxTextHeightDIP(...)

About issues and/or feature requests

I am not willing to invest time to take feature requests at the moment since this library has sufficient features for my needs as is. If you find a bug, I'll probably want to fix it since it might affect my production app, so feel free to report any bugs you may find. If you need a feature and want to build it and then submit it as a pull request, I'm willing to work with you to merge your work into the current code.