Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

overlay.html.Rectangle

Extends IOverlay.

HTML overlay for a rectangle. By default, the overlays have not been added to package.full (the standard set of modules). To create your own overlay instance, use overlay.storage.

Constructor | Fields | Events | Methods

Constructor

overlay.html.Rectangle(geometry[, data[, options]])

Parameters:

ParameterDefault valueDescription
geometry *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IPixelRectangleGeometry

Pixel geometry of a shape.

data

Type: Object

Data.

options

Type: Object

Overlay options.

options.cursor

Type: String

Cursor when the mouse is hovering.

options.fillColor

Type: String

Fill color graphics.style.color. An option of the standard rectangle layout.

options.fillImageHref

Type: String

Background image. When this option is enabled, the "fillColor" value is ignored. An option of the standard rectangle layout.

options.fillMethod 'stretch'

Type: String

Type of background fill. Accepts one of two values:

  • stretch - The background image stretches to fit the size of the overlay.
  • tile - The background image is repeated, without changing its size. This is similar to background-repeat in CSS. It can be used for filling a shape with a template.
An option of the standard rectangle layout.

options.fillOpacity

Type: Number

Fill transparency. An option of the standard rectangle layout.

options.interactivityModel 'default#geoObject'

Type: String

Interactivity model. Available keys and their values are listed in the description of interactivityModel.storage.

options.opacity

Type: Number

Overall transparency.

options.pane "areas"

Type: String

Container where the overlay will be placed.

options.strokeColor

Type: String

Line color graphics.style.color. An option of the standard rectangle layout.

options.strokeStyle

Type: Number[]|String

The outline style supported by the standard CSS border-style. An option of the standard rectangle layout.

options.strokeWidth

Type: Number

Line width. An option of the standard rectangle layout.

options.zIndex

Type: Number

The z-index of the element.

dataSet.options.borderRadius

Type: Number

Radius of rounded corners. An option of the standard rectangle layout.

* Mandatory parameter/option.

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IDomEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

Events

NameDescription
click

Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

contextmenu

Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

datachange

Data change. Data fields:

  • oldData - Old data.
  • newData - New data.

Inherited from IOverlay.

dblclick

Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

emptinesschange

Change to the empty overlay flag. Instance of the Event class.

Inherited from IOverlay.

geometrychange

Changed geometry. Data fields:

  • oldGeometry - Old pixel geometry.
  • newGeometry - New pixel geometry.

Inherited from IOverlay.

mapchange

Map reference changed. Data fields:

  • oldMap - Old map.
  • newMap - New map.

Inherited from IOverlay.

mousedown

Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseenter

Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseleave

Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mousemove

Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

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. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

multitouchend

End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface.

Inherited from IDomEventEmitter.

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.

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.

optionschange

Change to the object options.

Inherited from ICustomizable.

shapechange

Change to the shape of the area spanning the overlay. Instance of the Event class.

Inherited from IOverlay.

wheel

Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
getData()

Object

Returns the overlay data object.

Inherited from IOverlay.

getElement()

HTMLElement

Returns parent element of the rectangle layout.

getGeometry()

IPixelGeometry

Returns the current pixel geometry.

Inherited from IOverlay.

getLayout()

vow.Promise

Returns a promise object to return the rectangle layout.

getLayoutSync()

ILayout|null

Returns rectangle layout.

getMap()

Map|null

Returns reference to the current map.

Inherited from IOverlay.

getShape()

IShape|null

Returns a shape that defines the area spanning the overlay in global pixel coordinates, or null if it is not possible to plot the shape.

Inherited from IOverlay.

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 IOverlay.

setData(data)

Sets the overlay data.

Inherited from IOverlay.

setGeometry(geometry)

Sets the overlay pixel geometry.

Inherited from IOverlay.

setMap(map)

Sets the map on which to display the overlay.

Inherited from IOverlay.

Methods details

getElement

{HTMLElement} getElement()

Returns parent element of the rectangle layout.

getLayout

{vow.Promise} getLayout()

Returns a promise object to return the rectangle layout.

getLayoutSync

{ILayout|null} getLayoutSync()

Returns rectangle layout.