Home > @magiclane/maps-sdk > ImgBase > getRenderableImage

ImgBase.getRenderableImage() method

Get the image as a RenderableImg

Signature:

abstract getRenderableImage(size?: {
        width: number;
        height: number;
    }, format?: ImageFileFormat): RenderableImg | undefined;

Parameters

Parameter

Type

Description

size

{ width: number; height: number; }

(Optional) The optional size as { width, height }

format

ImageFileFormat

(Optional) The image format (default: png)

size properties:

  • width: number
  • height: number

Returns:

RenderableImg | undefined

The renderable image or undefined if not valid