layout.Image

Расширяет ILayout.

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

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

Конструктор

layout.Image(data)

Создает экземпляр макета-картинки.

Параметры:

Параметр

Значение по умолчанию

Описание

data*

Тип: ILayout

Данные макета.

data.options

Тип: ILayout

Опции макета.

data.options.imageClipRect

Тип: Number[][]

Координаты отображаемой области исходного изображения в пикселях.

data.options.imageHref

Тип: String

URL графического файла.

data.options.imageOffset

Тип: Number[]

Смещение картинки относительно точки привязки.

data.options.imageSize

Тип: Number[]

Размеры слоя с картинкой.

data.options.shape

Тип: IShape|Object

null

Фигура активной области. Может быть задана экземпляром класса, реализующего интерфейс IShape или JSON-описанием пиксельной геометрии иконки. Если не задана, то автоматически будет рассчитана прямоугольная фигура на основе размера и смещения картинки. Координаты геометрии фигуры отсчитываются от точки привязки.

* Обязательный параметр/опция.

Пример:

// Создадим круглую метку радиусом 20 пикселей.
var placemark = new ymaps.Placemark([59.936952, 30.343334], null, {
        iconLayout: 'default#image',
        iconImageHref: './images/roundImage.png',
        iconImageSize: [40, 40],
        iconImageOffset: [-20, -20],
           // Определим интерактивную область над картинкой.
        iconShape: {
            type: 'Circle',
            coordinates: [0, 0],
            radius: 20
        },
    });

Поля

Имя

Тип

Описание

events

IEventManager

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

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

События

Имя

Описание

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

emptinesschange

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

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

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

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

multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:

  • clientX - координата касания X относительно видимой области браузера;
  • clientY - координата касания Y относительно видимой области браузера;
  • pageX - координата касания X касания относительно начала документа;
  • pageY - координата касания Y касания относительно начала документа.

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

parentelementchange

Изменение родительского элемента. Экземпляр класса Event.

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

shapechange

Изменение фигуры области охватывающей макет. Экземпляр класса Event.

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

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса MapEvent. Более детальное описание доступно в domEvent.manager.

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

Методы

Имя

Возвращает

Описание

destroy()

Деструктор. Вызывается при завершении работы с макетом.

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

getData()

Object

Возвращает объект данных макета.

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

getParentElement()

HTMLElement

Возвращает родительский HTML-элемент.

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

getShape()

IShape|null

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

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

isEmpty()

Boolean

Возвращает true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие.

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

setData(data)

Задает данные макета.

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

setParentElement(parent)

Добавляет макет в DOM-дерево.

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

Предыдущая
Следующая