com.github.gwtd3.api.time

Class Interval

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.time.Interval

public class Interval
extends com.google.gwt.core.client.JavaScriptObject

Time class performing simple time arithmetic.

Intervals are created using D3.time() factory methods, such as Time.second().

Note: intervals created by the factory methods of D3().time() are intervals based on local time. Use the utc() method to convert the interval to a UTC based interval.

Time intervals are irregular! For example, there are 60 seconds in a minute, but 24 hours in a day. Even more confusing, some days have 23 or 25 hours due to daylight saving time, and the standard Gregorian calendar uses months of differing lengths. And then there are leap years and leap seconds!

To simplify manipulation of and iteration over time intervals, D3 provides a handful of time utilities in addition to the time scale and format.

The utilities support both local time and UTC time. Local time is determined by the browser's JavaScript runtime; arbitrary time zone support would be nice, but requires access to the Olson zoneinfo files.

Author:

Anthony Schiochet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Interval()

Method Summary

Methods

Modifier and Type	Method and Description
Date	apply(Date date) Alias for floor(Date).
double	apply(double date) Alias for floor(double).
com.google.gwt.core.client.JsDate	apply(com.google.gwt.core.client.JsDate date) Alias for floor(JsDate).
Date	ceil(Date date) Alias for ceil(JsDate) for a Java date.
double	ceil(double date) Alias for round(JsDate) for a timestamp.
com.google.gwt.core.client.JsDate	ceil(com.google.gwt.core.client.JsDate date) Returns the earliest time interval after the specified date.
Date	floor(Date date) Alias for floor(JsDate) for a Java date.
double	floor(double date) Alias for floor(JsDate) for a timestamp.
com.google.gwt.core.client.JsDate	floor(com.google.gwt.core.client.JsDate date) Return the latest time interval before or equal to the specified date.
Date	offset(Date start, int step) Alias for offset(JsDate, int) for java Date.
double	offset(double start, int step) Alias for offset(JsDate, int) for double.
com.google.gwt.core.client.JsDate	offset(com.google.gwt.core.client.JsDate start, int step) Returns a new date equal to date plus step intervals.
Array<com.google.gwt.core.client.JsDate>	range(Date start, Date stop) Alias for range(JsDate start, JsDate stop) for java Date.
Array<com.google.gwt.core.client.JsDate>	range(Date start, Date stop, double step) Alias for range(JsDate start, JsDate stop, double step) for java Date.
Array<com.google.gwt.core.client.JsDate>	range(double start, double stop) Alias for range(JsDate start, JsDate stop) for double.
Array<com.google.gwt.core.client.JsDate>	range(double start, double stop, double step) Alias for range(JsDate start, JsDate stop, double step) for double.
Array<com.google.gwt.core.client.JsDate>	range(com.google.gwt.core.client.JsDate start, com.google.gwt.core.client.JsDate stop) Returns every time interval after or equal to start and before stop.
Array<com.google.gwt.core.client.JsDate>	range(com.google.gwt.core.client.JsDate start, com.google.gwt.core.client.JsDate stop, double step) Returns every time interval after or equal to start and before stop.
Date	round(Date date) Alias for round(JsDate) for a Java date.
double	round(double date) Alias for round(JsDate) for a timestamp.
com.google.gwt.core.client.JsDate	round(com.google.gwt.core.client.JsDate date) Returns the closest time interval to the specified date.
Interval	utc() Returns a corresponding time interval in UTC rather than local time.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Interval

protected Interval()

Method Detail

utc

public final Interval utc()

Returns a corresponding time interval in UTC rather than local time. For example, D3().time().day().range(start, stop) returns local time days between start and stop, while D3().time().day().utc().range(start, stop) returns UTC days between start and stop.

Returns:

the UTC interval

apply

public final com.google.gwt.core.client.JsDate apply(com.google.gwt.core.client.JsDate date)

Alias for floor(JsDate).

Parameters:

date -

Returns:

apply

public final Date apply(Date date)

Alias for floor(Date).

Parameters:

date -

Returns:

apply

