Flutter Geolocator Plugin

https://pub.dev/documentation/geolocator/latest/
Admin
A Flutter geolocation plugin that provides easy access to platform-specific location services,...
Tokens:4,295
Snippets:35
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Listen for Location Updates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

This code demonstrates how to subscribe to a stream of location updates using `getPositionStream`. It allows you to receive continuous position updates with configurable accuracy, distance filter, and time limits. The example prints the latitude and longitude of each update.

```dart
import 'package:geolocator/geolocator.dart';

final LocationSettings locationSettings = LocationSettings(
  accuracy: LocationAccuracy.high,
  distanceFilter: 100,
);
StreamSubscription<Position> positionStream = Geolocator.getPositionStream(locationSettings: locationSettings).listen(
    (Position? position) {
        print(position == null ? 'Unknown' : '${position.latitude.toString()}, ${position.longitude.toString()}');
    });

```

--------------------------------

### Get Current Position with Accuracy Settings

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

This example shows how to fetch the current device location with specific accuracy and distance filter settings. The `LocationSettings` class allows fine-tuning the location data received, such as high accuracy and a distance filter of 100 meters.

```dart
import 'package:geolocator/geolocator.dart';

final LocationSettings locationSettings = LocationSettings(
  accuracy: LocationAccuracy.high,
  distanceFilter: 100,
);

Position position = await Geolocator.getCurrentPosition(locationSettings: locationSettings);

```

--------------------------------

### Get Current Device Position with Permissions

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

This code snippet demonstrates how to get the current device's geographical position. It includes essential checks for location service enablement and requests necessary permissions from the user. If permissions are denied permanently, it returns an error.

```dart
import 'package:geolocator/geolocator.dart';

/// Determine the current position of the device.
///
/// When the location services are not enabled or permissions
/// are denied the `Future` will return an error.
Future<Position> _determinePosition() async {
  bool serviceEnabled;
  LocationPermission permission;

  // Test if location services are enabled.
  serviceEnabled = await Geolocator.isLocationServiceEnabled();
  if (!serviceEnabled) {
    // Location services are not enabled don't continue
    // accessing the position and request users of the 
    // App to enable the location services.
    return Future.error('Location services are disabled.');
  }

  permission = await Geolocator.checkPermission();
  if (permission == LocationPermission.denied) {
    permission = await Geolocator.requestPermission();
    if (permission == LocationPermission.denied) {
      // Permissions are denied, next time you could try
      // requesting permissions again (this is also where
      // Android's shouldShowRequestPermissionRationale 
      // returned true. According to Android guidelines
      // your App should show an explanatory UI now.
      return Future.error('Location permissions are denied');
    }
  }
  
  if (permission == LocationPermission.deniedForever) {
    // Permissions are denied forever, handle appropriately. 
    return Future.error(
      'Location permissions are permanently denied, we cannot request permissions.');
  } 

  // When we reach here, permissions are granted and we can
  // continue accessing the position of the device.
  return await Geolocator.getCurrentPosition();
}

```

--------------------------------

### Get Current Location with Geolocator

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Obtains the current geographical location of the device. This requires location permissions to be granted by the user.

```Dart
import 'package:geolocator/geolocator.dart';

Future<Position> getCurrentLocation() async {
  Position position = await Geolocator.getCurrentPosition(
    desiredAccuracy: LocationAccuracy.high
  );
  return position;
}
```

--------------------------------

### Request Foreground Service Location Permission (Android 14+)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Starting with Android 14 (SDK 34), add FOREGROUND_SERVICE_LOCATION to your AndroidManifest.xml if your app needs location updates while running a foreground service.

```xml
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />
```

--------------------------------

### Get Last Known Location with Geolocator

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Retrieves the last known location of the device using the Geolocator plugin. This is often faster than requesting a new location if the device has recently been used.

```Dart
import 'package:geolocator/geolocator.dart';

Future<Position> getLastKnownLocation() async {
  Position position = await Geolocator.getLastKnownPosition();
  return position;
}
```

--------------------------------

### Get Last Known Location

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

This snippet retrieves the last known location of the device that was recorded and stored. It uses the `getLastKnownPosition` method, which may return null if no location data is available on the device.

