--- metadata: - name: generator content: Diplodoc Platform v5.64.2 alternate: - https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/layout.Image.md - https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/layout.Image.md - href: https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/layout.Image.md type: text/markdown title: Markdown version - href: https://yandex.com/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234 rel: describedby --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234 # layout.Image Extends [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md). Class for creating layouts containing a picture. [Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary) ## Constructor {#constructor-summary} ```javascript layout.Image(data) ``` Creates an instance of the picture layout. **Parameters:** #| || **Parameter** | **Default value** | **Description** || || [`data`](#param-data)[*](*star) | — | Type: [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md) Layout data. || || [`data.options`](#param-data.options) | — | Type: [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md) Layout options. || || [`data.options.imageClipRect`](#param-data.options.imageClipRect) | — | Type: Number[][] Coordinates of the display area of the original image, in pixels. || || [`data.options.imageHref`](#param-data.options.imageHref) | — | Type: String URL of the image file. || || [`data.options.imageOffset`](#param-data.options.imageOffset) | — | Type: Number[] Offset of the image relative to the anchor point. || || [`data.options.imageSize`](#param-data.options.imageSize) | — | Type: Number[] Dimensions of the image layer. || || [`data.options.shape`](#param-data.options.shape) | — | Type: [IShape](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IShape.md)\|Object\|null The hotspot shape. Can be set as an instance of a class that implements the IShape interface or a JSON description of the pixel geometry of the icon. If not set, the rectangular shape based on the size and offset of the icon will be calculated automatically. The coordinates of the figure geometry are counted from the anchor point. || |# \* Mandatory parameter/option. **Example:** ```javascript // Creating a round placemark with a 20-pixel radius. var placemark = new ymaps.Placemark([59.936952, 30.343334], null, { iconLayout: 'default#image', iconImageHref: './images/roundImage.png', iconImageSize: [40, 40], iconImageOffset: [-20, -20], // Defining a hotspot on top of the image. iconShape: { type: 'Circle', coordinates: [0, 0], radius: 20 }, }); ``` ## Fields {#properties-summary} #| || **Name** | **Type** | **Description** || || [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events). || |# ## Events {#events-summary} #| || **Name** | **Description** || || [click](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click). || || [contextmenu](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [dblclick](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). || || [emptinesschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-emptinesschange) | Change to the empty layout indicator. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-emptinesschange). || || [mousedown](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). || || [mouseleave](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [parentelementchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-parentelementchange) | Change to the parent element. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-parentelementchange). || || [shapechange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-shapechange) | Change to the shape of the area spanning the layout. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#event-shapechange). || || [wheel](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Methods {#methods-summary} #| || **Name** | **Returns** | **Description** || || [destroy](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#destroy)() | | Destructor. Called when activity with the layout is finished. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#destroy). || || [getData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getData)() | Object | Returns layout data object. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getData). || || [getParentElement](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getParentElement)() | HTMLElement | Returns parent HTML element. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getParentElement). || || [getShape](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getShape)() | [IShape](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IShape.md)\|null | Returns a shape that defines the area spanning the layout, or null if it is not possible to plot this shape. Coordinates of the shape's geometry should be calculated from the anchor point of the parent layout element. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#getShape). || || [isEmpty](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#isEmpty)() | Boolean | Returns true if the layout is empty, i.e. it does not have any content. This indicator is used for hiding empty objects such as hints, balloons, and others. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#isEmpty). || || [setData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setData)([data](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setData-param-data)) | | Sets layout data. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setData). || || [setParentElement](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setParentElement)([parent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setParentElement-param-parent)) | | Adds the layout to the DOM tree. Inherited from [ILayout](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ILayout.md#setParentElement). || |# [*star]: Mandatory parameter/option.