Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

IRoutePanel

Interface for route panel.

Constructor | Fields | Methods

Constructor

IRoutePanel()

Fields

NameTypeDescription
optionsIOptionManager

Option manager. Names of options:

  • allowSwitch: Boolean = true - Whether button for switching way points should be shown.
  • reverseGeocoding: Boolean = true - Whether reverse geocoding should be enabled during routing.
  • adjustMapMargin: Boolean = false - Whether the panel registers its size in the map margins manager map.margin.Manager.

stateIDataManager

State manager. Names of states:

  • type: String - Routing type IMultiRouteParams.routingMode.
  • fromEnabled: Boolean - Enables the "from" field for users to enter the route origin.
  • from: String - Address or coordinates of departure.
  • toEnabled: Boolean - Enables the "to" field for users to enter the route destination.
  • to: String - Address or coordinates of arrival.

Methods

NameReturnsDescription
getRoute()

multiRouter.MultiRoute

Returns built route.

switchPoints()

Switches points (and corresponding inputs).

Fields details

options

{IOptionManager} options

Option manager. Names of options:

  • allowSwitch: Boolean = true - Whether button for switching way points should be shown.
  • reverseGeocoding: Boolean = true - Whether reverse geocoding should be enabled during routing.
  • adjustMapMargin: Boolean = false - Whether the panel registers its size in the map margins manager map.margin.Manager.

state

{IDataManager} state

State manager. Names of states:

  • type: String - Routing type IMultiRouteParams.routingMode.
  • fromEnabled: Boolean - Enables the "from" field for users to enter the route origin.
  • from: String - Address or coordinates of departure.
  • toEnabled: Boolean - Enables the "to" field for users to enter the route destination.
  • to: String - Address or coordinates of arrival.

Methods details

getRoute

Returns built route.

switchPoints

{} switchPoints()

Switches points (and corresponding inputs).