geojson 0.6.0
geojson: ^0.6.0 copied to clipboard
Utilities to work with geojson data. Parser with a reactive api, search and geofencing
Geojson #
Utilities to work with geojson data in Dart. Features:
- Parser with a reactive api: streams are available to retrieve the geojson features as soon as they are parsed
- Search: search for properties
- Geofencing: geofence points in a polygon or from a distance
Note: the data is parsed in an isolate to avoid slowing down the main thread
Simple functions #
featuresFromGeoJson: get a FeaturesCollection from geojson string data. Parameters:
data
: a string with the geojson data, requirednameProperty
: the property used for the geoserie name, automaticaly set if nullverbose
: print the parsed data if true
featuresFromGeoJsonFile: get a FeaturesCollection from a geojson file. Parameters:
file
: the file to load, requirednameProperty
: the property used for the geoserie name, automaticaly set if nullverbose
: print the parsed data if true
Reactive api #
Typed streams are available to retrieve the features as soon as they are parsed. Example: add assets on a Flutter map:
import 'dart:math' as math;
import 'package:pedantic/pedantic.dart';
import 'package:flutter/services.dart' show rootBundle;
import 'package:geojson/geojson.dart';
import 'package:flutter_map/flutter_map.dart';
/// Data for the Flutter map polylines layer
final lines = <Polyline>[];
Future<void> parseAndDrawAssetsOnMap() async {
final data = await rootBundle
.loadString('assets/railroads_of_north_america.geojson');
final geojson = GeoJson();
geojson.processedLines.listen((GeoJsonLine line) {
final color = Color((math.Random().nextDouble() * 0xFFFFFF).toInt() << 0)
.withOpacity(0.3);
setState(() => lines.add(Polyline(
strokeWidth: 2.0, color: color, points: line.geoSerie.toLatLng())));
});
geojson.endSignal.listen((_) => geojson.dispose());
unawaited(geojson.parse(data, verbose: true));
}
Check the examples for more details
Available streams #
processedFeatures
: the parsed features: all the geometriesprocessedPoints
: the parsed pointsprocessedMultipoints
: the parsed multipointsprocessedLines
: the parsed linesprocessedMultilines
: the parsed multilinesprocessedPolygons
: the parsed polygonsprocessedMultipolygons
: the parsed multipolygonsendSignal
: parsing is finished indicator
Search #
Search in a geojson file:
final geo = GeoJson();
await geo.searchInFile("countries.geojson",
query: GeoJsonQuery(
geometryType: GeoJsonFeatureType.multipolygon,
matchCase: false,
property: "name",
value: "Zimbabwe"),
verbose: true);
List<GeoJsonMultiPolygon> result = geo.multipolygons;
A search
method is also available, taking string data in parameter instead of a file path. The streams are available to retrieve the data as soon as it is found
Geofencing #
Geofence points within a distance of a given point:
final geo = GeoJson();
/// `point` is the [GeoJsonPoint] to search from
/// `points` is the list of [GeoJsonPoint] to search in
/// `distance` is the distance to search in meters
await geo.geofenceDistance(
point: point, points: points, distance: distance);
List<GeoPoint> foundPoints = geo.points;
Geofence points in a polygon:
final geo = GeoJson();
/// `polygon` is the [GeoJsonPolygon] to check
/// `points` is the list of [GeoJsonPoint] to search in
await geo.geofencePolygon(polygon: polygon, points: points);
List<GeoPoint> foundPoints = geo.points;
Note: the processedPoints
stream is available to retrieve geofenced points as soon as they are found
Supported geojson features #
All the data structures use GeoPoint and GeoSerie from the GeoPoint package to store the geometry data. Data structures used:
String
nameList<GeoJsonFeature>
collection
-
GeoJsonFeatureType
type: types -
Map<String, dynamic>
properties: the json properties of the feature -
dynamic
geometry: the geometry data, depends on the feature type, see below
String
nameGeoPoint
geoPoint: the geometry data
String
nameGeoSerie
geoSerie: the geometry data: this will produce a geoSerie of typeGeoSerieType.group
String
nameGeoSerie
geoSerie: the geometry data: this will produce a geoSerie of typeGeoSerieType.line
String
nameList<GeoJsonLine>
lines
String
nameList<GeoSerie>
geoSeries: the geometry data: this will produce a list of geoSerie of typeGeoSerieType.polygon
*
String
nameList<GeoJsonPolygon>
polygons
Note: none of the parameters is final for all of these data structures