Overlay day and night regions on a Leaflet Earth map.
Leaflet.Terminator extends the Polygon class. Adding the terminator to a leaflet map is as easy as
var map = L;L
Or with npm:
;;var map = L;
In addition to all Polygon options, Leaflet.Terminator has a new
resolution, which gives the step size at which the terminator
points are computed. The step size is 1°/resolution, i.e. higher
resolution values have smaller step sizes and more points in the
polygon. The default value is 2.
You can pass the
time option in the constructor or use the
method to control the reference time and date for the terminator; the
value can be anything accepted by the
Date() constructor. By default,
the current time will be used.
In the same way, you can use the
setTime() method without an argument
to refresh the terminator to the current time. This can be done
automatically, for example using a timer:
var map = L;var terminator = L;; // Every minute
If you don't like background timers running even when the page is inactive, you can also set the terminator to be refreshed only when the user interacts with the map:
var map = L;var terminator = L;map;
You can customize and complete this code by listing additional map interaction events, described in the Leaflet documentation.