@amcharts/amcharts4
Version:
amCharts 4
1,198 lines • 43.9 kB
JavaScript
/**
* Handles date and time formatting
*/
import { __extends } from "tslib";
import { Language } from "../utils/Language";
import { BaseObject } from "../Base";
import { getTextFormatter } from "../formatters/TextFormatter";
import { registry } from "../Registry";
import * as $strings from "../utils/Strings";
import * as $utils from "../utils/Utils";
import * as $type from "../utils/Type";
import * as $time from "../utils/Time";
/**
* Handles date and time formatting.
*
* @see {@link https://www.amcharts.com/docs/v4/concepts/formatters/formatting-date-time/} Tutorial on date/time formatting
* @todo Better type casting of passed in date?
* @todo Quarter support?
* @todo When parsing named months make the search case-insensitive
* @todo Escape a.m./p.m. properly when used in RegEx
*/
var DateFormatter = /** @class */ (function (_super) {
__extends(DateFormatter, _super);
/**
* Constructor
*/
function DateFormatter() {
var _this = _super.call(this) || this;
/**
* Date format.
*/
_this._dateFormat = "yyyy-MM-dd";
/**
* Input date format.
*/
_this._inputDateFormat = "yyyy-MM-dd";
/**
* Assume UTC time zone.
*/
_this._utc = false;
/**
* If `timezone` is set, this will hold minute fraction of the timezone.
*
* @readonly
* @ignore
*/
_this.timezoneMinutes = 0;
/**
* First day of week.
*
* 0 - Sunday
* 1 - Monday
*
* Etc.
*/
_this._firstDayOfWeek = 1;
/**
* A list of month names.
*/
_this.months = ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
/**
* A list of short month names.
*/
_this.monthsShort = ["Jan", "Feb", "Mar", "Apr", "May(short)", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
/**
* A list of weekday names.
*/
_this.weekdays = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"];
/**
* A list of short weekday names.
*/
_this.weekdaysShort = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
/**
* Output format to produce. If the format calls for applying color to the
* formatted value, this setting will determine what markup to use: SVG or
* HTML.
*
* Available options: svg, html.
*
* @default "svg"
*/
_this._outputFormat = "svg";
/**
* Should the first letter of the formatted date be capitalized?
*
* @default true
*/
_this.capitalize = true;
_this.className = "DateFormatter";
_this.applyTheme();
return _this;
}
Object.defineProperty(DateFormatter.prototype, "language", {
/**
* @return Language
*/
get: function () {
return this._language;
},
/**
* A reference to [[Language]] object.
*
* @param value Language
*/
set: function (value) {
this._language = value;
this.dateFormat = this._language.translate("_date");
},
enumerable: true,
configurable: true
});
/**
* Formats the date value according to specified format.
*
* @see {@link https://www.amcharts.com/docs/v4/concepts/formatters/formatting-date-time/} Tutorial on date/time formatting
* @param source Date value
* @param format Format
* @return Formatted date string
*/
DateFormatter.prototype.format = function (source, format, applyTimezone) {
// No language?
if (!this.language) {
if (this.sprite) {
this.language = this.sprite.language;
}
else {
this.language = new Language();
}
}
// No format passed in or it's empty
if (typeof format === "undefined" || format === "") {
format = this._dateFormat;
}
// Init return value
var formatted;
// Do casting if required
// This will take care of timestamps as well as Date objects
var date;
if ($type.isString(source)) {
// If it's a string, let's try parsing it using our own functionality
date = this.parse(source);
}
else {
date = $utils.anyToDate(source);
}
// Is it a built-in format or Intl.DateTimeFormat
if ($type.isObject(format)) {
try {
if (this.intlLocales) {
return new Intl.DateTimeFormat(this.intlLocales, format).format(date);
}
else {
return new Intl.DateTimeFormat(undefined, format).format(date);
}
}
catch (e) {
return "Invalid";
}
}
else {
// Clean format
format = $utils.cleanFormat(format);
// get format info (it will also deal with parser caching)
var info = this.parseFormat(format);
// Should we apply custom time zone?
if ($type.hasValue(this.timezoneOffset)) {
date.setMinutes(date.getMinutes() + date.getTimezoneOffset() - this.timezoneOffset);
}
else if ($type.hasValue(this.timezone) && applyTimezone !== false) {
date = $time.setTimezone(date, this.timezone);
}
// Check if it's a valid date
if (!$type.isNumber(date.getTime())) {
return this.language.translate("Invalid date");
}
// Apply format
formatted = this.applyFormat(date, info, this.language);
// Capitalize
if (this.capitalize) {
formatted = formatted.replace(/^.{1}/, formatted.substr(0, 1).toUpperCase());
}
}
// We're done
return formatted;
};
/**
* Parses format into structured infromation.
*
* @param format Format template
*/
DateFormatter.prototype.parseFormat = function (format) {
// Check cache
var cached = this.getCache(format);
if ($type.hasValue(cached)) {
return cached;
}
// Init format parse info holder
var info = {
"template": "",
"parts": []
};
// Let TextFormatter split into chunks
var chunks = getTextFormatter().chunk(format, true);
for (var i = 0; i < chunks.length; i++) {
var chunk = chunks[i];
if (chunk.type === "value") {
// Just "Date"?
if (chunk.text.match(/^date$/i) && $type.isString(this._dateFormat)) {
chunk.text = this._dateFormat;
}
// Find all possible parts
var matches = chunk.text.match(/G|yyyy|yyy|yy|y|YYYY|YYY|YY|Y|u|q|MMMMM|MMMM|MMM|MM|M|ww|w|W|dd|d|DDD|DD|D|F|g|EEEEE|EEEE|EEE|EE|E|eeeee|eeee|eee|ee|e|aaa|aa|a|hh|h|HH|H|KK|K|kk|k|mm|m|ss|s|SSS|SS|S|A|zzzz|zzz|zz|z|ZZ|Z|t|x|nnn|nn|n|i|I/g);
// Found?
if (matches) {
// Populate template
for (var x = 0; x < matches.length; x++) {
info.parts.push(matches[x]);
chunk.text = chunk.text.replace(matches[x], $strings.PLACEHOLDER);
}
}
}
// Apply to template
info.template += chunk.text;
}
// Apply style formatting
//info.template = getTextFormatter().format(info.template, this.outputFormat);
// Save cache
this.setCache(format, info);
return info;
};
/**
* Applies format to Date.
*
* @param date Date object
* @param info Parsed format information
* @param language Language
* @return Formatted date string
*/
DateFormatter.prototype.applyFormat = function (date, info, language) {
// Init return value
var res = info.template;
// Get values
var fullYear, month, weekday, day, hours, minutes, seconds, milliseconds, offset = date.getTimezoneOffset(), timestamp = date.getTime();
if (this.utc) {
fullYear = date.getUTCFullYear();
month = date.getUTCMonth();
weekday = date.getUTCDay();
day = date.getUTCDate();
hours = date.getUTCHours();
minutes = date.getUTCMinutes();
seconds = date.getUTCSeconds();
milliseconds = date.getUTCMilliseconds();
}
else {
fullYear = date.getFullYear();
month = date.getMonth();
weekday = date.getDay();
day = date.getDate();
hours = date.getHours();
minutes = date.getMinutes();
seconds = date.getSeconds();
milliseconds = date.getMilliseconds();
}
// Go through each part and format/replace it in template
for (var i = 0, len = info.parts.length; i < len; i++) {
var value = "";
switch (info.parts[i]) {
case "G":
value = language.translate(fullYear < 0
? "_era_bc"
: "_era_ad");
break;
case "yyyy":
value = Math.abs(fullYear).toString();
if (fullYear < 0) {
value += language.translate("_era_bc");
}
break;
case "yyy":
case "yy":
case "y":
value = Math.abs(fullYear).toString().substr(-info.parts[i].length);
if (fullYear < 0) {
value += language.translate("_era_bc");
}
break;
case "YYYY":
case "YYY":
case "YY":
case "Y":
var week = $utils.getWeek(date);
var year = fullYear;
if (week == 1 && (weekday > 4)) {
year--;
}
if (info.parts[i] == "YYYY") {
value = Math.abs(year).toString();
}
else {
value = Math.abs(year).toString().substr(-info.parts[i].length);
}
if (year < 0) {
value += language.translate("_era_bc");
}
break;
case "u":
// @todo
break;
case "q":
value = "" + Math.ceil((date.getMonth() + 1) / 3);
break;
case "MMMMM":
value = language.translate(this.months[month]).substr(0, 1);
break;
case "MMMM":
value = language.translate(this.months[month]);
break;
case "MMM":
value = language.translate(this.monthsShort[month]);
break;
case "MM":
value = $utils.padString(month + 1, 2, "0");
break;
case "M":
value = (month + 1).toString();
break;
case "ww":
value = $utils.padString($utils.getWeek(date, this.utc), 2, "0");
break;
case "w":
value = $utils.getWeek(date, this.utc).toString();
break;
case "W":
value = $utils.getMonthWeek(date, this.utc).toString();
break;
case "dd":
value = $utils.padString(day, 2, "0");
break;
case "d":
value = day.toString();
break;
case "DD":
case "DDD":
value = $utils.padString($utils.getYearDay(date, this.utc).toString(), info.parts[i].length, "0");
break;
case "D":
value = $utils.getYearDay(date, this.utc).toString();
break;
case "F":
// @todo
break;
case "g":
// @todo
break;
case "t":
value = language.translateFunc("_dateOrd").call(this, day);
break;
case "E":
value = (weekday || 7).toString();
break;
case "EE":
value = $utils.padString((weekday || 7).toString(), 2, "0");
break;
case "EEE":
case "eee":
value = language.translate(this.weekdaysShort[weekday]);
break;
case "EEEE":
case "eeee":
value = language.translate(this.weekdays[weekday]);
break;
case "EEEEE":
case "eeeee":
value = language.translate(this.weekdays[weekday]).substr(0, 1);
break;
case "e":
case "ee":
value = (weekday - this.firstDayOfWeek + 1).toString();
if (info.parts[i] == "ee") {
value = $utils.padString(value, 2, "0");
}
break;
case "a":
if (hours >= 12) {
value = language.translate("PM");
}
else {
value = language.translate("AM");
}
break;
case "aa":
if (hours >= 12) {
value = language.translate("P.M.");
}
else {
value = language.translate("A.M.");
}
break;
case "aaa":
if (hours >= 12) {
value = language.translate("P");
}
else {
value = language.translate("A");
}
break;
case "h":
value = $utils.get12Hours(hours).toString();
break;
case "hh":
value = $utils.padString($utils.get12Hours(hours), 2, "0");
break;
case "H":
value = hours.toString();
break;
case "HH":
value = $utils.padString(hours, 2, "0");
break;
case "K":
value = $utils.get12Hours(hours, 0).toString();
break;
case "KK":
value = $utils.padString($utils.get12Hours(hours, 0), 2, "0");
break;
case "k":
value = (hours + 1).toString();
break;
case "kk":
value = $utils.padString(hours + 1, 2, "0");
break;
case "m":
value = minutes.toString();
break;
case "mm":
value = $utils.padString(minutes, 2, "0");
break;
case "s":
value = seconds.toString();
break;
case "ss":
value = $utils.padString(seconds, 2, "0");
break;
case "S":
case "SS":
case "SSS":
value = Math.round((milliseconds / 1000) * Math.pow(10, info.parts[i].length)).toString();
break;
case "x":
value = timestamp.toString();
break;
case "n":
case "nn":
case "nnn":
value = $utils.padString(milliseconds, info.parts[i].length, "0");
break;
case "z":
value = $utils.getTimeZone(date, false, false, this.utc);
break;
case "zz":
value = $utils.getTimeZone(date, true, false, this.utc);
break;
case "zzz":
value = $utils.getTimeZone(date, false, true, this.utc);
break;
case "zzzz":
value = $utils.getTimeZone(date, true, true, this.utc);
break;
case "Z":
case "ZZ":
var tz = Math.abs(offset) / 60;
var tzh = Math.floor(tz);
var tzm = tz * 60 - tzh * 60;
if (this.utc) {
tzh = 0;
tzm = 0;
}
if (info.parts[i] == "Z") {
value = "GMT";
value += offset > 0 ? "-" : "+";
value += $utils.padString(tzh, 2) + ":" + $utils.padString(tzm, 2);
}
else {
value = offset > 0 ? "-" : "+";
value += $utils.padString(tzh, 2) + $utils.padString(tzm, 2);
}
break;
case "i":
value = date.toISOString();
break;
case "I":
value = date.toUTCString();
break;
}
res = res.replace($strings.PLACEHOLDER, value);
}
return res;
};
/**
* Parses any input value into Date object.
*
* @see {@link https://www.amcharts.com/docs/v4/concepts/formatters/formatting-date-time/#Parsing_Dates} Tutorial on date/time parsing
* @param source Source value
* @param format Source format
* @return Date object
*/
DateFormatter.prototype.parse = function (source, format) {
// Format set?
if (!$type.hasValue(format)) {
format = this.inputDateFormat;
}
// Is it already a Date
if (source instanceof Date) {
return source;
}
// Is it a numeric timestamp
if (typeof source === "number") {
return new Date(source);
}
// No? Let's check if it's string, and try converting to it if nec
if (typeof source !== "string") {
source = source.toString();
}
// no language?
if (!this.language) {
if (this.sprite) {
this.language = this.sprite.language;
}
else {
this.language = new Language;
}
}
// Init return value
var res;
// Init RegEx for parsing
var reg = "";
// Clean format
format = $utils.cleanFormat(format);
// Clip format to length of the source string
format = format.substr(0, source.length);
// Parse format
var info = this.parseFormat(format);
// Init parsed items holder
var parsedIndexes = {
"year": -1,
"year3": -1,
"year2": -1,
"year1": -1,
"month": -1,
"monthShort": -1,
"monthLong": -1,
"weekdayShort": -1,
"weekdayLong": -1,
"day": -1,
"yearDay": -1,
"week": -1,
"hourBase0": -1,
"hour12Base0": -1,
"hourBase1": -1,
"hour12Base1": -1,
"minute": -1,
"second": -1,
"millisecond": -1,
"millisecondDigits": -1,
"am": -1,
"zone": -1,
"timestamp": -1,
"iso": -1
};
// Init values
var resValues = {
"year": 1970,
"month": 0,
"day": 1,
"hour": 0,
"minute": 0,
"second": 0,
"millisecond": 0,
"timestamp": null,
"offset": 0,
"utc": this.utc
};
// Index adjuster
var indexAdjust = 0, index = 0;
// Iterate through all of the parts
for (var i = 0; i < info.parts.length; i++) {
// Set current match index
index = i + indexAdjust + 1;
switch (info.parts[i]) {
case "yyyy":
case "YYYY":
reg += "([0-9]{4})";
parsedIndexes.year = index;
break;
case "yyy":
case "YYY":
reg += "([0-9]{3})";
parsedIndexes.year3 = index;
break;
case "yy":
case "YY":
reg += "([0-9]{2})";
parsedIndexes.year2 = index;
break;
case "y":
case "Y":
reg += "([0-9]{1})";
parsedIndexes.year1 = index;
break;
case "MMMM":
reg += "(" + this.getStringList(this.months).join("|") + ")";
parsedIndexes.monthLong = index;
break;
case "MMM":
reg += "(" + this.getStringList(this.monthsShort).join("|") + ")";
parsedIndexes.monthShort = index;
break;
case "MM":
case "M":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.month = index;
break;
case "ww":
case "w":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.week = index;
break;
case "dd":
case "d":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.day = index;
break;
case "DDD":
case "DD":
case "D":
reg += "([0-9]{3}|[0-9]{2}|[0-9]{1})";
parsedIndexes.yearDay = index;
break;
case "dddd":
reg += "(" + this.getStringList(this.weekdays).join("|") + ")";
parsedIndexes.weekdayLong = index;
break;
case "ddd":
reg += "(" + this.getStringList(this.weekdaysShort).join("|") + ")";
parsedIndexes.weekdayShort = index;
break;
case "aaa":
case "aa":
case "a":
// TODO: fix (escape regex)
reg += "(" + this.getStringList(["AM", "PM", "A\.M\.", "P\.M\.", "A", "P"]).join("|") + ")";
parsedIndexes.am = index;
break;
case "hh":
case "h":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.hour12Base1 = index;
break;
case "HH":
case "H":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.hourBase0 = index;
break;
case "KK":
case "K":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.hour12Base0 = index;
break;
case "kk":
case "k":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.hourBase1 = index;
break;
case "mm":
case "m":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.minute = index;
break;
case "ss":
case "s":
reg += "([0-9]{2}|[0-9]{1})";
parsedIndexes.second = index;
break;
case "SSS":
case "SS":
case "S":
reg += "([0-9]{3}|[0-9]{2}|[0-9]{1})";
parsedIndexes.millisecond = index;
parsedIndexes.millisecondDigits = info.parts[i].length;
break;
case "nnn":
case "nn":
case "n":
reg += "([0-9]{3}|[0-9]{2}|[0-9]{1})";
parsedIndexes.millisecond = index;
break;
case "x":
reg += "([0-9]{1,})";
parsedIndexes.timestamp = index;
break;
case "Z":
reg += "GMT([-+]+[0-9]{2}:[0-9]{2})";
parsedIndexes.zone = index;
break;
case "ZZ":
reg += "([\\-+]+[0-9]{2}[0-9]{2})";
parsedIndexes.zone = index;
break;
case "i":
reg += "([0-9]{4})-?([0-9]{2})-?([0-9]{2})T?([0-9]{2}):?([0-9]{2}):?([0-9]{2})\.?([0-9]{0,3})([zZ]|[+\-][0-9]{2}:?[0-9]{2}|$)";
parsedIndexes.iso = index;
indexAdjust += 7;
break;
case "G":
case "YYYY":
case "YYY":
case "YY":
case "Y":
case "MMMMM":
case "W":
case "EEEEE":
case "EEEE":
case "EEE":
case "EE":
case "E":
case "eeeee":
case "eeee":
case "eee":
case "ee":
case "e":
case "zzzz":
case "zzz":
case "zz":
case "z":
case "t":
// Ignore
indexAdjust--;
break;
}
reg += "[^0-9]*";
}
// Try matching
var regex = new RegExp(reg);
var matches = source.match(regex);
if (matches) {
// Populate the date object
// Full year
if (parsedIndexes.year > -1) {
resValues.year = parseInt(matches[parsedIndexes.year]);
}
// 3-digit year
if (parsedIndexes.year3 > -1) {
var val = parseInt(matches[parsedIndexes.year3]);
val += 1000;
resValues.year = val;
}
// 2-digit year
if (parsedIndexes.year2 > -1) {
var val = parseInt(matches[parsedIndexes.year2]);
if (val > 50) {
val += 1000;
}
else {
val += 2000;
}
resValues.year = val;
}
// 1-digit year
if (parsedIndexes.year1 > -1) {
var val = parseInt(matches[parsedIndexes.year1]);
val = Math.floor((new Date().getFullYear()) / 10) * 10 + val;
resValues.year = val;
}
// Full month
if (parsedIndexes.monthLong > -1) {
resValues.month = this.resolveMonth(matches[parsedIndexes.monthLong]);
}
// Short month
if (parsedIndexes.monthShort > -1) {
resValues.month = this.resolveShortMonth(matches[parsedIndexes.monthShort]);
}
// Numeric month
if (parsedIndexes.month > -1) {
resValues.month = parseInt(matches[parsedIndexes.month]) - 1;
}
// Weekday
// @todo
// Week
if ((parsedIndexes.week > -1) && (parsedIndexes.day === -1)) {
// We parse weeks ONLY if day is not explicitly set
// TODO: this needs work
// (but maybe later - I can hardly imagine anyone passing their dates in weeks)
resValues.month = 0;
resValues.day = $utils.getDayFromWeek(parseInt(matches[parsedIndexes.week]), resValues.year, 1, this.utc);
}
// Day
if (parsedIndexes.day > -1) {
resValues.day = parseInt(matches[parsedIndexes.day]);
}
// Year day
if (parsedIndexes.yearDay > -1) {
resValues.month = 0;
resValues.day = parseInt(matches[parsedIndexes.yearDay]);
}
// 24 Hour (0-23)
if (parsedIndexes.hourBase0 > -1) {
resValues.hour = parseInt(matches[parsedIndexes.hourBase0]);
}
// 24 Hour (1-24)
if (parsedIndexes.hourBase1 > -1) {
resValues.hour = parseInt(matches[parsedIndexes.hourBase1]) - 1;
}
// 12 Hour (0-11)
if (parsedIndexes.hour12Base0 > -1) {
var val = parseInt(matches[parsedIndexes.hour12Base0]);
if (val == 11) {
val = 0;
}
if ((parsedIndexes.am > -1) && !this.isAm(matches[parsedIndexes.am])) {
val += 12;
}
resValues.hour = val;
}
// 12 Hour (1-12)
if (parsedIndexes.hour12Base1 > -1) {
var val = parseInt(matches[parsedIndexes.hour12Base1]);
if (val == 12) {
val = 0;
}
if ((parsedIndexes.am > -1) && !this.isAm(matches[parsedIndexes.am])) {
val += 12;
}
resValues.hour = val;
}
// Minute
if (parsedIndexes.minute > -1) {
resValues.minute = parseInt(matches[parsedIndexes.minute]);
}
// Second
if (parsedIndexes.second > -1) {
resValues.second = parseInt(matches[parsedIndexes.second]);
}
// Millisecond
if (parsedIndexes.millisecond > -1) {
var val = parseInt(matches[parsedIndexes.millisecond]);
if (parsedIndexes.millisecondDigits == 2) {
val *= 10;
}
else if (parsedIndexes.millisecondDigits == 1) {
val *= 100;
}
resValues.millisecond = val;
}
// Timestamp
if (parsedIndexes.timestamp > -1) {
resValues.timestamp = parseInt(matches[parsedIndexes.timestamp]);
var ts = new Date(resValues.timestamp);
resValues.year = ts.getUTCFullYear();
resValues.month = ts.getUTCMonth();
resValues.day = ts.getUTCDate();
resValues.hour = ts.getUTCHours();
resValues.minute = ts.getUTCMinutes();
resValues.second = ts.getUTCSeconds();
resValues.millisecond = ts.getUTCMilliseconds();
}
// Adjust time zone
if (parsedIndexes.zone > -1) {
resValues.offset = this.resolveTimezoneOffset(new Date(resValues.year, resValues.month, resValues.day), matches[parsedIndexes.zone]);
}
// ISO
if (parsedIndexes.iso > -1) {
resValues.year = $type.toNumber(matches[parsedIndexes.iso + 0]);
resValues.month = $type.toNumber(matches[parsedIndexes.iso + 1]) - 1;
resValues.day = $type.toNumber(matches[parsedIndexes.iso + 2]);
resValues.hour = $type.toNumber(matches[parsedIndexes.iso + 3]);
resValues.minute = $type.toNumber(matches[parsedIndexes.iso + 4]);
resValues.second = $type.toNumber(matches[parsedIndexes.iso + 5]);
resValues.millisecond = $type.toNumber(matches[parsedIndexes.iso + 6]);
if (matches[parsedIndexes.iso + 7] == "Z" || matches[parsedIndexes.iso + 7] == "z") {
resValues.utc = true;
}
else if (matches[parsedIndexes.iso + 7] != "") {
resValues.offset = this.resolveTimezoneOffset(new Date(resValues.year, resValues.month, resValues.day), matches[parsedIndexes.iso + 7]);
}
}
// Create Date object
if (resValues.utc) {
res = new Date(Date.UTC(resValues.year, resValues.month, resValues.day, resValues.hour, resValues.minute, resValues.second, resValues.millisecond));
}
else {
res = new Date(resValues.year, resValues.month, resValues.day, resValues.hour, resValues.minute + resValues.offset, resValues.second, resValues.millisecond);
}
}
else {
// Didn't match anything
// Let's try dropping it into Date constructor and hope for the best
res = new Date(source);
}
return res;
};
DateFormatter.prototype.resolveTimezoneOffset = function (date, zone) {
var value = zone.match(/([+\-]?)([0-9]{2}):?([0-9]{2})/);
if (value) {
var match = $type.getValue(zone.match(/([+\-]?)([0-9]{2}):?([0-9]{2})/));
var dir = match[1];
var hour = match[2];
var minute = match[3];
var offset = parseInt(hour) * 60 + parseInt(minute);
// Adjust offset
// Making it negative does not seem to make sense, but it's right
// because of how JavaScript calculates GMT offsets
if (dir == "+") {
offset *= -1;
}
// Check the difference in offset
var originalOffset = (date || new Date()).getTimezoneOffset();
var diff = offset - originalOffset;
return diff;
}
return 0;
};
/**
* Resolves month name (i.e. "December") into a month number (11).
*
* @param value Month name
* @return Month number
*/
DateFormatter.prototype.resolveMonth = function (value) {
// Let's try English first
var month = this.months.indexOf(value);
if (month > -1) {
return month;
}
// Try the translation
if (this.language && !this.language.isDefault()) {
month = this.language.translateAll(this.months).indexOf(value);
if (month > -1) {
return month;
}
}
return 0;
};
/**
* Resolves short month name (i.e. "Dec") into a month number.
*
* @param value Short month name
* @return Month number
*/
DateFormatter.prototype.resolveShortMonth = function (value) {
// Let's try English first
var month = this.monthsShort.indexOf(value);
if (month > -1) {
return month;
}
// Maybe long month (workaround for May)
month = this.months.indexOf(value);
if (month > -1) {
return month;
}
// Try the translation
if (this.language && !this.language.isDefault()) {
month = this.language.translateAll(this.monthsShort).indexOf(value);
if (month > -1) {
return month;
}
}
return 0;
};
/**
* Checks if passed in string represents AM/PM notation in many of its
* versions.
*
* @param value Source string
* @return Is it AM/PM?
*/
DateFormatter.prototype.isAm = function (value) {
var list = this.getStringList(["AM", "A.M.", "A"]);
return list.indexOf(value.toUpperCase()) > -1;
};
/**
* Invalidates related [[Sprite]] causing it to redraw.
*/
DateFormatter.prototype.invalidateSprite = function () {
if (this.sprite) {
this.sprite.invalidate();
}
};
/**
* Translates list of strings.
*
* @param list Source strings
* @return Translated strings
*/
DateFormatter.prototype.getStringList = function (list) {
var res = [];
for (var i = 0; i < list.length; i++) {
// translate?
if (this.language) {
res.push($utils.escapeForRgex(this.language.translate(list[i])));
}
else {
res.push($utils.escapeForRgex(list[i]));
}
}
return res;
};
Object.defineProperty(DateFormatter.prototype, "dateFormat", {
/**
* @return Date format
*/
get: function () {
return this._dateFormat;
},
/**
* Date format to use.
*
* If format is not supplied in-line in the string, this setting will be
* used.
*
* @default "yyyy-MM-dd"
* @param value Date format
*/
set: function (value) {
this._dateFormat = value;
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "inputDateFormat", {
/**
* @return Date format
*/
get: function () {
return this._inputDateFormat;
},
/**
* Date format to use when parsing dates.
*
* @default "yyyy-MM-dd"
* @param value Date format
*/
set: function (value) {
this._inputDateFormat = value;
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "intlLocales", {
/**
* @return Date format
*/
get: function () {
return this._intlLocales;
},
/**
* Locales if you are using date formats in `Intl.DateTimeFormatOptions` syntax.
*
* @param value Locales
*/
set: function (value) {
this._intlLocales = value;
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "utc", {
/**
* @return Use UTC?
*/
get: function () {
return this._utc;
},
/**
* Should formatter use UTC functions?
*
* If UTC is used, all date/time values will be independent on client's
* time zone.
*
* @param value Use UTC?
*/
set: function (value) {
this._utc = value;
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "timezoneOffset", {
/**
* @return Offset (minutes)
*/
get: function () {
return this._timezoneOffset;
},
/**
* If set, will apply specific offset in minutes before formatting the date
* text.
*
* The value is a number of minutes from target time zone to UTC.
*
* E.g. `300` will recalculate Dates in "GMT-5" time zone.
*
* @param value Offset (minutes)
*/
set: function (value) {
if (this._timezoneOffset != value) {
this._timezoneOffset = value;
this.invalidateSprite();
}
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "timezone", {
/**
* @return Timezone
*/
get: function () {
return this._timezone;
},
/**
* If set, will format date/time in specific time zone.
*
* The value should be named time zone, e.g.:
* `"America/Vancouver"`, `"Australia/Sydney"`, `"UTC"`.
*
* @since 4.10.1
* @param value Timezone
*/
set: function (value) {
if (this._timezone != value) {
this._timezone = value;
this.timezoneMinutes = $time.getTimezoneMinutes(value);
this.invalidateSprite();
}
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "firstDayOfWeek", {
/**
* @return First day of week
*/
get: function () {
return this._firstDayOfWeek;
},
/**
* First day of the week:
*
* * 0 - Sunday
* * 1 - Monday
* * 2 - Tuesday
*
* Etc.
*
* @param value First day of week
*/
set: function (value) {
this._firstDayOfWeek = value;
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
Object.defineProperty(DateFormatter.prototype, "outputFormat", {
/**
* @ignore Exclude from docs
* @return Format
*/
get: function () {
return this._outputFormat;
},
/**
* Output format for the formatted date.
*
* @ignore Exclude from docs
* @param value Format
*/
set: function (value) {
this._outputFormat = value.toLowerCase();
this.invalidateSprite();
},
enumerable: true,
configurable: true
});
return DateFormatter;
}(BaseObject));
export { DateFormatter };
/**
* Register class in system, so that it can be instantiated using its name from
* anywhere.
*
* @ignore
*/
registry.registeredClasses["DateFormatter"] = DateFormatter;
//# sourceMappingURL=DateFormatter.js.map