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

Home > @magiclane/maps-sdk > MapViewPathCollection > add

MapViewPathCollection.add() method

Add a path to the collection.

Signature:

add(path: Path, options?: {
        colorBorder?: Color;
        colorInner?: Color;
        szBorder?: number;
        szInner?: number;
    }): void;

Parameters

Parameter

Type

Description

path

Path

The path to be added.

options

{ colorBorder?: Color; colorInner?: Color; szBorder?: number; szInner?: number; }

(Optional) Optional object for path appearance: - colorBorder: The border color of the path. By default, the one from the current map view style is used. - colorInner: The inner color of the path. By default, the one from the current map view style is used. - szBorder: The border size of the path in mm. If < 0, the one from the current map view style is used. - szInner: The inner size of the path in mm. If < 0, the one from the current map view style is used.

options properties:

  • Optional colorBorder?: Color
  • Optional colorInner?: Color
  • Optional szBorder?: number
  • Optional szInner?: number

Returns:

void