Class WaypathSegment

constructor

• new WaypathSegment(options?, wp?, direction?): WaypathSegment

• Creates a new instance of this object

  Parameters

  • options: TurnByTurnDirectionOptions = ...

    options to use for generating directions

  • Optional wp: Waypoint

    the staring waypoint for this segment

  • Optional direction: DirectionIndicator

    the direction that this segment is relative to the previous one

  Returns WaypathSegment

addSegment

• addSegment(segment): WaypathSegment

• Adds a segment to the end of the current segment

  Parameters

  • segment: WaypathSegment

    the segment to combine with this one

  Returns WaypathSegment

addWaypoint

• addWaypoint(wp): void

• Adds a new waypoint to the end of this segmment

  Parameters

  • wp: Waypoint

    the waypoint to add

  Returns void

createStepUsingLastSegment

• createStepUsingLastSegment(lastSegment, info): MapDirectionStep

• Generates the directions that will be used to describe this segment of the path

  Parameters

  • lastSegment: WaypathSegment

  • info: CustomMapInfo

    custom labeling info

  Returns MapDirectionStep

  the directions that represent this segment

generateTurningInstructionsUpTo

• generateTurningInstructionsUpTo(stopNdx, last): string

• Parameters

  • stopNdx: number

  • last: WaypathSegment

  Returns string

generateTurningInstructionsWithLastSegment

• generateTurningInstructionsWithLastSegment(last): string

• Generates the initial prefix for the direction that tells which direction(s) to turn relative to the previous segment on the path

  Parameters

  • last: WaypathSegment

    the previous segment on the path

  Returns string

  the initial prefix that indicates which direction(s) to turn

getDirections

• getDirections(): DirectionIndicator[]

• Returns DirectionIndicator[]

  The list of directions for this step (left/right/straight)

getFirstWaypoint

• getFirstWaypoint(): Waypoint

• Returns Waypoint

  The last waypoint in this segment

getFloor

• getFloor(): number

• Returns number

  The floor of the building that this segment is located on.

getFloorId

• getFloorId(): string

• since 2.0.0

  Returns string

  The id for the MapBuildingFloor that the segment is on.

getLandmarks

• getLandmarks(): Waypoint[]

• Returns Waypoint[]

  A list of the landmarks that were identified when creating text directions for this segment

getLastWaypoint

• getLastWaypoint(): Waypoint

• Returns Waypoint

  The last waypoint in this segment

getOptions

• getOptions(): TurnByTurnDirectionOptions

• Returns TurnByTurnDirectionOptions

  The options to use when generating the directions for this segment

getParentSegment

• getParentSegment(): WaypathSegment

• If a segment is combined, it will have a parent segment that its waypoints were added to

  Returns WaypathSegment

  the parent segment or null if this segment doesn't have one

getRoundedSegmentLength

• getRoundedSegmentLength(): number

• Returns number

  The length of the segment, rounded to the nearest multiple of directionDistanceIncrement, in FEET

getSecondToLastWaypoint

• getSecondToLastWaypoint(): Waypoint

• Returns Waypoint

  The second to last waypoint in this segment

getSegmentLength

• getSegmentLength(): number

• Returns number

  The raw length of the segment, in METERS

getWaypointCount

• getWaypointCount(): number

• Returns number

  The number of waypoints in this segment. The minimum possible number is two.

getWaypoints

• getWaypoints(): readonly Waypoint[]

• Returns readonly Waypoint[]

  A list of all the waypoints that make up this segment.

isFirst

• isFirst(): boolean

• Returns boolean

  true if this segment is the first segment in the overall waypath.

isLast

• isLast(): boolean

• Returns boolean

  true if this segment is the last segment in the overall waypath.

setFirst

• setFirst(first): void

• Parameters

  • first: boolean

    true this segment is the first segment in the overall waypath.

  Returns void

setLandmarks

• setLandmarks(landmarks): void

• This will be overridden if you call createStepUsingLastSegment

  Parameters

  • landmarks: Waypoint[]

    new landmarks for this segment

  Returns void

setLast

• setLast(last): void

• Parameters

  • last: boolean

    true if this segment is the last segment in the overall waypath.

  Returns void

setOptions

• setOptions(options): void

• Parameters

  • options: TurnByTurnDirectionOptions

    The options to use when generating the directions for this segment

  Returns void

toJSONObject

• toJSONObject(): {
      landmarks: Waypoint[];
      segmentLength: number;
      waypoints: readonly Waypoint[];
  }

• Returns {
      landmarks: Waypoint[];
      segmentLength: number;
      waypoints: readonly Waypoint[];
  }

  a JSON object representation of this object

  • landmarks: Waypoint[]

  • segmentLength: number

  • waypoints: readonly Waypoint[]

  Since

  2.0

toJSONString

• toJSONString(): string

• Returns string

  a JSON string representation of this object

  Since

  2.0

toString

• toString(): string

• Returns string

  A string representation of this object

Optional subClass

waypoints