Class RoutePainter

Constructors

constructor

Methods

remove render setBusLineColor setDashedLineColor setFilterByBuilding setFilterByVenue setIndoorLineColor setMarkerIconSize setMarkerIcons setOutdoorLineColor setStyle

Constructors

constructor

Methods

remove

render

  • render(path, markerLocations): void

  • Parameters

    • path: IRoutePath

      Route path from RouteService.search response.

    • markerLocations: [number, number][]

      Coordinate([lng, lat]) array of markers, order from beginning to end.

    Returns void

    Description

    Render route on the map.

setBusLineColor

  • setBusLineColor(color): this

  • Parameters

    • color: string

      The color type is a color in the sRGB color space. Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA. Predefined HTML colors names, like yellow and blue, are also permitted.

    Returns this

    Deprecated

    Use 'setStyle' instead.

    Description

    Set color of shuttle bus line.

setDashedLineColor

  • setDashedLineColor(color): this

  • Parameters

    • color: string

      The color type is a color in the sRGB color space. Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA. Predefined HTML colors names, like yellow and blue, are also permitted.

    Returns this

    Deprecated

    Use 'setStyle' instead.

    Description

    Set color of dashed lines which connected the start and end markers.

setFilterByBuilding

  • setFilterByBuilding(buildingId, ordinal): void

  • Parameters

    • buildingId: string

      {string | null | undefined}

    • ordinal: string

      {string | null | undefined}

    Returns void

    Description

    Filter paths' opacity by building and ordinal.

setFilterByVenue

  • setFilterByVenue(venueId, ordinal): void

  • Parameters

    • venueId: string

      {string | null | undefined}

    • ordinal: string

      {string | null | undefined}

    Returns void

    Description

    Filter paths' opacity by venue and ordinal.

setIndoorLineColor

  • setIndoorLineColor(color): this

  • Parameters

    • color: string

      The color type is a color in the sRGB color space. Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA. Predefined HTML colors names, like yellow and blue, are also permitted.

    Returns this

    Deprecated

    Use 'setStyle' instead.

    Description

    Set the route color of the indoor part.

setMarkerIconSize

  • setMarkerIconSize(size): this

  • Parameters

    • size: number

      number in range [0, ∞), default is 1.

    Returns this

    Deprecated

    Use 'setStyle' instead.

    Description

    Set all icons scale.

setMarkerIcons

  • setMarkerIcons(icons): Promise<void>

  • Parameters

    • icons: string[] | {
          from?: string;
          stops?: string[];
          to?: string;
      }

      {Array<string | null> | {from?: string | null; to?: string | null; stops?: Array<string | null> | null;}} Array of sprite names or URLs, or the object with specifying icon. Markers use images in order of icons array. First is as from-marker, last is as to-marker, the middles are as stop-markers. If icons array has only one element, all stop markers use this image. Image file must be in png, webp, or jpg format. Null means none image.

    Returns Promise<void>

    Deprecated

    Use 'setStyle' instead.

    Description

    Set image[s] of the stop marker[s].

setOutdoorLineColor

  • setOutdoorLineColor(color): this

  • Parameters

    • color: string

      The color type is a color in the sRGB color space. Formats: HTML-style hex values, RGB, RGBA, HSL, and HSLA. Predefined HTML colors names, like yellow and blue, are also permitted.

    Returns this

    Deprecated

    Use 'setStyle' instead.

    Description

    Set the route color of the outdoor part.

setStyle

  • setStyle(routeStyle): Promise<void>

  • Parameters

    • routeStyle: TRouteStyleOptions

      {TRouteStyleOptions | null} When null, reset to the initial style.

    Returns Promise<void>

    Description

    Set the style of the route.

Settings

Member Visibility

Theme

On This Page

constructorremoverendersetBusLineColorsetDashedLineColorsetFilterByBuildingsetFilterByVenuesetIndoorLineColorsetMarkerIconSizesetMarkerIconssetOutdoorLineColorsetStyle