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

Home > @magiclane/maps-sdk > SignpostDetails > getImage

SignpostDetails.getImage() method

Signature:

getImage(options?: {
        size?: Size;
        format?: ImageFileFormat;
        renderSettings?: SignpostImageRenderSettings;
        allowResize?: boolean;
    }): Uint8Array | null;

Parameters

Parameter

Type

Description

options

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

(Optional)

options properties:

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

Returns:

Uint8Array | null