control.RoutePanel

Расширяет IControl, ICustomizable.

Панель маршрутизации. Ключ в хранилище control.storage – 'routePanelControl'.

Конструктор | Поля | События | Методы

Конструктор

control.RoutePanel([parameters])

Параметры:

ПараметрЗначение по умолчаниюОписание
parameters

Тип: Object

Параметры элемента управления.

parameters.options

Тип: Object

Опции элемента управления. Для задания основных опций IRoutePanel используйте префикс 'routePanel'. Обратите внимание, параметр routePanelAdjustMapMargin по умолчанию принимает значение true.

parameters.options.autofocustrue

Тип: Boolean

Должна ли панель автоматически получать фокус после ее добавления на карту.

parameters.options.float"left"

Тип: String

Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position.

parameters.options.floatIndex0

Тип: Number

Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none".

parameters.options.maxWidth'210px'

Тип: String

CSS-ширина всплывающего окна. Может задаваться как в пикселях, так и в процентах. Обратите внимание, что если указывать в процентах, ширина будет определяться относительно размеров кнопки, а не карты. Минимальное значение 176px, максимальное – 400px.

parameters.options.position

Тип: Object

Объект, описывающий позицию элемента управления.

parameters.options.position.bottom

Тип: Number|String

Положение относительно нижнего края карты.

parameters.options.position.left

Тип: Number|String

Положение относительно левого края карты.

parameters.options.position.right

Тип: Number|String

Положение относительно правого края карты.

parameters.options.position.top

Тип: Number|String

Положение относительно верхнего края карты.

parameters.options.showHeaderfalse

Тип: Boolean

Показывать ли заголовок панели.

parameters.options.title'Routes'

Тип: String

Заголовок панели. Отображается только в том случае, если опция 'showHeader' выставлена в true.

parameters.options.visibletrue

Тип: Boolean

Признак того, что элемент управления отображается.

parameters.state

Тип: Object

Объект, описывающий состояние элемента управления.

Примеры:

1.

// Пример 1.
// Добавим на карту панель маршрутизации.
myMap.controls.add('routePanelControl')

2.

// Пример 2
// Создадим панель маршрутизации шириной в 300 пикселей.
// В качестве заголовка панели установим начальную точку.  
myMap.controls.add('routePanelControl', {
    maxWidth: 300,
});
var routePanel = myMap.controls.get('routePanelControl').routePanel;
routePanel.options.set('adjustMapMargin', true);
routePanel.state.set({
    fromEnabled: false,
    from: "Москва",
    to: "Санкт-Петербург",
    type: "auto"
});

Поля

ИмяТипОписание
eventsIEventManager

Менеджер событий.

Унаследовано от IEventEmitter.

optionsIOptionManager

Менеджер опций.

Унаследовано от IControl.

routePanelIRoutePanel

Панель маршрутизации.

События

ИмяОписание
optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable.

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

Унаследовано от IChild.

Методы

ИмяВозвращаетОписание
getParent()

IControlParent|null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от IControl.

setParent(parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от IControl.

Описание полей

routePanel

{IRoutePanel} routePanel

Панель маршрутизации.