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

RouteInstructionBase.getTurnImage() method

Get turn image.

Signature:

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

Parameters

Parameter

Type

Description

{ size, format, allowResize }

(not declared)

input

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

input properties:

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

Returns:

Uint8Array | null

The turn image or null

Exceptions

An exception if it fails.