control.ListBox
Расширяет ICollection, IControl, ICustomizable.
Класс для создания элемента управления в виде раскрывающегося списка. Стандартный макет выпадающего списка изменяет свой внешний вид в зависимости от размеров карты. Если карта имеет большую ширину, то в заголовке выпадающего списка отображается текст. Если карта небольшого размера, то в заголовке списка отображается только иконка. Если для кнопки не задана иконка, то во всех состояниях будет отображаться текст и наоборот.
Конструктор | Поля | События | Методы
Конструктор
control.ListBox([parameters])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Параметры выпадающего списка. |
|
— |
Тип: Object Данные. |
|
— |
Тип: String Заголовок списка. |
|
— |
Тип: String URL иконки кнопки. Стандартный макет кнопки рассчитан на иконку размером 16x16 пикселей. |
|
— |
Тип: String Текст всплывающей подсказки, которая появляется при наведении на список курсора мыши. |
|
— |
Тип: IControl[] Массив дочерних элементов списка. |
|
— |
Тип: Object Опции элемента управления. |
|
false |
Тип: Boolean Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager. |
|
true |
Тип: Boolean Флаг, включающий сворачивание списка, когда кнопка теряет фокус (например, когда пользователь кликнул на другом элементе страницы). |
|
true |
Тип: Boolean Флаг, разрешающий автоматическое разворачивание/сворачивание списка по клику. |
|
"right" |
Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position. |
|
0 |
Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". |
|
— |
Тип: Function|String Конструктор макета элемента управления, реализующий интерфейсы ISelectableControlLayout и IGroupControlLayout или ключ макета в хранилище layout.storage. В конструктор макета передается объект, содержащий поля:
|
|
90 |
Тип: Number|Number[] Максимальная ширина кнопки списка при различных состояниях. Если задано число, то считается, что кнопка имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина кнопки в различных состояниях - от меньшего к большему. Количество доступных состояний задается в экземпляре класса control.Manager через опцию states. Этот класс обычно является полем Map.controls. По умолчанию у элементов управления есть три состояния - ['small', 'medium', 'large']. |
|
— |
Тип: String Сторона, по которой нужно выравнивать попап элемента управления. Может принимать два значения: "left" и "right". По умолчанию определяется согласно опции "float". |
|
— |
Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". |
|
'auto' |
Тип: Number|String Положение относительно нижнего края карты. |
|
'auto' |
Тип: Number|String Положение относительно левого края карты. |
|
'auto' |
Тип: Number|String Положение относительно правого края карты. |
|
'auto' |
Тип: Number|String Положение относительно верхнего края карты. |
|
true |
Тип: Boolean Признак того, что элемент управления отображается. |
|
— |
Тип: Object Состояние выпадающего списка. |
|
false |
Тип: Boolean Признак, развернут ли список. |
Примеры:
1.
// Пример 1.
// Обработка нажатия на элементы списка.
var cityList = new ymaps.control.ListBox({
data: {
content: 'Выберите город'
},
items: [
new ymaps.control.ListBoxItem('Москва'),
new ymaps.control.ListBoxItem('Новосибирск'),
new ymaps.control.ListBoxItem({options: {type: 'separator'}}),
new ymaps.control.ListBoxItem('Нью-Йорк'),
]
});
cityList.get(0).events.add('click', function () {
map.setCenter([55.752736, 37.606815]);
});
cityList.get(1).events.add('click', function () {
map.setCenter([55.026366, 82.907803]);
});
cityList.get(3).events.add('click', function () {
map.setCenter([40.695537, -73.97552]);
});
map.controls.add(cityList, { floatIndex: 0 });
2.
// Пример 2
// Создание пользовательского списка.
// В этом примере используется jQuery, загруженный из http://yandex.st/jquery/1.6.4/jquery.min.js
// По умолчанию раскрывающийся список реагирует на событие" click " и автоматически
// изменяет свое состояние на расширенное или свернутое.
var MyListBoxLayout = ymaps.templateLayoutFactory.createClass(
'<div id="my-listbox-header" >{{ data.title }}</div >' +
// Этот элемент будет служить контейнером для дочерних элементов списка.
'<div id="my-list-box" style="display: {% if state.expanded %}block{% else %}none{% endif %};" >' +
'</div >', {
build: function() {
MyListBoxLayout.superclass.build.call(this);
this.childContainerElement = $('#my-list-box').get(0);
// Каждый раз, когда мы перестраиваемся, мы генерируем событие
// это означает, что контейнер для дочерних элементов изменился.
// Формат события описан в интерфейсе IGroupControlLayout.
this.events.fire('childcontainerchange', {
newChildContainerElement: this.childContainerElement,
oldChildContainerElement: null
});
},
// Переопределим метод, который требует интерфейс IGroupControlLayout.
getChildContainerElement: function () {
return this.childContainerElement;
}
}
),
// Создадим список и выставим созданный макет через опции.
listBox = new ymaps.control.ListBox({options: {layout: MyListBoxLayout}});
3.
// Пример 3.
// Использование элемента управления ListBox в качестве фильтра
// для отображения объектов на карте (поддерживается мультивыбор).
// Объекты добавляются на карту с помощью ObjectManager.
// Создание выпадающего списка с 5 элементами.
var listBoxItems = ['Школа', 'Аптека', 'Магазин', 'Больница', 'Бар']
.map(function(title) {
return new ymaps.control.ListBoxItem({
data: {
content: title
},
state: {
selected: true
}
});
});
// Теперь создаем выпадающий список из 5 пунктов.
var listBoxControl = new ymaps.control.ListBox({
data: {
content: 'Filter',
title: 'Filter'
},
items: listBoxItems,
state: {
// Указывает, что список расширен.
expanded: true,
filters: listBoxItems.reduce(function(filters, filter) {
filters[filter.data.get('content')] = filter.isSelected();
return filters;
}, {})
}
});
map.controls.add(listBoxControl);
// Добавление отслеживания к индикатору для проверки того, выбран ли элемент списка.
listBoxControl.events.add(['select', 'deselect'], function(e) {
var listBoxItem = e.get('target');
var filters = ymaps.util.extend({}, listBoxControl.state.get('filters'));
filters[listBoxItem.data.get('content')] = listBoxItem.isSelected();
listBoxControl.state.set('filters', filters);
});
// Отслеживание изменений в элементе управления.список.государственное поле.
var filterMonitor = new ymaps.Monitor(listBoxControl.state);
filterMonitor.add('filters', function(filters) {
// Применение фильтра к ObjectManager.
objectManager.setFilter(getFilterFunction(filters));
});
function getFilterFunction(categories){
return function(obj){
var content = obj.properties.balloonContent;
return categories[content]
}
}
Поля
Имя |
Тип |
Описание |
Данные выпадающего списка. Имена полей, доступных через метод data.Manager.get:
|
||
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от IControl. |
||
Состояние выпадающего списка. Имена полей, доступных через метод data.Manager.get:
|
События
Имя |
Описание |
Произошло добавление дочернего объекта. Унаследовано от ICollection. |
|
Щелчок по заголовку списка. Экземпляр класса Event. |
|
Список закрыт. Экземпляр класса Event. |
|
Список открыт. Экземпляр класса Event. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event. |
|
Произошло удаление дочернего объекта. Унаследовано от ICollection. |
Методы
Имя |
Возвращает |
Описание |
Добавляет в коллекцию дочерний объект. Унаследован от ICollection. |
||
collapse() |
Сворачивает список. |
|
expand() |
Раскрывает список. |
|
Возвращает итератор по коллекции. Унаследован от ICollection. |
||
getMap() |
Возвращает ссылку на карту. |
|
IControlParent|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IControl. |
|
Boolean |
Возвращает признак того, находится ли контрол в развернутом состоянии. |
|
Удаляет из коллекции дочерний объект. Унаследован от ICollection. |
||
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IControl. |
Описание полей
data
{data.Manager} data
Данные выпадающего списка. Имена полей, доступных через метод data.Manager.get:
- content - заголовок выпадающего списка;
- title - текст всплывающей подсказки, которая появляется при наведении на список курсора мыши.
Пример:
// Добавим на карту выпадающий список и будем менять его всплывающую подсказку
// в зависимости от того, свернут список или развернут.
// Создадим группу слушателей событий.
var listBoxListener = listBox.events.group()
.add('expand', function () {
listBox.data.set('title', 'Список развернут.');
})
.add('collapse', function () {
listBox.data.set('title', Список свернут.');
});
map.controls.add(listBox, {float: 'none', top: 10, left: 10});
// ...
map.controls.remove(listBox);
// После удаления элемента с карты удалим слушателей.
listBoxListener.removeAll();
state
{data.Manager} state
Состояние выпадающего списка. Имена полей, доступных через метод data.Manager.get:
- expanded - признак, раскрыт ли список;
- size - размер, который в данный момент выставлен списку;
Пример:
// Создадим и добавим на карту список, который изначально открыт.
var listBox = new ymaps.control.ListBox();
listBox.state.set('expanded', true);
map.controls.add(listBox);
Описание событий
click
Щелчок по заголовку списка. Экземпляр класса Event.
collapse
Список закрыт. Экземпляр класса Event.
expand
Список открыт. Экземпляр класса Event.
press
Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event.
Описание методов
collapse
{control.ListBox} collapse()
Сворачивает список.
Возвращает ссылку на себя.
expand
{control.ListBox} expand()
Раскрывает список.
Возвращает ссылку на себя.
getMap
{Map} getMap()
Возвращает ссылку на карту.
isExpanded
{Boolean} isExpanded()
Возвращает признак того, находится ли контрол в развернутом состоянии.