control.ListBox

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

Класс для создания элемента управления в виде раскрывающегося списка. Стандартный макет выпадающего списка изменяет свой внешний вид в зависимости от размеров карты. Если карта имеет большую ширину, то в заголовке выпадающего списка отображается текст. Если карта небольшого размера, то в заголовке списка отображается только иконка. Если для кнопки не задана иконка, то во всех состояниях будет отображаться текст и наоборот.

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

Конструктор

control.ListBox([parameters])

Параметры:

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

Тип: Object

Параметры выпадающего списка.

parameters.data

Тип: Object

Данные.

parameters.data.content

Тип: String

Заголовок списка.

parameters.data.image

Тип: String

URL иконки кнопки. Стандартный макет кнопки рассчитан на иконку размером 16x16 пикселей.

parameters.data.title

Тип: String

Текст всплывающей подсказки, которая появляется при наведении на список курсора мыши.

parameters.items

Тип: IControl[]

Массив дочерних элементов списка.

parameters.options

Тип: Object

Опции элемента управления.

parameters.options.adjustMapMargin false

Тип: Boolean

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

parameters.options.collapseOnBlur true

Тип: Boolean

Флаг, включающий сворачивание списка, когда кнопка теряет фокус (например, когда пользователь кликнул на другом элементе страницы).

parameters.options.expandOnClick 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.layout

Тип: Function|String

Конструктор макета элемента управления, реализующий интерфейсы ISelectableControlLayout и IGroupControlLayout или ключ макета в хранилище layout.storage. В конструктор макета передается объект, содержащий поля:
  • control - ссылка на элемент управления;
  • options - менеджер опций элемента управления control.ListBox.options;
  • data - менеджер данных элемента управления control.ListBox.data;
  • state - менеджер состояния элемента управления control.ListBox.state.
Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей control.ListBox.state в зависимости от полученных команд.
parameters.options.maxWidth 90

Тип: Number|Number[]

Максимальная ширина кнопки списка при различных состояниях. Если задано число, то считается, что кнопка имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина кнопки в различных состояниях - от меньшего к большему. Количество доступных состояний задается в экземпляре класса control.Manager через опцию states. Этот класс обычно является полем Map.controls. По умолчанию у элементов управления есть три состояния - ['small', 'medium', 'large'].

parameters.options.popupFloat

Тип: String

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

parameters.options.position

Тип: Object

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

parameters.options.position.bottom 'auto'

Тип: Number|String

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

parameters.options.position.left 'auto'

Тип: Number|String

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

parameters.options.position.right 'auto'

Тип: Number|String

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

parameters.options.position.top 'auto'

Тип: Number|String

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

parameters.options.visible true

Тип: Boolean

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

parameters.state

Тип: Object

Состояние выпадающего списка.

parameters.state.expanded false

Тип: Boolean

Признак, развернут ли список.

Примеры:

1.

// Пример 1.
// Обработка клика на элементах списка.
var cityList = new ymaps.control.ListBox({
        data: {
            content: 'Select a city'
        },
        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.

// Создадим массив элементов, на основе которых будет создан  выпадающий список.
var listBoxItems = ['Школа', 'Аптека', 'Магазин', 'Больница', 'Бар']
    .map(function(title) {
        return new ymaps.control.ListBoxItem({
            data: {
                content: title
            },
            state: {
                selected: true
            }
        });
    }),

// Создадим выпадающий список.
    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);
});

// Отслеживание изменения поля control.ListBox.state.
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 data.Manager
Данные выпадающего списка. Имена полей, доступных через метод data.Manager.get:
  • content - заголовок выпадающего списка;
  • title - текст всплывающей подсказки, которая появляется при наведении на список курсора мыши.
events IEventManager

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

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

options IOptionManager

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

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

state data.Manager
Состояние выпадающего списка. Имена полей, доступных через метод data.Manager.get:
  • expanded - признак, раскрыт ли список;
  • size - размер, который в данный момент выставлен списку;

События

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

Произошло добавление дочернего объекта.

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

click

Щелчок по заголовку списка. Экземпляр класса Event.

collapse

Список закрыт. Экземпляр класса Event.

expand

Список открыт. Экземпляр класса Event.

optionschange

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

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

parentchange

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

Поля данных:

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

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

press

Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event.

remove

Произошло удаление дочернего объекта.

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

Методы

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

ICollection

Добавляет в коллекцию дочерний объект.

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

collapse()

control.ListBox

Сворачивает список.

expand()

control.ListBox

Раскрывает список.

getIterator()

IIterator

Возвращает итератор по коллекции.

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

getMap()

Map

Возвращает ссылку на карту.

getParent()

IControlParent|null

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

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

isExpanded()

Boolean

Возвращает признак того, находится ли контрол в развернутом состоянии.

remove(object)

ICollection

Удаляет из коллекции дочерний объект.

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

setParent(parent)

IChildOnMap

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

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

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

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()

Возвращает признак того, находится ли контрол в развернутом состоянии.