Maps API for JavaScript Developer's Guide

H.mapevents.Pointer

Class Summary

This class represents a pointer on the map surface. A pointer in a platform-specific definition can refer to the mouse, touch, pen or any pointing device which can trigger browser events.

[ For full details, see the Class Details ]

Property Summary

Table 1. Properties
Properties
`static viewportX : {number}` This property holds the x-coordinate of the pointer in the map viewport
`static viewportY : {number}` This property holds the y-coordinate of the pointer in the map viewport
`static target : {(H.map.Object \| H.Map)}` This property holds the map object directly under the pointer. Its value can be `null` if the pointer is outside the map viewport.
`static id : {number}` This property holds the unique identifier of the pointer.
`static type : {string}` This property holds the identifier of the pointer type, which can be 'mouse', 'touch' or 'pen'.
`static dragTarget : {(H.map.Object \| H.Map)}` This property holds the object which is currently dragged by the pointer.
`static button : {H.mapevents.Pointer.Button}` This property indicates which pointing device button has changed.

Class Description

This class represents a pointer on the map surface. A pointer in a platform-specific definition can refer to the mouse, touch, pen or any pointing device which can trigger browser events.

Constructor Details

H.mapevents.Pointer(viewportX, viewportY, id, type, opt_button, opt_buttons)

Parameters:
viewportX:: {number}
: The pointer position on x-axis
viewportY:: {number}
: The pointer position on y-axis
id:: {number}
: unique The pointer identifier among currently available pointers
type:: {string}
: The identifier of the pointer type, which can be mouse', 'touch', 'pen'
opt_button:: {H.mapevents.Pointer.Button=} [optional]
: The identifier of the pointing device button that was used (whose state has changed)
opt_buttons:: {H.mapevents.Pointer.Buttons=} [optional]
: The pointing device buttons that is being pressed.

Property Details

static viewportX: {number}

This property holds the x-coordinate of the pointer in the map viewport

static viewportY: {number}

This property holds the y-coordinate of the pointer in the map viewport

static target: {(H.map.Object | H.Map)}

This property holds the map object directly under the pointer. Its value can be null if the pointer is outside the map viewport.

static id: {number}

This property holds the unique identifier of the pointer.

static type: {string}

This property holds the identifier of the pointer type, which can be 'mouse', 'touch' or 'pen'.

static dragTarget: {(H.map.Object | H.Map)}

This property holds the object which is currently dragged by the pointer.

static button: {H.mapevents.Pointer.Button}

This property indicates which pointing device button has changed.