```dart
import 'package:geolocator/geolocator.dart';

Position? position = await Geolocator.getLastKnownPosition();

```

--------------------------------

### Get Location Accuracy Status

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Retrieves the current location accuracy setting (Approximate or Precise) for Android and iOS 14+. Returns `LocationAccuracyStatus.reduced` for approximate and `LocationAccuracyStatus.precise` for precise. Defaults to `reduced` if permission is not yet granted. On iOS 13 and below, it always returns `precise`.

```dart
import 'package:geolocator/geolocator.dart';

var accuracy = await Geolocator.getLocationAccuracy();

```

--------------------------------

### macOS: Location Usage Description

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

On macOS, to access the device's location, an NSLocationUsageDescription entry must be added to the Info.plist file. The string value should be a meaningful description for your app's context.

```xml
<key>NSLocationUsageDescription</key>
<string>This app needs access to location.</string>
```

--------------------------------

### iOS Location Usage Description

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Add the NSLocationWhenInUseUsageDescription key to your iOS Info.plist file to explain why your app needs location access when it is open.

```xml
<key>NSLocationWhenInUseUsageDescription</key>
<string>This app needs access to location when open.</string>
```

--------------------------------

### Enable AndroidX and Jetifier

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Configure your Android project to use AndroidX and Jetifier by adding these properties to your 'gradle.properties' file. This is required for geolocator plugin versions 5.0.0 and above.

```properties
android.useAndroidX=true
android.enableJetifier=true
```

--------------------------------

### Automate Background Location Bypass (iOS Podfile)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Automatically set the BYPASS_PERMISSION_LOCATION_ALWAYS=1 flag for the 'geolocator_apple' target by adding this post_install hook to your application's 'ios/Podfile'.

```ruby
post_install do |installer|
  installer.pods_project.targets.each do |target|
    if target.name == "geolocator_apple"
      target.build_configurations.each do |config|
        config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'BYPASS_PERMISSION_LOCATION_ALWAYS=1']
      end
    end
  end
end
```

--------------------------------

### Open Geolocator Settings

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Opens the application's settings or the device's location settings to allow the user to update permissions or enable location services. On iOS, both methods redirect to the main Settings app.

```dart
import 'package:geolocator/geolocator.dart';

await Geolocator.openAppSettings();
await Geolocator.openLocationSettings();
```

--------------------------------

### Listen to Continuous Location Updates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Subscribes to receive continuous updates of the device's location. This is useful for real-time tracking applications. Remember to cancel the subscription when no longer needed.

```Dart
import 'package:geolocator/geolocator.dart';

Stream<Position> getLocationStream() {
  var locationStream = Geolocator.getPositionStream(
    locationSettings: LocationSettings(
      accuracy: LocationAccuracy.high,
      distanceFilter: 100,
    )
  );
  return locationStream;
}
```

--------------------------------

### Configure Platform Specific Location Settings

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Sets platform-specific location settings for Android, iOS, macOS, and Web. Includes options for accuracy, distance filter, background notifications, and activity type. This configuration is then used with `getCurrentPosition` or `getPositionStream`.

```dart
import 'package:geolocator/geolocator.dart';
import 'package:geolocator_android/geolocator_android.dart';
import 'package:geolocator_android/geolocator_web.dart';
import 'package:geolocator_apple/geolocator_apple.dart';

late LocationSettings locationSettings;

if (defaultTargetPlatform == TargetPlatform.android) {
  locationSettings = AndroidSettings(
      accuracy: LocationAccuracy.high,
      distanceFilter: 100,
      forceLocationManager: true,
      intervalDuration: const Duration(seconds: 10),
      //(Optional) Set foreground notification config to keep the app alive 
      //when going to the background
      foregroundNotificationConfig: const ForegroundNotificationConfig(
        notificationText:
        "Example app will continue to receive your location even when you aren't using it",
        notificationTitle: "Running in Background",
        enableWakeLock: true,
      )
  );
} else if (defaultTargetPlatform == TargetPlatform.iOS || defaultTargetPlatform == TargetPlatform.macOS) {
  locationSettings = AppleSettings(
    accuracy: LocationAccuracy.high,
    activityType: ActivityType.fitness,
    distanceFilter: 100,
    pauseLocationUpdatesAutomatically: true,
    // Only set to true if our app will be started up in the background.
    showBackgroundLocationIndicator: false,
  );
} else if (kIsWeb) {
  locationSettings = WebSettings(
    accuracy: LocationAccuracy.high,
    distanceFilter: 100,
    maximumAge: Duration(minutes: 5),
  );
} else {
  locationSettings = LocationSettings(
    accuracy: LocationAccuracy.high,
    distanceFilter: 100,
  );
}

// supply location settings to getCurrentPosition
Position position = await Geolocator.getCurrentPosition(locationSettings: locationSettings);

// supply location settings to getPositionStream
StreamSubscription<Position> positionStream = Geolocator.getPositionStream(locationSettings: locationSettings).listen(
        (Position? position) {
      print(position == null ? 'Unknown' : '${position.latitude.toString()}, ${position.longitude.toString()}');
    });

```

