map.pane.Manager
Менеджер пейна карты. У каждой карты уже есть свой менеджер пейнов, доступный как map.panes. Не создавайте экземпляры этого класса без необходимости. Список ключей доступных по умолчанию пейнов карты и их zIndex'ы:
- 'ground': pane.MovablePane (zIndex: 100) — самый нижний пейн, предназначенный для размещения подложки карты;
- 'areas': pane.MovablePane (zIndex: 200) - панель для объектов с площадью, таких как многоугольники.
- 'shadows': pane.MovablePane (zIndex: 300) — пейн теней объектов карты, находящихся выше;
- 'places': pane.MovablePane (zIndex: 400) — пейн точечных объектов, таких как метки;
- 'events': pane.EventsPane (zIndex: 500) — пейн, предназначенный для слушания событий карты;
- 'overlaps': pane.MovablePane (zIndex: 600) — пейн для объектов, не требующих использования активных областей для реализации своей интерактивности;
- 'balloon': pane.MovablePane (zIndex: 700) — пейн балуна;
- 'outerBalloon': pane.MovablePane (zIndex: 800) — внешний пейн балуна;
- 'controls': pane.StaticPane (zIndex: 900) — пейн элементов управления карты;
- 'hint': pane.StaticPane (zIndex: 1100) — пейн всплывающей подсказки;
- 'outerHint': pane.StaticPane (zIndex: 1200) — внешний пейн всплывающей подсказки;
См.: Map.panes
Конструктор
map.pane.Manager(map)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Карта. |
* Обязательный параметр/опция.
Пример:
// Добавим водяной знак над контейнером карты.
// Для этого изменим background у контейнера событий.
map.panes.get('events').getElement().style.backgroundImage = 'my/background/image';
Методы
Имя |
Возвращает |
Описание |
Добавляет новый пейн в карту. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты. |
||
destroy() |
Деструктор. |
|
IPane|null |
Возвращает пейн карты с заданным ключом, либо null, если такой пейн в данной карте отсутствует. |
|
getLower() |
String |
Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого нижнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты. |
getUpper() |
String |
Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого верхнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты. |
Вставляет новый пейн перед другим пейном карты. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты. |
||
Удаляет пейн из карты. |
Описание методов
append
{} append(key, pane)
Добавляет новый пейн в карту. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String Ключ добавляемого пейна. |
|
— |
Тип: IPane Добавляемый пейн. |
* Обязательный параметр/опция.
destroy
{} destroy()
Деструктор.
get
{IPane|null} get(key)
Возвращает пейн карты с заданным ключом, либо null, если такой пейн в данной карте отсутствует.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String Ключ пейна. |
* Обязательный параметр/опция.
getLower
{String} getLower()
Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого нижнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты.
Возвращает ключ самого нижнего пейна карты.
getUpper
{String} getUpper()
Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого верхнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты.
Возвращает ключ самого верхнего пейна карты.
insertBefore
{} insertBefore(key, pane, referenceKey)
Вставляет новый пейн перед другим пейном карты. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: String Ключ добавляемого пейна. |
|
— |
Тип: IPane Добавляемый пейн. |
— |
Тип: String Ключ пейна, перед которым нужно добавить новый пейн. |
* Обязательный параметр/опция.
remove
{} remove(pane)
Удаляет пейн из карты.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: IPane Удаляемый пейн. |
* Обязательный параметр/опция.
Обязательный параметр.