Filament V3 Map Picker + Geoman Drawing Plugin

Introduction

Map Picker is a custom map toolbox for Filament that streamlines location selection and retrieves geo-coordinates effortlessly, seamlessly integrating the powerful Geoman plugin for enhanced mapping functionality.

• Features include:

  • A Field for Filament-v3 with Leaflet Map Integration
  • Receive Real-time Coordinates Upon Marker Movement Completion
  • Tailor Controls and Marker Appearance to Your Preferences

• Latest versions of PHP and Filament

• Best practices applied:

  • README.md (badges included)
  • LICENSE
  • composer.json
  • .gitignore
  • pint.json

GeoMan Integration

This package now includes integration with GeoMan, a powerful tool for creating and editing geometries on maps. GeoMan allows users to draw various shapes, edit existing geometries, and perform advanced map editing tasks.

GeoMan Features:

• Draw markers, polygons, polylines, and circles
• Edit existing geometries
• Cut polygons
• Rotate shapes
• Drag mode for easy shape manipulation
• Delete layers
• Upload Geojson files

Supported Maps

Map Picker currently supports the following map:

1. Open Street Map (OSM)
2. Google Maps

Installation

You can easily install the package via Composer:

composer require doode/filament-map-picker

Basic Usage

FilamentResource file:

<?php
namespace App\Filament\Resources;
use Filament\Resources\Resource;
use Filament\Resources\Forms\Form;
use Filament\Forms\Components\{
    Actions,
    Actions\Action,
    Fieldset,
    FileUpload,
    Hidden,
    TextInput,
    Textarea,
};

use Doode\MapPicker\Fields\Map;
...

class FilamentResource extends Resource
{
    ...
    public static function form(Form $form)
    {
        return $form->schema([
            Map::make('map')
                ->columnSpanFull()
                ->showFullscreenControl()
                ->showZoomControl()
                ->draggable()
                ->zoom(10) // Not required anymore
                ->detectRetina()
                ->extraStyles(['min-height: 100vh','border-radius: 5px'])
                ->extraControl(['zoomDelta' => 1, 'zoomSnap' => 2])
                
                // Layers Configuration From version 1.6
                // Standard Maps
                ->baseLayers([
                        [
                            'name' => 'OpenStreetMap',
                            'url' => "https://tile.openstreetmap.de/{z}/{x}/{y}.png",
                            'minZoom' => 1,
                            'maxZoom' => 28,
                        ],
                        [
                            'name' => 'GoogleMap',
                            'url' => "google.maps.googleapis.com",
                            'minZoom' => 1,
                            'maxZoom' => 28,
                        ],
                        [
                            'name' => 'SatelliteMap',
                            'url' => "url_satellite",
                            'minZoom' => 1,
                            'maxZoom' => 28,
                        ]
                    ])
                    ->defaultBaseLayer('Standard')
                    ->overlayLayers([
                        [
                            'name' => 'Marine Charts',
                            'url' => "url_marine_charts",
                            'minZoom' => 1,
                            'maxZoom' => 18,
                            'opacity' => 0.5,
                            'visibleByDefault' => false
                        ],
                        // New options from version 1.6.2
                        [
                            'name' => 'Marker points or areas',
                            'url' => "api_url",
                            'type' => 'api',
                            'minZoom' => 1,
                            'maxZoom' => 18,
                            'attribution' => '',
                            'visibleByDefault' => false
                        ],
                        [
                            'name' => 'Cities',
                            'url' => asset('geojson/cities.geojson'),
                            'type' => 'geojson',
                            'minZoom' => 1,
                            'maxZoom' => 18,
                            'attribution' => '',
                            'visibleByDefault' => false
                        ]
                    ])
                
                // Location
                ->defaultLocation(latitude: 52.8027, longitude: -1.0546)
                ->liveLocation(true, true, 5000) // or simple use `false` to disable live
                ->showMyLocationButton()
                ->boundaries(true, 49.5, -11, 61, 2) // Example for United Kingdom
                ->rangeSelectField('distance')
                
                // Marker Configuration
                ->showMarker()
                ->markerColor("#22c55e")
                ->clickable() // Click to set marker
                ->iconSize(32) // Icon size
                
                // GeoMan Toolbar
                ->geoManToolbar(true)
                ->geoManEditable(true)
                ->geoManPosition('topleft') // other options are: topright, bottomright and bottomleft
                ->drawCircleMarker(true)
                ->rotateMode(true)
                ->drawText(true)
                ->drawMarker(true)
                ->drawPolygon(true)
                ->drawPolyline(true)
                ->drawCircle(true)
                ->dragMode(true)
                ->cutPolygon(true)
                ->editPolygon(true)
                ->deleteLayer(true)
                ->setColor('#3388ff')
                ->setFillColor('#cad9ec') // Color inside the shapes
                
                //State Management
                ->afterStateUpdated(function (callable $set, ?array $state): void {
                    $set('latitude', $state['lat']);
                    $set('longitude', $state['lng']);
                    $set('geomanbox', json_encode($state)); 
                })
                ->afterStateHydrated(function ($state, $record, callable $set): void {
                    $set('location', ['lat' => $record->latitude, 'lng' => $record->longitude]);
                    $set( 'geomanbox', json_decode(strip_tags($record?->geomanbox)) );
                })
           ]),
           
           // Field to store the geojson data
           Hidden::make('geomanbox')->id('geomanbox')
    }
    ...
}

