io.data2viz.timer

Class TimerKt

io.data2viz.timer.TimerKt

public class TimerKt

Method Summary

Modifier and Type	Method and Description
static Timer	interval(double delay, double startTime, kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback)
static double	now() Returns the current time as defined by performance.now (elapsed time since document creation) if available, and Date.now if not (elapsed time since 1970/01/01 00:00:00).
static Timer	timeout(double delay, double startTime, kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback) Like timer, except the timer automatically stops on its first callback. A suitable replacement for setTimeout that is guaranteed to not run in the background. The callback is passed the elapsed time.
static Timer	timer(double delay, double startTime, kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback) Schedules a new timer, invoking the specified callback repeatedly until the timer is stopped.
static void	timerFlush() Immediately invoke any eligible timer callbacks. Note that zero-delay timers are normally first executed after one frame (~17ms). This can cause a brief flicker because the browser renders the page twice: once at the end of the first event loop, then again immediately on the first timer callback. By flushing the timer queue at the end of the first event loop, you can run any zero-delay timers immediately and avoid the flicker.

Method Detail

timer

public static Timer timer(double delay,
                          double startTime,
                          kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback)

Schedules a new timer, invoking the specified callback repeatedly until the timer is stopped.

An optional numeric delay in milliseconds may be specified to invoke the given callback after a delay; if delay is not specified, it defaults to zero.

The delay is relative to the specified time in milliseconds; if time is not specified, it defaults to now.

The callback is passed the (apparent) elapsed time since the timer became active.

(The exact values may vary depending on your JavaScript runtime and what else your computer is doing.)

Note that the first elapsed time is 3ms: this is the elapsed time since the timer started, not since the timer was scheduled. Here the timer started 150ms after it was scheduled due to the specified delay. The apparent elapsed time may be less than the true elapsed time if the page is backgrounded and requestAnimationFrame is paused; in the background, apparent time is frozen.If timer is called within the callback of another timer, the new timer callback (if eligible as determined by the specified delay and time) will be invoked immediately at the end of the current frame, rather than waiting until the next frame. Within a frame, timer callbacks are guaranteed to be invoked in the order they were scheduled, regardless of their start time.

timeout

public static Timer timeout(double delay,
                            double startTime,
                            kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback)

Like timer, except the timer automatically stops on its first callback. A suitable replacement for setTimeout that is guaranteed to not run in the background. The callback is passed the elapsed time.

interval

public static Timer interval(double delay,
                             double startTime,
                             kotlin.jvm.functions.Function2<? super io.data2viz.timer.Timer,? super java.lang.Double,kotlin.Unit> callback)

now

public static double now()

Returns the current time as defined by performance.now (elapsed time since document creation) if available, and Date.now if not (elapsed time since 1970/01/01 00:00:00).

The current time is updated at the start of a frame; it is thus consistent during the frame, and any timers scheduled during the same frame will be synchronized.

If this method is called outside of a frame, such as in response to a user event, the current time is calculated and then fixed until the next frame, again ensuring consistent timing during event handling.

timerFlush

public static void timerFlush()

Immediately invoke any eligible timer callbacks. Note that zero-delay timers are normally first executed after one frame (~17ms). This can cause a brief flicker because the browser renders the page twice: once at the end of the first event loop, then again immediately on the first timer callback. By flushing the timer queue at the end of the first event loop, you can run any zero-delay timers immediately and avoid the flicker.