public final double apply(double date)

Alias for floor(double).

Parameters:

date -

Returns:

floor

public final com.google.gwt.core.client.JsDate floor(com.google.gwt.core.client.JsDate date)

Return the latest time interval before or equal to the specified date. For example, D3.time().day().floor(new Date()) returns midnight (12:00 AM) on the current day, in local time.

Parameters:

date - the date to convert

Returns:

the date.

floor

public final Date floor(Date date)

Alias for floor(JsDate) for a Java date.

Parameters:

date - the date to convert

Returns:

the date

floor

public final double floor(double date)

Alias for floor(JsDate) for a timestamp.

Parameters:

date -

Returns:

the date

round

public final com.google.gwt.core.client.JsDate round(com.google.gwt.core.client.JsDate date)

Returns the closest time interval to the specified date.

For example, d3.time().day().round(new Date()) returns midnight (12:00 AM) on the current day if it is on or before noon, and midnight of the following day if it is after noon.

Parameters:

date - the date to convert

Returns:

the date

round

public final Date round(Date date)

Alias for round(JsDate) for a Java date.

Parameters:

date - the date to convert

Returns:

the date

round

public final double round(double date)

Alias for round(JsDate) for a timestamp.

Parameters:

date -

Returns:

the date

ceil

public final com.google.gwt.core.client.JsDate ceil(com.google.gwt.core.client.JsDate date)

Returns the earliest time interval after the specified date.

For example, d3.time.day.ceil(new Date()) returns midnight (12:00 AM) on the following day, in local time.

Parameters:

date - the date to convert

Returns:

the date

ceil

public final Date ceil(Date date)

Alias for ceil(JsDate) for a Java date.

Parameters:

date - the date to convert

Returns:

the date

ceil

public final double ceil(double date)

Alias for round(JsDate) for a timestamp.

Parameters:

date -

Returns:

the date

offset

public final com.google.gwt.core.client.JsDate offset(com.google.gwt.core.client.JsDate start,
                                       int step)

Returns a new date equal to date plus step intervals.

If step is negative, then the returned date will be before the specified date; if step is zero, then a copy of the specified date is returned.

This method does not round the specified date to the interval. For example, if it is currently 5:34 PM, then d3.time.day.offset(new Date(), 1) returns 5:34 PM tomorrow (even if Daylight Savings Time changes!).

Parameters:

start - the start date

step - the number of intervals to add to the start date

Returns:

the computed date

offset

public final double offset(double start,
            int step)

Alias for offset(JsDate, int) for double.

Parameters:

start - the start date

step - the number of intervals to add to the start date

Returns:

the computed date

offset

public final Date offset(Date start,
          int step)

Alias for offset(JsDate, int) for java Date.

Parameters:

start - the start date

step - the number of intervals to add to the start date

Returns:

the computed date

range

public final Array<com.google.gwt.core.client.JsDate> range(com.google.gwt.core.client.JsDate start,
                                             com.google.gwt.core.client.JsDate stop)

Returns every time interval after or equal to start and before stop.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval

range

public final Array<com.google.gwt.core.client.JsDate> range(Date start,
                                             Date stop)

Alias for range(JsDate start, JsDate stop) for java Date.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval

range

public final Array<com.google.gwt.core.client.JsDate> range(double start,
                                             double stop)

Alias for range(JsDate start, JsDate stop) for double.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval

range

public final Array<com.google.gwt.core.client.JsDate> range(com.google.gwt.core.client.JsDate start,
                                             com.google.gwt.core.client.JsDate stop,
                                             double step)

Returns every time interval after or equal to start and before stop.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval

range

public final Array<com.google.gwt.core.client.JsDate> range(Date start,
                                             Date stop,
                                             double step)

Alias for range(JsDate start, JsDate stop, double step) for java Date.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval

range

public final Array<com.google.gwt.core.client.JsDate> range(double start,
                                             double stop,
                                             double step)

Alias for range(JsDate start, JsDate stop, double step) for double.

Parameters:

start - the start time

stop - the stop time

Returns:

the interval