// Starting from version 1.6.0           
// Map Picker allows you to upload a GeoJSON file, automatically reading and rendering all shapes on the map
// for a seamless and interactive mapping experience.
// Here is an example of how to use it.
FileUpload::make('file')
    ->acceptedFileTypes(['application/json', 'application/geo+json'])
    ->maxSize(1024)
    ->storeFiles(false) // Store file is not necessary
    ->afterStateUpdated(function ($state, callable $set, $livewire){
        if (!$state){ return; }
        $geojsonData = json_decode($state->get(), true);
        if (!$geojsonData) { return; }
        if (isset($geojsonData['type']) && $geojsonData['type'] === 'FeatureCollection') {
            $set('geom', json_encode($geojsonData['features']));
            $set('name', $geojsonData['name'] ?? $geojsonData['features'][0]['properties']['name'] ?? 'Name Unknown');
            $livewire->dispatch('loadGeoJsonDataFromFile', json_encode($geojsonData['features']));
        }
    }),

clickable Option

This will allow you to set the point on the map with a click. Default behaviour has the marker centered as the map is dragged underneath. You could, with this, keep the map still and lock the zoom and choose to click to place the marker.

Map::make('location')
    ->showMarker(true)
    ->clickable(true)
    ->defaultLocation(latitude: 52.8027, longitude: -1.0546)
    ->zoom(12) // Not required anymore
    //->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png") //Not in use from version 1.6.0

rangeSelectField Option

The rangeSelectField Option allows you to specify another field on your form which specifies a range from the point identified by the marker. That field must be in meters. So for example you could do this:

Fieldset::make('Location')
    ->schema([
        Select::make('membership_distance')
            ->enum(MembershipDistance::class)
            ->options(MembershipDistance::class)
            ->required(),

        Map::make('location')
            ->showMarker(true)
            ->showFullscreenControl(false)
            ->showZoomControl()
            ->zoom(12) // Not required anymore
            ->detectRetina()
            ->defaultLocation(latitude: 40.4168, longitude: -3.7038)
            ->rangeSelectField('distance')
            ->setFillColor('#cad9ec'),
            //->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png") //Not in use from version 1.6.0
    ])
    ->columns(1),

In this case, as you change the value on the Select a circle of that radius centered on the marker will change to match your drop down.

liveLocation Option

The liveLocation method accepts three parameters:

1. bool $send: Determines if the user's live location should be sent.
2. bool $realtime: Controls whether the live location should be sent to the server periodically.
3. int $milliseconds: Sets the interval (in milliseconds) at which the user's location is updated and sent to the server.

Example:

Map::make('location')
    ->liveLocation(true, true, 10000)  // Updates live location every 10 seconds
    ->showMarker()
    ->draggable()

boundaries Option

The idea here is that you can set a boundary box by defining two points, the southwest most point and the north east most point, and your map will pan back into the panned area if you drag away, such that the points can only be selected if you stay in the map.

You will want to set the minZoom() along with this if you set showZoomControl(true). To choose a good value for minZoom() you will need to consider both the size of the map on the screen and the size of the bounding boxm, and you may find trial and error is the best method.

Map::make('location')
    ->showMarker()
    ->boundaries(true,49,11.1,61.0,2.1) //Example for United Kingdom
    ->draggable()

To turn it off again - possibly a strange use case - boundaries(false) is what you want.

setBoundsToBritishIsles Option

This is a convenience function that uses the boundaries option above, setting the boundary box to (49.5,-11) and (61,2)

Options Table

Here's a table describing all available options and their default values:

