Class PathSegment`Experimental`

A segment of a complete path. This can be a continuous portion of the path on a single floor, or the transition of a path between two floors, or a transition between indoors and outdoors.

Implements

IFocusable

Index

Constructors

Properties

Accessors

distance isConnectionSegment

Methods

Constructors

constructor

new PathSegment(id: string, coordinates: Coordinate[]): PathSegment
Experimental
Parameters
- id: string
- coordinates: Coordinate[]
Returns PathSegment

Properties

`Readonly` `Experimental`coordinates

coordinates: Coordinate[]

`Readonly` `Experimental`id

id: string

Accessors

distance

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

Returns number

isConnectionSegment

get isConnectionSegment(): boolean
Experimental
Whether the path segment is a connection segment between two floors.

Returns boolean

Methods

`Static`is

is(instance: object): instance is PathSegment
Experimental
Checks if the provided instance is a PathSegment.
Parameters
- instance: object
Returns instance is PathSegment