Skip to main content

VPSLocationSourceConfig

wemap-sdk-js

Interface: VPSLocationSourceConfig

Configuration options for VPSLocationSource

Extends​

Properties​

maxAngleBearing?​

optional maxAngleBearing?: number

Maximum angle difference in radians between bearing and route direction

Inherited from​

LocationSourceOptions.maxAngleBearing

maxDistance?​

optional maxDistance?: number

Maximum distance in meters from route to consider a match

Inherited from​

LocationSourceOptions.maxDistance

useOrientationMatching?​

optional useOrientationMatching?: boolean

Whether to use orientation matching (defaults to true)

Inherited from​

LocationSourceOptions.useOrientationMatching

usePositionSmoother?​

optional usePositionSmoother?: boolean

Whether to use position smoothing (defaults to true)

Inherited from​

LocationSourceOptions.usePositionSmoother

useStrict?​

optional useStrict?: boolean

Whether to use strict map matching (defaults to false)

Inherited from​

LocationSourceOptions.useStrict

vps?​

optional vps?: object

VPS-specific configuration options

backgroundScan?​

optional backgroundScan?: boolean

If true, automatically start a new scan 30s after the last scan if no scan was triggered in between

backgroundScanIntervalMs?​

optional backgroundScanIntervalMs?: number

Interval in ms before triggering a background scan when no scan was triggered (default: 30000)

backgroundScanMaxDurationMs?​

optional backgroundScanMaxDurationMs?: number

How long background scanning keeps running on its own before it stops and waits for the user to scan again (default: 30 minutes, 0 to never stop).

Without it a page left open keeps scanning — and requesting — for as long as the tab lives. A manual VPSLocationSource.startScan re-arms it.

degradedLocationStateThreshold?​

optional degradedLocationStateThreshold?: number

Threshold for degraded location state (default: snippet providers.degradedWalkingDistanceMeters, else 50m)

maxScanDurationMs?​

optional maxScanDurationMs?: number

How long a single scan may keep requesting before giving up, in ms (default: 120000, 0 to never give up).

noPositioningLocationStateThreshold?​

optional noPositioningLocationStateThreshold?: number

Threshold for no positioning location state (default: snippet providers.noPositioningWalkingDistanceMeters, else 100m)

wallCrossing?​

optional wallCrossing?: object

How walking through a wall affects the location state. Left out, walls are never tested and none are fetched.

enabled?​

optional enabled?: boolean

Whether to test walks against walls (if not provided, will use CoreConfig).

locationImpact?​

optional locationImpact?: "degraded" | "no_positioning"

State a crossing settles on until the next successful scan (if not provided, will use CoreConfig, which defaults to degraded).

walls?​

optional walls?: Map<number, WallSegment[]>

Walls to test the walk against, per level. Left empty, the walls of the venue the first fix lands in are fetched from the API instead.