Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

multiRouter.masstransit.TransferSegmentModel

Note. The constructor of the multiRouter.masstransit.TransferSegmentModel class is hidden, as this class is not intended for autonomous initialization.

Extends IEventEmitter.

Data model for a transfer segment of a path on a public transport route. A segment of a path on a public transport route is part of a path from one stop to another.

Fields | Events | Methods

Creates the data model for a transfer segment of a path on a public transport route.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

geometrygeometry.base.LineString

Geometry of a segment.

pathmultiRouter.masstransit.PathModel

Reference to the parent model of the path.

propertiesdata.Manager

Segment data. The following fields are available:

  • index: Integer - The ordinal number of the segment in the array of segments of the corresponding route path.
  • type: String - Segment type identifier, which takes the value "transfer" for transfer segments.
  • text: String - Text description of the segment.
  • distance: Object - An object with the "text" and "value" fields that specifies the length of the segment in meters.
  • duration: Object - An object with the "text" and "value" fields that specifies the travel time of the segment in seconds.
  • lodIndex: Integer - The ordinal number of the first throughpoint of the segment in the full set of coordinates of the corresponding route path.

Events

NameDescription
update

Updating the model with new data. Instance of the Event class.

Methods

NameReturnsDescription
destroy(segmentJson)

Updates the state of the model.

getType()

String

Returns ID of the segment type. For transfer segments on public transport routes, it returns the string "transfer".

Fields details

geometry

Geometry of a segment.

path

Reference to the parent model of the path.

properties

{data.Manager} properties

Segment data. The following fields are available:

  • index: Integer - The ordinal number of the segment in the array of segments of the corresponding route path.
  • type: String - Segment type identifier, which takes the value "transfer" for transfer segments.
  • text: String - Text description of the segment.
  • distance: Object - An object with the "text" and "value" fields that specifies the length of the segment in meters.
  • duration: Object - An object with the "text" and "value" fields that specifies the travel time of the segment in seconds.
  • lodIndex: Integer - The ordinal number of the first throughpoint of the segment in the full set of coordinates of the corresponding route path.

Events details

update

Updating the model with new data. Instance of the Event class.

Methods details

destroy

{} destroy(segmentJson)

Updates the state of the model.

Parameters:

ParameterDefault valueDescription
segmentJson*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

JSON data.

* Mandatory parameter/option.

getType

{String} getType()

Returns ID of the segment type. For transfer segments on public transport routes, it returns the string "transfer".