Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Journey

Hierarchy

  • default
    • Journey

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Journey(config: string): Journey

Properties

appKey

appKey: string

Methods

getModes

  • getModes():

journeyPlannerSearch

  • journeyPlannerSearch(from: string, to: string, via?: string, nationalSearch?: boolean, date?: string, time?: string, timeIs?: string, journeyPreference?: string, mode?: string[], accessibilityPreference?: string[], fromName?: string, toName?: string, viaName?: string, maxTransferMinutes?: string, maxWalkingMinutes?: string, walkingSpeed?: string, cyclePreference?: string, adjustment?: string, bikeProficiency?: string[], alternativeCycle?: boolean, alternativeWalking?: boolean, applyHtmlMarkup?: boolean, useMultiModalCall?: boolean, walkingOptimization?: boolean, taxiOnlyTrip?: boolean, routeBetweenEntrances?: boolean):

  • Perform a Journey Planner search from the parameters provided

    Parameters

    • from: string

      Origin of the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).

    • to: string

      Destination of the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).

    • Optional via: string

      Travel through point on the journey. Can be WGS84 coordinates expressed as "lat,long", a UK postcode, a Naptan (StopPoint) id, an ICS StopId, or a free-text string (will cause disambiguation unless it exactly matches a point of interest name).

    • Optional nationalSearch: boolean

      Does the journey cover stops outside London? eg. "nationalSearch=true"

    • Optional date: string

      The date must be in yyyyMMdd format

    • Optional time: string

      The time must be in HHmm format

    • Optional timeIs: string

      Does the time given relate to arrival or leaving time? Possible options: "departing" | "arriving"

    • Optional journeyPreference: string

      The journey preference eg possible options: "leastinterchange" | "leasttime" | "leastwalking"

    • Optional mode: string[]

      The mode must be an array of modes. eg possible options: ["public-bus,overground,train,tube,coach,dlr,cablecar,tram,river,walking,cycle"]

    • Optional accessibilityPreference: string[]

      The accessibility preference must be an array eg. ["noSolidStairs", "noEscalators", "noElevators", "stepFreeToVehicle", "stepFreeToPlatform"]

    • Optional fromName: string

      An optional name to associate with the origin of the journey in the results.

    • Optional toName: string

      An optional name to associate with the destination of the journey in the results.

    • Optional viaName: string

      An optional name to associate with the via point of the journey in the results.

    • Optional maxTransferMinutes: string

      The max walking time in minutes for transfer eg. "120"

    • Optional maxWalkingMinutes: string

      The max walking time in minutes for journeys eg. "120"

    • Optional walkingSpeed: string

      The walking speed. eg possible options: "slow" | "average" | "fast".

    • Optional cyclePreference: string

      The cycle preference. eg possible options: "allTheWay" | "leaveAtStation" | "takeOnTransport" | "cycleHire"

    • Optional adjustment: string

      Time adjustment command. eg possible options: "TripFirst" | "TripLast"

    • Optional bikeProficiency: string[]

      An array of cycling proficiency levels. eg possible options: ["easy,moderate,fast"]

    • Optional alternativeCycle: boolean

      Option to determine whether to return alternative cycling journey

    • Optional alternativeWalking: boolean

      Option to determine whether to return alternative walking journey

    • Optional applyHtmlMarkup: boolean

      Flag to determine whether certain text (e.g. walking instructions) should be output with HTML tags or not.

    • Optional useMultiModalCall: boolean

      A boolean to indicate whether or not to return 3 public transport journeys, a bus journey, a cycle hire journey, a personal cycle journey and a walking journey

    • Optional walkingOptimization: boolean

      A boolean to indicate whether to optimize journeys using walking

    • Optional taxiOnlyTrip: boolean

      A boolean to indicate whether to return one or more taxi journeys. Note, setting this to true will override "useMultiModalCall".

    • Optional routeBetweenEntrances: boolean

      A boolean to indicate whether public transport routes should include directions between platforms and station entrances.

    Returns

Generated using TypeDoc