@magiclane/maps-sdk
    Preparing search index...

    Class RouteSegment

    Hierarchy

    • RouteSegmentBase
      • RouteSegment
    Index

    Constructors

    constructor

    Properties

    _mapId _pointerId

    Accessors

    geographicArea incursCosts instructions isCommon pointerId summary timeDistance waypoints

    Methods

    dispose toEVRouteSegment toPTRouteSegment

    Constructors

    • Parameters

      • id: number
      • mapId: number

      Returns RouteSegment

    Properties

    Protected_mapId

    _mapId: number

    Protected_pointerId

    _pointerId: any

    Accessors

    • get geographicArea(): RectangleGeographicArea

      Get geographic area of the route

      Returns RectangleGeographicArea

      Geographic area covered by the route

      An exception if it fails.

    • get incursCosts(): boolean

      Check if traveling the route or route segment incurs cost to the user.

      Returns boolean

      True if the route incurs costs, false otherwise

      An exception if it fails.

    • get instructions(): RouteInstruction[]

      Get route instructions list.

      Returns RouteInstruction[]

      A list of route instructions for the route segment

      An exception if it fails.

    • get isCommon(): boolean

      Check if this segment is of common type.

      Returns boolean

      True if the segment is common type, false otherwise

      An exception if it fails.

    • get pointerId(): any

      Returns any

    • get summary(): string

      Get summary of the route segment.

      Returns string

      The summary of the route segment

      An exception if it fails.

    • get timeDistance(): TimeDistance

      Get length in meters and estimated travel time in seconds for the route / route segment.

      Returns TimeDistance

      TimeDistance object containing the time and distance information

      An exception if it fails.

    • get waypoints(): Landmark[]

      Returns Landmark[]

    Methods

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods