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

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

LaneImg.getRenderableImage() method

Get the renderable image with custom settings

Signature:

getRenderableImage(size?: {
        width: number;
        height: number;
    }, format?: ImageFileFormat, renderSettings?: LaneImageRenderSettings, allowResize?: boolean): 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)

renderSettings

LaneImageRenderSettings

(Optional) Optional render settings

allowResize

boolean

(Optional) Whether to allow resizing (default: false)

size properties:

  • width: number
  • height: number

Returns:

RenderableImg | undefined

The renderable image or undefined if not valid