Interface Path

Class representing a path on the MapView.

Paths are used to indicate a route on the map and can be added and removed using Paths.add and Paths.remove.

interface Path {
    animation: Promise<void>;
    coordinates: Coordinate[];
    id: string;
    segments: PathSegment[];
    get distance(): number;
    toJSON(): {
        __type: string;
        coordinates: Coordinate[];
        id: string;
        segments: PathSegment[];
    };
}

Implements

IFocusable

Index

Properties

animation coordinates id segments

Accessors

Methods

Properties

animation

animation: Promise<void>

The promise that resolves when the current path animation is complete.

coordinates

coordinates: Coordinate[]

The coordinates of the path.

id

id: string

The path's id

`Experimental`segments

segments: PathSegment[]

The segments of the path.

Accessors

distance

get distance(): number
The distance of the path in meters.

Returns number

Methods

toJSON

toJSON(): {
    __type: string;
    coordinates: Coordinate[];
    id: string;
    segments: PathSegment[];
}
Returns {
    __type: string;
    coordinates: Coordinate[];
    id: string;
    segments: PathSegment[];
}