Class MapDirectionStep

constructor

• new MapDirectionStep(htmlDirections, segment, directionIndicator?): MapDirectionStep

• Create a new MapDirection with the specified direction indicator

  Parameters

  • htmlDirections: string

    the text that descripts this segment of the path

  • segment: WaypathSegment

    the WaypathSegment that this step represents

  • Optional directionIndicator: MapDirectionsIcon

    the direction indicated by this step

  Returns MapDirectionStep

getDirectionIcon

• getDirectionIcon(): MapDirectionsIcon

• Returns MapDirectionsIcon

  The direction indicated by this step

getDistance

• getDistance(): string

• Returns string

  A string representation of the length of this step, with the ‘ft’ appended

getDistanceRaw

• getDistanceRaw(): number

• Returns number

  The length represented by this step, in FEET

getFirstWaypoint

• getFirstWaypoint(): Waypoint

• Returns Waypoint

getInstructions

• getInstructions(): string

• Returns string

  The text that descripts this segment of the path

getLastWaypoint

• getLastWaypoint(): Waypoint

• Returns Waypoint

getSegment

• getSegment(): WaypathSegment

• Returns WaypathSegment

  The WaypathSegment that this step represents

setDirectionIcon

• setDirectionIcon(directionIcon): void

• Parameters

  • directionIcon: MapDirectionsIcon

    The direction indicated by this step

  Returns void

setDistance

• setDistance(distance): void

• Parameters

  • distance: string

    A string representation of the length of this step, with the ‘ft’ appended

  Returns void

setInstructions

• setInstructions(mInstructions): void

• Parameters

  • mInstructions: string

    set the text that descripts this segment of the path

  Returns void

setSegment

• setSegment(segment): void

• Parameters

  • segment: WaypathSegment

    the WaypathSegment that this step represents

  Returns void

toJSONObject

• toJSONObject(): {
      directionIcon: MapDirectionsIcon;
      distance: string;
      instructions: string;
      segment: {
          landmarks: Waypoint[];
          segmentLength: number;
          waypoints: readonly Waypoint[];
      };
  }

• Returns {
      directionIcon: MapDirectionsIcon;
      distance: string;
      instructions: string;
      segment: {
          landmarks: Waypoint[];
          segmentLength: number;
          waypoints: readonly Waypoint[];
      };
  }

  a JSON object representation of this object

  • directionIcon: MapDirectionsIcon

  • distance: string

  • instructions: string

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

    • landmarks: Waypoint[]

    • segmentLength: number

    • waypoints: readonly Waypoint[]

  Since

  1.1

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 directionIcon

distance

distanceRaw

instructions

Optional pathMeta

segment

Optional stepNumber