diff --git a/API.txt b/API.txt index 65400c6..daf2317 100644 --- a/API.txt +++ b/API.txt @@ -501,6 +501,7 @@ through the following axis options: minTickSize: array timeformat: null or format string monthNames: null or array of size 12 of strings + dayNames: null or array of size 7 of strings twelveHourClock: boolean Here "timeformat" is a format string to use. You might use it like @@ -508,41 +509,47 @@ this: xaxis: { mode: "time" - timeformat: "%y/%m/%d" + timeformat: "%Y/%m/%d" } -This will result in tick labels like "2000/12/24". The following -specifiers are supported - - %h: hours - %H: hours (left-padded with a zero) - %M: minutes (left-padded with a zero) - %S: seconds (left-padded with a zero) - %d: day of month (1-31), use %0d for zero-padding - %m: month (1-12), use %0m for zero-padding - %y: year (four digits) +This will result in tick labels like "2000/12/24". A subset of the +standard strftime specifiers are supported: + + %a: weekday name (customizable) %b: month name (customizable) - %p: am/pm, additionally switches %h/%H to 12 hour instead of 24 + %d: day of month, zero-padded (01-31) + %e: day of month, space-padded ( 1-31) + %H: hours, 24-hour time, zero-padded (00-23) + %I: hours, 12-hour time, zero-padded (01-12) + %m: month, zero-padded (01-12) + %M: minutes, zero-padded (00-59) + %S: seconds, zero-padded (00-59) + %y: year (two digits) + %Y: year (four digits) + %p: am/pm %P: AM/PM (uppercase version of %p) - -Inserting a zero like %0m or %0d means that the specifier will be -left-padded with a zero if it's only single-digit. So %y-%0m-%0d -results in unambigious ISO timestamps like 2007-05-10 (for May 10th). + %w: weekday as number (0-6, 0 being Sunday) You can customize the month names with the "monthNames" option. For instance, for Danish you might specify: monthNames: ["jan", "feb", "mar", "apr", "maj", "jun", "jul", "aug", "sep", "okt", "nov", "dec"] +Similarly you can customize the weekday names with the "dayNames" +option. An example in French: + + dayNames: ["dim", "lun", "mar", "mer", "jeu", "ven", "sam"] + If you set "twelveHourClock" to true, the autogenerated timestamps -will use 12 hour AM/PM timestamps instead of 24 hour. - -The format string and month names are used by a very simple built-in -format function that takes a date object, a format string (and -optionally an array of month names) and returns the formatted string. -If needed, you can access it as $.plot.formatDate(date, formatstring, -monthNames) or even replace it with another more advanced function -from a date library if you're feeling adventurous. +will use 12 hour AM/PM timestamps instead of 24 hour. This only +applies if you have not set "timeformat". Use the "%I" and "%p" or +"%P" options if you want to build your own format string with 12-hour +times. + +If the Date object has a strftime property (and it is a function), it +will be used instead of the built-in formatter. Thus you can include +a strftime library such as http://hacks.bluesmoon.info/strftime/ for +more powerful date/time formatting. If everything else fails, you can control the formatting by specifying a custom tick formatter function as usual. Here's a simple example diff --git a/NEWS.txt b/NEWS.txt index 6175ca3..d00b210 100644 --- a/NEWS.txt +++ b/NEWS.txt @@ -15,6 +15,11 @@ control how the dates are displayed. If null, the dates are displayed as UTC. If "browser", the dates are displayed in the time zone of the user's browser. +Date/time formatting has changed and now follows a proper subset +of the standard strftime specifiers. Additionally, if a strftime +function is found in the Date object's prototype, it will be used +instead of the built-in formatter. + Axis labels are now drawn with canvas text with some parsing to support newlines. This solves various issues but also means that they no longer support HTML markup, can be accessed as DOM elements or @@ -29,6 +34,10 @@ and "flot-overlay" to prevent accidental clashes (issue 540). Changes: +- Date/time formatting follows proper subset of strftime specifiers, + and support added for Date.prototype.strftime, if found (patch by + Mark Cote, issue 558). + - Fixed display of year ticks (patch by Mark Cote, issue 195). - Support for time series moved to plugin (patch by Mark Cote). diff --git a/examples/time.html b/examples/time.html index 4a6e908..8eb1c0b 100644 --- a/examples/time.html +++ b/examples/time.html @@ -23,7 +23,9 @@

Zoom to: -

+ + +

The timestamps must be specified as Javascript timestamps, as milliseconds since January 1, 1970 00:00. This is like Unix @@ -31,10 +33,10 @@ multiply with 1000!).

As an extra caveat, the timestamps are interpreted according to - UTC to avoid having the graph shift with each visitor's local - time zone. So you might have to add your local time zone offset - to the timestamps or simply pretend that the data was produced - in UTC instead of your local time zone.

+ UTC and, by default, displayed as such. You can set the axis + "timezone" option to "browser" to display the timestamps in the + user's timezone, or, if you use timezoneJS, you can specify a + time zone.