DayPilot.Calendar.getCoords

The getCoords() method returns information about the current mouse cursor position (relative to the Calendar grid).

Available since 2023.3.5726.

Syntax

DayPilot.Calendar.getCoords();

Return Value

An object with the following properties:

  • x (number) - horizontal position in pixels

  • y (number) - vertical position in pixels

  • time (DayPilot.Date object) - exact date/time corresponding to the current position

  • column - current column (DayPilot.Column object)

It returns null if the current position cannot be read (e.g. mouse is outside of the grid).