--------------------------------

### Set Android Compile SDK Version

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Ensure your Android project's 'compileSdkVersion' is set to 35 in the 'android/app/build.gradle' file to support the geolocator plugin's requirements.

```gradle
android {
  compileSdkVersion 35

  ...
}
```

--------------------------------

### Request Geolocator Permission

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Requests permission from the user to access the device's location. The result indicates whether the permission was granted, denied, or denied permanently.

```dart
import 'package:geolocator/geolocator.dart';

LocationPermission permission = await Geolocator.requestPermission();
```

--------------------------------

### macOS: Temporary Full Accuracy Location Description

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Similar to iOS, when using requestTemporaryFullAccuracy() on macOS, a dictionary should be added to Info.plist. The key should match the purposeKey passed to the method, allowing for multiple keys for different features.

```xml
<key>NSLocationTemporaryUsageDescriptionDictionary</key>
<dict>
  <key>YourPurposeKey</key>
  <string>The example App requires temporary access to the device&apos;s precise location.</string>
</dict>
```

--------------------------------

### macOS: Location Services Entitlement

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

To declare the app's intent to use device location services and list it in System Preferences, the com.apple.security.personal-information.location entitlement must be added to DebugProfile.entitlements and Release.entitlements files.

```xml
<key>com.apple.security.personal-information.location</key>
<true/>
```

--------------------------------

### iOS: Temporary Full Accuracy Location Description

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

When requesting temporary full accuracy location, a dictionary must be added to Info.plist. The key should match the purposeKey passed to the requestTemporaryFullAccuracy() method. Multiple keys can be defined for different app features.

```xml
<key>NSLocationTemporaryUsageDescriptionDictionary</key>
<dict>
  <key>YourPurposeKey</key>
  <string>The example App requires temporary access to the device&apos;s precise location.</string>
</dict>
```

--------------------------------

### Request Coarse Location Permission (Android)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Add the ACCESS_COARSE_LOCATION permission to your AndroidManifest.xml for approximate location tracking. This is an alternative to ACCESS_FINE_LOCATION.

```xml
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
```

--------------------------------

### Listen for Location Service Status Changes

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Subscribes to a stream that provides updates on the status of location services. This allows the application to react to changes in whether location services are enabled or disabled.

```dart
import 'package:geolocator/geolocator.dart';

StreamSubscription<ServiceStatus> serviceStatusStream = Geolocator.getServiceStatusStream().listen(
    (ServiceStatus status) {
        print(status);
    });

```

--------------------------------

### Calculate Bearing Between Coordinates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Calculates the bearing (initial angle) in degrees between two geographical coordinates.

```dart
import 'package:geolocator/geolocator.dart';

double bearing = Geolocator.bearingBetween(52.2165157, 6.9437819, 52.3546274, 4.8285838);
```

--------------------------------

### Request Fine Location Permission (Android)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Add the ACCESS_FINE_LOCATION permission to your AndroidManifest.xml to enable precise location tracking. This permission is required for the geolocator plugin to function.

```xml
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
```

--------------------------------

### Request Background Location Permission (Android 10+)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

For Android 10 and above, include ACCESS_BACKGROUND_LOCATION in your AndroidManifest.xml to receive location updates when the app is in the background.

