control.FullscreenControl
Расширяет control.Button.
Элемент управления "Полноэкранный режим". Задать свойство z-index контейнеру карты, находящейся в "полноэкранном режиме", можно с помощью опции Map.options.fullscreenZIndex. Ключ элемента управления в хранилище control.storage — "fullscreenControl".
Конструктор | Поля | События | Методы
Конструктор
control.FullscreenControl([parameters])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Параметры элемента управления. |
|
— |
Тип: Object Объект, описывающий данные элемента управления. |
|
— |
Тип: String Текст всплывающей подсказки, которая появляется при наведении на кнопку курсора мыши. |
|
— |
Тип: Object Опции элемента управления. |
|
false |
Тип: Boolean Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager. |
|
"right" |
Тип: String Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. |
|
300 |
Тип: Number Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". Также смотрите описание опции position. |
|
— |
Тип: ISelectableControlLayout|String Конструктор макета элемента управления, реализующий интерфейс ISelectableControlLayout или ключ макета в хранилище layout.storage. В конструктор макета передается объект, содержащий поля:
|
|
28 |
Тип: Number|Number[] Максимальная ширина элемента управления в различных состояниях. Если задано число, то считается, что элемент управления имеет одинаковые максимальные размеры во всех состояниях. Если задан массив, то он будет трактоваться как максимальная ширина в различных состояниях - от меньшего к большему. Количество доступных состояний задается в экземпляре класса control.Manager через опцию states. Этот класс обычно является полем Map.controls. По умолчанию у элементов управления есть три состояния - ['small', 'medium', 'large']. По умолчанию элемент управления не изменяет своего размера, всегда имея вид кнопки с иконкой. |
|
— |
Тип: Object Объект, описывающий позицию элемента управления. При указании опции position значение опции float автоматически трактуется как "none". |
|
'auto' |
Тип: Number|String Положение относительно нижнего края карты. |
|
'auto' |
Тип: Number|String Положение относительно левого края карты. |
|
'auto' |
Тип: Number|String Положение относительно правого края карты. |
|
'auto' |
Тип: Number|String Положение относительно верхнего края карты. |
|
true |
Тип: Boolean Признак того, что элемент управления отображается. |
|
— |
Тип: Object Объект, описывающий состояние элемента управления. |
|
true |
Тип: Boolean Признак, активна ли кнопка. |
|
false |
Тип: Boolean Признак, нажата ли кнопка. |
Пример:
// Добавим элемент управления на карту и сразу переведем
// её в «полноэкранный режим».
var fullscreenControl = new ymaps.control.FullscreenControl();
myMap.controls.add(fullscreenControl);
fullscreenControl.enterFullscreen();
Поля
Имя |
Тип |
Описание |
Данные кнопки. Имена полей, доступных через метод data.Manager.get:
Унаследовано от control.Button. |
||
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от IControl. |
||
Событие, сигнализирующее о том, что кнопка была нажата. В отличии от click генерируется только если состояние isEnabled == true. Экземпляр класса Event. Унаследовано от control.Button. |
||
Состояние элемента управления. Имена полей, доступных через метод data.Manager.get:
|
События
Имя |
Описание |
Нажатие на кнопку. Экземпляр класса Event. Унаследовано от control.Button. |
|
Элемент управления не выбран. Унаследовано от ISelectableControl. |
|
Элемент управления стал недоступным. Унаследовано от ISelectableControl. |
|
Элемент управления стал доступным. Унаследовано от ISelectableControl. |
|
Карта переключена в полноэкранный режим. Экземпляр класса Event. |
|
Карта вышла из полноэкранного режима. Экземпляр класса Event. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
|
Элемент управления выбран. Унаследовано от ISelectableControl. |
Методы
Имя |
Возвращает |
Описание |
deselect() |
Отменяет выбор элемента управления (выключает). Унаследован от ISelectableControl. |
|
disable() |
Делает элемент управления недоступным (запрещены пользовательские действия). Унаследован от ISelectableControl. |
|
enable() |
Делает элемент управления доступным (разрешены пользовательские действия). Унаследован от ISelectableControl. |
|
Позволяет переводить карту в полноэкранный режим. |
||
Позволяет вывести карту из полноэкранного режима. |
||
getMap() |
Возвращает ссылку на карту. Унаследован от control.Button. |
|
IControlParent|null |
Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен. Унаследован от IControl. |
|
Boolean |
Возвращает true - элемент управления доступен, false - недоступен. Унаследован от ISelectableControl. |
|
Boolean |
Возвращает true - элемент управления выбран, false - не выбран. Унаследован от ISelectableControl. |
|
select() |
Выбирает (включает) элемент управления. Унаследован от ISelectableControl. |
|
Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта. Унаследован от IControl. |
Описание полей
state
{data.Manager} state
Состояние элемента управления. Имена полей, доступных через метод data.Manager.get:
- fullscreen — признак, находится ли карта в полноэкранном режиме.
Описание событий
fullscreenenter
Карта переключена в полноэкранный режим. Экземпляр класса Event.
fullscreenexit
Карта вышла из полноэкранного режима. Экземпляр класса Event.
Описание методов
enterFullscreen
{} enterFullscreen()
Позволяет переводить карту в полноэкранный режим.
exitFullscreen
{} exitFullscreen()
Позволяет вывести карту из полноэкранного режима.