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

LandmarkCategory.getImage() method

Get the category image

Signature:

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

Parameters

Parameter

Type

Description

options

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

(Optional) Optional parameters for image generation

options properties:

  • Optional size?: Size

    Optional size of the image

  • Optional format?: ImageFileFormat

    Optional format of the image

  • Optional allowResize?: boolean

Returns:

Uint8Array | null

The category image if available, null otherwise