| Option | Description | Default Value | |-------------------------|------------------------------|--------------------------| | draggable | Allow map dragging | true | | showMarker | Display marker on the map | true | | baseLayers | Array for map tiles | Array | | defaultBaseLayer | The default map name | OpenStreetMap | | overlayLayers | Array for extras to overlay | Array | | attribution | Map attribution text | null | | zoomOffset | Zoom offset | -1 | | tileSize | Tile size | 512 | | detectRetina | Detect and use retina tiles | true | | minZoom | Minimum zoom level | 1 | | maxZoom | Maximum zoom level | 28 | | zoom | Default zoom level | 10 | | markerColor | Color of the marker | '#3b82f6' | | liveLocation | Enable live location updates | [false, false, 5000] | | showMyLocationButton | Show "My Location" button | false | | default | Default location | ['lat' => 0, 'lng' => 0] | | geoManToolbox.show | Enable GeoMan | true | | geoMan.editable | Allow editing with GeoMan | true | | geoMan.position | Position of GeoMan controls | 'topleft' | | geoMan.drawCircleMarker | Allow drawing circle markers | true | | geoMan.rotateMode | Enable rotate mode | true | | geoMan.drawText | Allow drawing text blocks | false | | geoMan.drawMarker | Allow drawing markers | true | | geoMan.drawPolygon | Allow drawing polygons | true | | geoMan.drawPolyline | Allow drawing polylines | true | | geoMan.drawCircle | Allow drawing circles | true | | geoMan.dragMode | Enable drag mode | true | | geoMan.cutPolygon | Allow cutting polygons | true | | geoMan.editPolygon | Allow editing polygons | true | | geoMan.deleteLayer | Allow deleting layers | true | | geoMan.color | Stroke color for drawings | '#3388ff' | | geoMan.filledColor | Fill color for drawings | '#cad9ec' |

New feature to capture image snapshot from the map

This is an example of the code in how to trigger the function in the map in order to capture the snapshot. Note: Latitude and longitude are not mandatory, you can move the map and trigger the action to capture the image.

“If you have Geoman shapes drawn on your map, they will be included in the generated image.” Here is an example of how to use this feature.

Actions::make([
   Action::make('capture_map_image')
       ->hiddenLabel()
       ->icon('heroicon-m-camera')
       ->color('info')
       ->action(function (callable $get, $livewire) {
           $lat = $get('lat');
           $lon = $get('lon');

           if(!empty($lat) && !empty($lon)){
               $livewire->dispatch('captureMapImage');
           }
       })
   ])->columnSpan(1)

In your web.php file is necessary to add the route, i.e you can use a custom Controller The map feature will post the blob image to this url /upload-map-image

// web.php file
Route::post('/upload-map-image', [MapController::class, 'uploadMapImage'])->name('upload.map.image');

// MapController file or any name you want to use
// You can customise your controller to handle the temporary image file path in various ways,
// such as storing it in the session, updating a database record, moving the file, or implementing any other logic you require.
// The possibilities are limitless – let your creativity guide you.
// For example, how to store in a session:
class MapController extends Controller
{
    public function uploadMapImage(Request $request)
    {
        // Validate the incoming request, max size is 10MB
        $request->validate(['map_image' => 'required|image|max:10240']);

        if ($request->hasFile('map_image')) {
            $file = $request->file('map_image');
            $path = $file->store('maps');

            if($path){
                session(['uploaded_map_image_path' => $path]);
                return response()->json(['success' => true]);
            }
        }

        return response()->json([
            'error' => false,
            'message' => 'No image uploaded / Failed to remove transparency'
        ], 400);
    }
}

If you wish to update the map location and marker either through an action or after altering other input values, you can trigger a refresh of the map using the following approach:

use Filament\Forms\Components\Actions\Action;
use Filament\Forms\Components\Actions;
use Filament\Support\Enums\VerticalAlignment;

Actions::make([
    Action::make('Set Default Location')
        ->icon('heroicon-m-map-pin')
        ->action(function (Set $set, $state, $livewire): void {
            $set('location', ['lat' => '52.8027', 'lng' => '-1.0546']);
            $set('latitude', '52.8027');
            $set('longitude', '-1.0546');
            $livewire->dispatch('refreshMap');
        })
])->verticalAlignment(VerticalAlignment::Start);

Usage As Infolist Field

The MapEntry Infolist field displays a map.

use Doode\MapPicker\Infolists\MapEntry;

public static function infolist(Infolist $infolist): Infolist
{
    return $infolist
        ->schema([
            MapEntry::make('location')
                ->showMarker()
                ->iconSize(32)
                ->showGeomanToolbar()
                ->markerColor("#22c55eff")
                ->showFullscreenControl()
                ->draggable(false)
                ->zoom(15)
                ->extraStyles(['min-height: 50vh','border-radius: 50px'])
                ->state(fn ($record) => ['lat' => $record?->latitude, 'lng' => $record?->longitude]),
            .....
        ]);
}