```xml
<uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
```

--------------------------------

### Calculate Bearing Between Coordinates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Determines the bearing (initial direction) in degrees between two geographical coordinates.

```Dart
import 'package:geolocator/geolocator.dart';

double calculateBearing(LatLng point1, LatLng point2) {
  double bearing = Geolocator.bearingBetween(
    point1.latitude,
    point1.longitude,
    point2.latitude,
    point2.longitude
  );
  return bearing;
}
```

--------------------------------

### Check if Location Services are Enabled

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Verifies whether the location services are enabled on the device. This is a prerequisite for obtaining location data.

```Dart
import 'package:geolocator/geolocator.dart';

Future<bool> areLocationServicesEnabled() async {
  bool serviceEnabled = await Geolocator.isLocationServiceEnabled();
  return serviceEnabled;
}
```

--------------------------------

### Bypass Background Location Permission (iOS)

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Set the BYPASS_PERMISSION_LOCATION_ALWAYS=1 preprocessor macro in Xcode's build settings for the 'geolocator_apple' target to avoid requiring NSLocationAlwaysAndWhenInUseUsageDescription.

```text
GCC_PREPROCESSOR_DEFINITIONS
```

--------------------------------

### Check Geolocator Permission

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Checks the current permission status for accessing the device's location. This method returns `LocationPermission.denied` on web platforms that do not support the Permissions API, but `getCurrentPosition` and `getPositionStream` may still function.

```dart
import 'package:geolocator/geolocator.dart';

LocationPermission permission = await Geolocator.checkPermission();
```

--------------------------------

### iOS: Background Location Updates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

To receive location updates in the background on iOS 16 and above, the 'location' value must be specified in the UIBackgroundModes array within Info.plist.

```xml
<key>UIBackgroundModes</key>
<array>
  <string>location</string>
</array>
```

--------------------------------

### Calculate Distance Between Coordinates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Computes the distance in meters between two geographical coordinates (latitude and longitude).

```Dart
import 'package:geolocator/geolocator.dart';

double calculateDistance(LatLng point1, LatLng point2) {
  double distance = Geolocator.distanceBetween(
    point1.latitude,
    point1.longitude,
    point2.latitude,
    point2.longitude
  );
  return distance;
}
```

--------------------------------

### iOS Location Accuracy Settings

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

On iOS, the LocationAccuracy enum maps to native Core Location accuracy settings. These settings control the accuracy of location data and its impact on battery consumption, ranging from kCLLocationAccuracyThreeKilometers to kCLLocationAccuracyBestForNavigation.

```Objective-C
kCLLocationAccuracyThreeKilometers
kCLLocationAccuracyKilometer
kCLLocationAccuracyHundredMeters
kCLLocationAccuracyNearestTenMeters
kCLLocationAccuracyBest
kCLLocationAccuracyBestForNavigation
```

--------------------------------

### Calculate Distance Between Coordinates

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Calculates the distance in meters between two geographical coordinates (latitude and longitude).

```dart
import 'package:geolocator/geolocator.dart';

double distanceInMeters = Geolocator.distanceBetween(52.2165157, 6.9437819, 52.3546274, 4.8285838);
```

--------------------------------

### Android Location Accuracy and Priority

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

On Android, the LocationAccuracy enum controls the desired accuracy and priority of location data. Different priority levels (PRIORITY_PASSIVE, PRIORITY_LOW_POWER, PRIORITY_BALANCED_POWER_ACCURACY, PRIORITY_HIGH_ACCURACY) are mapped to LocationAccuracy settings (lowest, low, medium, high) to balance power consumption and accuracy.

```Java
PRIORITY_PASSIVE
PRIORITY_LOW_POWER
PRIORITY_BALANCED_POWER_ACCURACY
PRIORITY_HIGH_ACCURACY
```

--------------------------------

### Check Location Service Enabled Status

Source: https://pub.dev/documentation/geolocator/latest/packages/geolocator

Checks if the device's location services are currently enabled. Returns a boolean value indicating the status.

```dart
import 'package:geolocator/geolocator.dart';

bool isLocationServiceEnabled  = await Geolocator.isLocationServiceEnabled();

```
Tokens:
Raw