control.RouteButton

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

Кнопка для построения маршрутов. При нажатии на кнопку появляется всплывающее окно, которое содержит поля ввода начальной и конечной точек маршрута. Элемент управления доступен в хранилище control.storage по ключу "routeButtonControl".

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

Конструктор

control.RouteButton([parameters])

Параметры:

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

Тип: Object

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

parameters.lazy true

Тип: Boolean

Если значение выставлено в true, будет включен режим ленивой загрузки – модули, которые необходимы для работы с маршрутизацией, начнут загружаться только тогда, когда пользователь впервые откроет панель.

parameters.options

Тип: Object

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

parameters.options.adjustMapMargin false

Тип: Boolean

Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager .

parameters.options.autofocus true

Тип: Boolean

Указывает, должна ли панель маршрутизации автоматически получать фокус при открытии всплывающего окна.

parameters.options.collapseOnBlur true

Тип: Boolean

Флаг, разрешающий сворачиваение панели при потере фокуса на элементе управления.

parameters.options.float "right"

Тип: String

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

parameters.options.floatIndex 0

Тип: Number

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

parameters.options.popupAnimate true

Тип: Boolean

Флаг, указыващий, использовать ли анимацию при раскрытии/сворачивании всплывающего окна.

parameters.options.popupFloat 'auto'

Тип: Boolean

Определяет, по какому краю кнопки будет выравниваться всплывающее окно. Может принимать значения:
  • 'auto' - всплывающее окно выравнивается в зависимости от своих размеров и размеров карты;
  • 'right' – всплывающее окно выравнивается по правому краю кнопки;
  • 'right' – всплывающее окно выравнивается по левому краю кнопки;
parameters.options.popupWidth '210px'

Тип: String

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

parameters.options.position

Тип: Object

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

parameters.options.position.bottom 'auto'

Тип: Number|String

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

parameters.options.position.left 10

Тип: Number|String

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

parameters.options.position.right 'auto'

Тип: Number|String

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

parameters.options.position.top 108

Тип: Number|String

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

parameters.options.size 'auto'

Тип: String

Параметр, отвечающий за внешний вид элемента управления. Может принимать значения:
  • 'auto' — макет автоматически изменяет свой внешний вид в зависимости от размеров карты и от количества добавленных элементов управления;
  • 'small' – всегда показывается только иконка элемента управления, независимо от размеров карты;
  • 'medium' – всегда отображается только подпись элемента управления;
  • 'large' – отображаются и иконка, и подпись.
parameters.options.visible true

Тип: Boolean

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

parameters.state

Тип: Object

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

parameters.state.expanded false

Тип: Boolean

Показывается ли панель маршрута в данный момент.

Примеры:

1.

// Пример 1.
// Создадим элемент управления "Маршруты" и добавим его на карту.
var routeButton = new ymaps.control.RouteButton({
    options: {
        size: "small"
    }
});
myMap.controls.add(routeButton);

2.

// Пример 2.
// Добавим элемент управления в левый угол карты 
// и зададим начальную и конечную точки маршрута.
myMap.controls.add('routeButtonControl', {
    size: "large",
    float: "left",
    floatIndex: 1000,
});
myMap.controls.get('routeButtonControl').routePanel.state.set({
    fromEnabled: false,
    from: "moscow",
    to: "saint petersburg",
    type: "auto"
});

Поля

Имя Тип Описание
events IEventManager

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

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

options IOptionManager

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

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

routePanel IRoutePanel

События

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

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

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

parentchange

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

Поля данных:

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

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

Методы

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

IControlParent |null

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

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

setParent (parent)

IChildOnMap

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

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

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

routePanel

{IRoutePanel} routePanel