This is the documentation of version 1.0.0-rc.2. Go to the latest version, 1.0.0-rc.5.

Type Alias GetPositionEntryPointOption

GetPositionEntryPointOption: "main-when-available" | "ignore"

How to handle entry points when extracting a position from a place.

Entry points are specific access locations of a place, such as building entrances or parking lot entries.

Remarks

main-when-available - Returns the main entry point position if available, otherwise the default place position. Use it for routing, to direct vehicles to the correct entrance.
ignore - Always returns the default position of the place, typically the center point.

Example

// Get position preferring entry point for routing
const position = getPosition(place, { useEntryPoint: 'main-when-available' });

// Get center position ignoring entry points
const centerPos = getPosition(place, { useEntryPoint: 'ignore' });