Variable LocationFilterPolicyConst

Defines the filtering policy applied to incoming raw GPS samples before they are accepted, averaged, or rejected by the LocationFilter.

The filtering policy determines how aggressively the plugin removes noisy, inaccurate, or redundant location updates. It represents the first stage in the SDK’s data-quality pipeline — before Kalman smoothing, burst averaging, or other denoising steps are applied.

Choosing the correct policy depends on your app’s tolerance for jitter versus responsiveness:

• Fitness or vehicle-tracking apps often prefer stronger filtering.
• Survey or scientific apps may prefer capturing unmodified raw samples.

Profiles

Notes

• This policy affects only the SDK’s internal filtering pipeline. It does not modify the raw values returned to BackgroundGeolocation.onLocation.
• For more granular tuning, see LocationFilter.trackingAccuracyThreshold, LocationFilter.maxImpliedSpeed, and other LocationFilter fields.

Examples

Balanced default filtering:

BackgroundGeolocation.ready({
  geolocation: {
    filter: {
      policy: LocationFilterPolicy.Adjust
    }
  }
});
Copy

No filtering — capture all raw locations:

BackgroundGeolocation.ready({
  geolocation: {
    filter: {
      policy: LocationFilterPolicy.PassThrough
    }
  }
});
Copy

Maximum smoothing for analytics:

BackgroundGeolocation.ready({
  geolocation: {
    filter: {
      policy: LocationFilterPolicy.Conservative
    }
  }
});
Copy

See also

• GeoConfig.filter
• LocationFilter
• KalmanProfile