@cercalia/sdk
    Preparing search index...

    Interface RoutingOptions

    Options for route calculation

    interface RoutingOptions {
        alternatives?: number;
        avoidFerries?: boolean;
        avoidRealtime?: boolean;
        avoidTolls?: boolean;
        avoidTruckAxleWeight?: boolean;
        avoidTruckHeight?: boolean;
        avoidTruckLength?: boolean;
        avoidTruckWeight?: boolean;
        avoidTruckWidth?: boolean;
        blockFerries?: boolean;
        blockRealtime?: boolean;
        blockTruckAxleWeight?: boolean;
        blockTruckHeight?: boolean;
        blockTruckLength?: boolean;
        blockTruckWeight?: boolean;
        blockTruckWidth?: boolean;
        departureTime?: string;
        direction?: "forward" | "backward";
        endWindow?: string;
        net?: RouteNetwork;
        reorder?: boolean;
        report?: boolean;
        startWindow?: string;
        truckAxleWeight?: number;
        truckHeight?: number;
        truckLength?: number;
        truckMaxVelocity?: number;
        truckWeight?: number;
        truckWidth?: number;
        vehicleType?: VehicleType;
        weight?: RouteWeight;
    }
    Index

    Properties

    alternatives? avoidFerries? avoidRealtime? avoidTolls? avoidTruckAxleWeight? avoidTruckHeight? avoidTruckLength? avoidTruckWeight? avoidTruckWidth? blockFerries? blockRealtime? blockTruckAxleWeight? blockTruckHeight? blockTruckLength? blockTruckWeight? blockTruckWidth? departureTime? direction? endWindow? net? reorder? report? startWindow? truckAxleWeight? truckHeight? truckLength? truckMaxVelocity? truckWeight? truckWidth? vehicleType? weight?

    Properties

    alternatives?: number

    Number of alternative routes to calculate (1-3)

    avoidFerries?: boolean
    avoidRealtime?: boolean
    avoidTolls?: boolean
    avoidTruckAxleWeight?: boolean
    avoidTruckHeight?: boolean
    avoidTruckLength?: boolean
    avoidTruckWeight?: boolean
    avoidTruckWidth?: boolean
    blockFerries?: boolean
    blockRealtime?: boolean
    blockTruckAxleWeight?: boolean
    blockTruckHeight?: boolean
    blockTruckLength?: boolean
    blockTruckWeight?: boolean
    blockTruckWidth?: boolean
    departureTime?: string

    Departure time in ISO 8601 format (required for sptime/spmoney weights)

    direction?: "forward" | "backward"

    Calculate route forward or backward from origin

    endWindow?: string

    End of time window for optimization (HH:MM format)

    net?: RouteNetwork

    Network type for routing.

    • 'car': Standard car network (default for car/truck)
    • 'logistics': Truck network with restrictions (for truck)
    • 'espw': Spanish walking network
    • 'usaw': USA walking network
    reorder?: boolean

    Enable waypoint reordering for optimal route (TSP)

    report?: boolean
    startWindow?: string

    Start of time window for optimization (HH:MM format)

    truckAxleWeight?: number

    Truck axle weight in kg

    truckHeight?: number

    Truck height in cm

    truckLength?: number

    Truck length in cm

    truckMaxVelocity?: number

    Truck max velocity in km/h

    truckWeight?: number

    Truck total weight in kg

    truckWidth?: number

    Truck width in cm

    vehicleType?: VehicleType
    weight?: RouteWeight

    Settings

    Member Visibility

    On This Page

    Properties