LaneImageRenderSettings - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > LaneImageRenderSettings

LaneImageRenderSettings class

Rendering settings for lane guidance images in navigation instructions.

Configures the visual appearance of lane guidance images that show which lanes the driver should use for upcoming maneuvers. Controls the background color, active lane color (recommended lanes), and inactive lane color (lanes to avoid). All color properties default to optimal values: transparent background, white active lanes, and gray inactive lanes for clear visual distinction.

Signature:

export declare class LaneImageRenderSettings

Constructors

Constructor	Modifiers	Description
(constructor)(backgroundColor, activeColor, inactiveColor)		Creates lane guidance rendering settings with customizable colors. Initializes rendering settings for lane guidance images. All color parameters are optional and default to values optimized for clarity: transparent background, white for recommended lanes, and gray for non-recommended lanes.

Constructor

Modifiers

Description

(constructor)(backgroundColor, activeColor, inactiveColor)

Creates lane guidance rendering settings with customizable colors.

Initializes rendering settings for lane guidance images. All color parameters are optional and default to values optimized for clarity: transparent background, white for recommended lanes, and gray for non-recommended lanes.

Properties

Property	Modifiers	Type	Description
activeColor		Color
backgroundColor		Color
inactiveColor		Color

Methods

Method	Modifiers	Description
equals(other)		Checks equality with another instance.