Different countries and regions have their own rules for writing dates, numbers, monetary units and text labels. All these issues should be taken in account in case the target group for your application is wider than one country or region.
The set of rules for this or that country is called a locale and includes methods for date, time, number, price and label formatting. Localization methods belong to the i18n class and treat data according to the set format.
By default, the Date() constructor outputs raw data. Unformatted, it looks barely readable.
new Date(2010,10,30); //-->Tue Nov 30 2010 00:00:00
Date and time should be formatted either with Date or the i18n class.
The complete list of Date formatting methods and supported format options.
Decimal and integer numbers are displayed with different delimiters, depending on the rules of a particular country. Prices should be rendered with appropriate currency marks.
Formatting is done either in the Number or the i18n class.
The standard package of the Webix library includes 10 locales, namely:
Webix Pro edition includes over 300 locales.
The way formatted data are presented depends on the locale you use. A locale is a set of rules for dates, numbers, price units and labels for this or that region or country. By default the en-US locale is used.
en-US Locale
webix.i18n.locales["en-US"]={
groupDelimiter:",",
groupSize:3,
decimalDelimiter:".",
decimalSize:2,
minusPosition:"before",
minusSign:"-",
dateFormat:"%m/%d/%Y",
timeFormat:"%h:%i %A",
longDateFormat:"%d %F %Y",
fullDateFormat:"%m/%d/%Y %h:%i %A",
am:["am","AM"],
pm:["pm","PM"],
price:"${obj}",
priceSettings:{
groupDelimiter:",",
groupSize:3,
decimalDelimiter:".",
decimalSize:2,
minusPosition:"before",
minusSign:"-",
},
fileSize: ["b","Kb","Mb","Gb","Tb","Pb","Eb"],
calendar: {
monthFull:[
"January", "February", "March", "April", "May", "June", "July",
"August", "September", "October", "November", "December"
],
monthShort:[
"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug",
"Sep", "Oct", "Nov", "Dec"
],
dayFull:[
"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday",
"Friday", "Saturday"
],
dayShort:["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"],
hours: "Hours",
minutes: "Minutes",
done:"Done",
clear: "Clear",
today: "Today"
},
dataExport:{
page:"Page",
of:"of"
},
PDFviewer:{
of:"of",
automaticZoom:"Automatic Zoom",
actualSize:"Actual Size",
pageFit:"Page Fit",
pageWidth:"Page Width",
pageHeight:"Page Height",
enterPassword:"Enter password",
passwordError:"Wrong password"
},
aria:{
calendar:"Calendar",
increaseValue:"Increase value",
decreaseValue:"Decrease value",
navMonth:["Previous month", "Next month"],
navYear:["Previous year", "Next year"],
navDecade:["Previous decade", "Next decade"],
dateFormat:"%d %F %Y",
monthFormat:"%F %Y",
yearFormat:"%Y",
hourFormat:"Hours: %h %A",
minuteFormat:"Minutes: %i",
removeItem:"Remove item",
pages:["First page", "Previous page", "Next page", "Last page"],
page:"Page",
headermenu:"Header menu",
openGroup:"Open column group",
closeGroup:"Close column group",
closeTab:"Close tab",
showTabs:"Show more tabs",
resetTreeMap:"Reset tree map",
navTreeMap:"Level up",
nextTab:"Next tab",
prevTab:"Previous tab",
multitextSection:"Add section",
multitextextraSection:"Remove section",
showChart:"Show chart",
hideChart:"Hide chart",
resizeChart:"Resize chart"
},
richtext:{
underline: "Underline",
bold: "Bold",
italic: "Italic"
},
combo:{
select:"Select",
selectAll:"Select all",
unselectAll:"Unselect all"
},
message:{
ok:"OK",
cancel:"Cancel"
},
comments:{
send: "Send",
confirmMessage: "The comment will be removed. Are you sure?",
edit: "Edit",
remove: "Remove",
placeholder: "Type here..",
moreComments:"More comments"
},
filter:{
less: "less",
lessOrEqual: "less or equal",
greater: "greater",
greaterOrEqual: "greater or equal",
contains: "contains",
notContains: "not contains",
equal: "equal",
notEqual: "not equal",
beginsWith: "begins with",
notBeginsWith: "not begins with",
endsWith: "ends with",
notEndsWith: "not ends with",
between: "between",
notBetween: "not between"
},
timeboard:{
seconds: "Seconds"
}
};
Numbers:
Date and Time:
Start Date:
By default, a week in the calendar starts on Sunday. However, you can set any day as a start day using the webix.Date.startOnMonday property
webix.Date.startOnMonday = true;
Price states monetary unit applied to the data from the data object ({obj}).
Calendar:
When formatted to a short/long date, the date from the first snippet looks like this:
Formatted with en-US locale
format:webix.i18n.dateFormatStr
//--> 11/30/2010
format:webix.i18n.longDateFormatSt
// --> 30 November 2010
Controls
Text labels for some parts of Webix components that are more likely to be changed in a scope, such as:
Data Export
Text labels that are used in the page numbering line in the footer of the exported PDF document include:
PDF Viewer
Text labels for page switching and document options in PDF Viewer are:
Aria
Text labels for widget interactive areas which properties cannot be configured by public API. These labels are set as values of the aria-label attribute and are used by screen reading software to announce the purpose of the element:
RichText
Text labels for the font style buttons in the RichText control are:
Combo
Text labels for the buttons used for selecting/unselecting items are:
Message
Text labels for the buttons used in the modal message boxes are:
Comments
Text labels for the buttons and context menu used in the Comments widget are:
Locales other than en-US should be set manually.
You should apply the chosen locale with the help of the setLocale() function that takes the locale name as a parameter.
webix.i18n.setLocale("fr-FR");
After this, any method applied to the webix.i18n object will redraw date and numbers according to the rules described in the applied locale.
format:webix.i18n.dateFormatStr
// --> 30/11/2010
format:webix.i18n.longDateFormatStr
// --> 30 Novembre 2010
To change one or several parameters for the current locale, you need to redefine them and then apply the same locale so that your changes come into force:
webix.i18n.fullDateFormat = "%Y-%m-%d %H:%i";
webix.i18n.setLocale(); // locale name is not specified here
Localization is done via the i18n class and allows setting customized formats gathered under one and the same locale.
In case of DataTable, the format is stated by the dedicated format parameter while data are specified by the column ID:
{ header:"Date", id:"start", format:webix.i18n.dateFormatStr},
{ header:"Price", id:"price", format:webix.i18n.priceFormat}
Related sample: DataTable Localization
Other components like List, DataView and Tree have quite the other way of data presenting. To ensure proper formatting, you should make use of a template function:
template:function(obj){
return webix.i18n.longDateFormatStr(obj.start)+"<br/>"+
webix.i18n.priceFormat(obj.price);
}
The format in use is defined by the current locale. The default EN-US locale sets dateFormatStr as "%m/%d/%Y", while the price format is set as "{obj}currency", where obj is the price value.
Related sample: Dataview Formatting
Back to top