Usage Guide for Handling Map Locations

This section explains how to handle and display map locations within your application using this package.

Step 1: Define Your Database Schema

Ensure your database table includes latitude and longitude columns. This is essential for storing the coordinates of your locations. You can define your table schema as follows:

$table->double('latitude')->nullable();
$table->double('longitude')->nullable();

Step 2: Retrieve and Set Coordinates

When loading a record, ensure you correctly retrieve and set the latitude and longitude values. Use the following method within your form component:

->afterStateHydrated(function ($state, $record, Set $set): void {
    $set('location', ['lat' => $record?->latitude, 'lng' => $record?->longitude]);
})

Step 3: Add Form Fields for Latitude and Longitude

Add hidden form fields for latitude and longitude to your form. This ensures the values are present but not visible to the user:

TextInput::make('latitude')->hidden(),
TextInput::make('longitude')->hidden()

If you prefer to display these values in a read-only format, replace hidden() with readOnly().

Alternative Approach: Using a Single Location Attribute

If you prefer to handle the location as a single field, you can define a custom attribute in your model. This method avoids the need for separate latitude and longitude columns:

class YourModel extends Model
{
    protected function location(): Attribute
    {
        return Attribute::make(
            get: fn (mixed $value, array $attributes) => [
                'latitude' => $attributes['latitude'],
                'longitude' => $attributes['longitude']
            ],
            set: fn (array $value) => [
                'latitude' => $value['latitude'],
                'longitude' => $value['longitude']
            ],
        );
    }
}

This approach encapsulates both latitude and longitude within a single location attribute, streamlining your code.

Updates for version 1.4.0 and above

User can customize marker icons now, It is possible to use SVG or base64 encoded value

User can set the marker size using ->iconSize()

Example in how to use custom SVG Icon when "edit" a record from database

                   Map::make('location')
                       ->hiddenLabel()
                       ->columnSpanFull()
                       ->defaultLocation(latitude: 52.8027, longitude: -1.0546)
                       ->afterStateHydrated(function (callable $set, callable $get, $state, ?Model $record) {
                           if ($record) {
                               // Icon base64_encoded value
                               $icon = YourModel::find($record->databasefield)->base64_image;

                               $set('location', [
                                       'lat' => $record->lat,
                                       'lng' => $record->lon,
                                       'icon' => $icon //Insert this icon key with the value
                                   ]);
                           }
                       })
                       ->extraStyles(['min-height: 30vh', 'border-radius: 5px'])
                       ->liveLocation(false, false, 5000)
                       ->showMarker()
                       ->iconSize(32)
                       ->markerColor("#FF0000")
                       ->showGeomanToolbar(false)
                       ->showFullscreenControl(true)
                       ->showZoomControl()
                       ->draggable()
                       ->tilesUrl("https://tile.openstreetmap.de/{z}/{x}/{y}.png") // **Necessary from version below 1.6**
                       ->zoom(6)
                       ->detectRetina()
                       ->showMyLocationButton(false)
                       ->extraControl(['zoomDelta' => 1, 'zoomSnap' => 2]),

Another way to update in real time if you have a list of icons in a dropdown list You can display the icon in the list as well and use this icon to set as a marker in the map, like the example below.

                    Select::make('category_id')
                        ->label('Category')
                        ->suffixIcon('heroicon-s-square-3-stack-3d')
                        ->options(function () {
                            return YourModel::where('is_active', true)->get()
                                ->mapWithKeys(function ($item) {
                                    return [
                                        $item->id =>
                                        "<div style='display: flex; align-items: center;'>
                                            <img src='{$item->base64_image}' alt='category_icon' style='width: 20px; height: 20px; margin-right: 8px;' />
                                            <span>{$item->name}</span>
                                        </div>",
                                    ];
                                })
                                ->toArray();
                        })
                        ->searchable()
                        ->allowHtml()
                        ->required()
                        ->reactive()
                        ->afterStateUpdated(function ($state, callable $set, callable $get, $livewire){
                            $model = YourModel::find($state);
                            if($model && $model->iconcolumnname) {
                                $livewire->dispatch('updateMarkerIcon', ['icon' => $category->iconcolumnname]);
                            } else {
                               $livewire->dispatch('updateMarkerIcon',['icon' => null]) ;
                            }
                        }),

You can do it in your way, just call $livewire and pass the parameter 'updateMarkerIcon'

License

MIT License © Doode

Security

We take security seriously. If you discover any bugs or security issues, please help us maintain a secure project by reporting them through our GitHub issue tracker. You can also contact us directly at [email protected].

Contribution

We welcome contributions! contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request