@magiclane/maps-sdk
↑↓ Navigate ⏎ Open Esc Close

Home > @magiclane/maps-sdk > RouteInstructionBase > getRoadInfoImage

RouteInstructionBase.getRoadInfoImage() method

Get road image.

Signature:

getRoadInfoImage(input: {
        size?: Size;
        format?: ImageFileFormat;
        backgroundColor?: Color;
        allowResize?: boolean;
    }): Uint8Array | null;

Parameters

Parameter

Type

Description

{ size, format, backgroundColor, allowResize, }

(not declared)

input

{ size?: Size; format?: ImageFileFormat; backgroundColor?: Color; allowResize?: boolean; }

input properties:

  • Optional size?: Size
  • Optional format?: ImageFileFormat
  • Optional backgroundColor?: Color
  • Optional allowResize?: boolean

Returns:

Uint8Array | null

RoadInfo Image or null

Exceptions

An exception if it fails.