Warning
Work in progress, not stable yet!
You can install the package via composer:
composer require swisnl/filament-geometry
Important This package requires Filament 4.x. For Filament 3.x compatibility, use version 0.3.x of this package.
In an effort to align with Filament's theming methodology you will need to use a custom theme to use this plugin.
Important
If you have not set up a custom theme and are using Filament Panels follow the instructions in the Filament Docs first.
After setting up a custom theme add the plugin's views to your theme css file or your app's css file if using the standalone packages.
@source '../../../../vendor/swisnl/filament-geometry/resources/**/*.blade.php';
The Geometry field displays a leaflet map, with a set of configuration options.
Important
This field is designed to be used in conjunction with a database column of type POINT
, LINESTRING
, POLYGON
or GEOMETRY
. It currently does not support geometry types with multiple items like MULTIPOINT
, MULTILINESTRING
, MULTIPOLYGON
or GEOMETRYCOLLECTION
. This field expects the attribute value to be a valid GeoJSON string. Make sure your model attribute stores and retrieves GeoJSON data as a string.
The form field can be used with no options, by simply adding this to your Filament form schema:
use Swis\Filament\Geometry\Enums\DrawMode;
use Swis\Filament\Geometry\Forms\Geometry;
...
->schema[
...
Geometry::make('location')
->drawModes([
DrawMode::Marker,
DrawMode::Polygon,
DrawMode::Polyline,
DrawMode::Rectangle,
]),
...
]
The full set of options is as follows. Some option methods support closures, as well as direct values.
use Swis\Filament\Geometry\Bounds;
use Swis\Filament\Geometry\Enums\ControlPosition;
use Swis\Filament\Geometry\Enums\DrawMode;
use Swis\Filament\Geometry\Forms\Geometry;
use Swis\Filament\Geometry\Icons\Marker;
use Swis\Filament\Geometry\TileLayers\Carto;
...
Geometry::make('location')
->label(__('Location'))
// Map configuration
->maxZoom(16)
->minZoom(4)
->center(52.164206390898904, 4.491920969490259)
->zoom(15)
->bounds(Bounds::make(49.5, -11, 61, 2)) // Example for British Isles
->tileLayer(Carto::make())
// Marker configuration
->markerIcon(Marker::make('#3b82f6'))
// Controls
->showFullscreenControl(true)
->showZoomControl(true)
->showAttributionControl(true)
->drawModes([
DrawMode::Polygon,
DrawMode::Rectangle,
])
->drawControlPosition(ControlPosition::TopRight)
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
SWIS is a web agency from Leiden, the Netherlands. We love working with open source software.