Globalization

Globalization

The globalization object obtains information and performs operations specific to the user's locale and timezone.

Objects

Methods

Variable Scope

The globalization object is a child of the navigator object, and therefore has global scope.

// The global globalization object
var globalization = navigator.globalization;

Permissions

Android

app/res/xml/config.xml

<plugin name="Globalization" value="org.apache.cordova.Globalization" />

globalization.getPreferredLanguage

Get the string identifier for the client's current language.

navigator.globalization.getPreferredLanguage(successCB, errorCB);

Description

It returns the language identifier string to the successCB callback with a properties object as a parameter. That object should have a value property with a String value.

If there is an error getting the language, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN_ERROR.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with the text "language: English".

navigator.globalization.getPreferredLanguage(
  function (language) {alert('language: ' + language.value + '\n');},
  function () {alert('Error getting language\n');}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkLanguage() {
      navigator.globalization.getPreferredLanguage(
        function (language) {alert('language: ' + language.value + '\n');},
        function () {alert('Error getting language\n');}
      );
    }
    </script>
  </head>
  <body>
    <button onclick="checkLanguage()">Click for language</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.getLocaleName

Get the string identifier for the client's current locale setting.

navigator.globalization.getLocaleName(successCB, errorCB);

Description

It returns the locale identifier string to the successCB callback with a properties object as a parameter. That object should have a value property with a String value.

If there is an error getting the locale, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN_ERROR.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with the text "locale: en_US".

navigator.globalization.getLocaleName(
  function (locale) {alert('locale: ' + locale.value + '\n');},
  function () {alert('Error getting locale\n');}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkLocale() {
      navigator.globalization.getLocaleName(
        function (locale) {alert('locale: ' + locale.value + '\n');},
        function () {alert('Error getting locale\n');}
      );
    }
    </script>
  </head>
  <body>
    <button onclick="checkLocale()">Click for locale</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.dateToString

Returns a date formatted as a string according to the client's locale and timezone.

navigator.globalization.dateToString(date, successCB, errorCB, options);

Description

It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a value property with a String value.

The inbound date parameter should be of type Date.

If there is an error formatting the date, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING_ERROR.

options.formatLength can be 'short', 'medium', 'long', or 'full'. options.selector can be 'date', 'time' or 'date and time'.

The default options are {formatLength:'short', selector:'date and time'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options.

navigator.globalization.dateToString(
  new Date(),
  function (date) {alert('date:' + date.value + '\n');},
  function () {alert('Error getting dateString\n');},
  {formatLength:'short', selector:'date and time'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkDateString() {
      navigator.globalization.dateToString(
        new Date(),
        function (date) {alert('date: ' + date.value + '\n');},
        function () {alert('Error getting dateString\n');,
        {formatLength:'short', selector:'date and time'}}
      );
    }
    </script>
  </head>
  <body>
    <button onclick="checkDateString()">Click for date string</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.stringToDate

Parses a date formatted as a string according to the client's user preferences and calendar using the time zone of the client and returns the corresponding date object.

navigator.globalization.stringToDate(dateString, successCB, errorCB, options);

Description

It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:

The inbound dateString parameter should be of type String.

options.formatLength can be 'short', 'medium', 'long', or 'full'. options.selector can be 'date', 'time' or 'date and time'.

The default options are {formatLength:'short', selector:'date and time'}. The options parameter is optional.

If there is an error parsing the date string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING_ERROR.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "month:8 day:25 year:2012". Note that the month integer is one less than the string, as the month integer represents an index.

navigator.globalization.stringToDate(
  '9/25/2012',
  function (date) {alert('month:' + date.month +
                         ' day:' + date.day + 
                         ' year:' + date.year + '\n');},
  function () {alert('Error getting date\n');},
  {selector:'date'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkStringDate() {
      navigator.globalization.stringToDate(
        '9/25/2012',
        function (date) {alert('month:' + date.month +
                               ' day:' + date.day + 
                               ' year:' + date.year + '\n');},
        function () {alert('Error getting date\n');},
        {selector:'date'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkStringDate()">Click for parsed date</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.getDatePattern

Returns a pattern string for formatting and parsing dates according to the client's user preferences.

navigator.globalization.getDatePattern(successCB, errorCB, options);

Description

It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:

If there is an error obtaining the pattern, then the errorCB callback is invokedwith a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN_ERROR.

options.formatLength can be 'short', 'medium', 'long', or 'full'. options.selector can be 'date', 'time' or 'date and time'.

The default options are {formatLength:'short', selector:'date and time'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".

function checkDatePattern() {
  navigator.globalization.getDatePattern(
    function (date) {alert('pattern: ' + date.pattern + '\n');},
    function () {alert('Error getting pattern\n');},
    {formatLength:'short', selector:'date and time'}
  );
}

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkDatePattern() {
      navigator.globalization.getDatePattern(
        function (date) {alert('pattern: ' + date.pattern + '\n');},
        function () {alert('Error getting pattern\n');},
        {formatLength:'short', selector:'date and time'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkDatePattern()">Click for pattern</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.getDateNames

Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.

navigator.globalization.getDateNames(successCB, errorCB, options);

Description

It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a value property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.

If there is an error obtaining the names, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN_ERROR.

options.type can be 'narrow', or 'wide'. options.item can be 'months', or 'days'.

The default options are {type:'wide', item:'months'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"

navigator.globalization.getDateNames(
  function (names) {
    for (var i=0; i<names.value.length; i++) {
      alert('month: ' + names.value[i] + '\n');
    }
  },
  function () {alert('Error getting names\n');},
  {type:'wide', item:'months'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkDateNames() {
      navigator.globalization.getDateNames(
        function (names) {
          for (var i=0; i<names.value.length; i++) {
            alert('month: ' + names.value[i] + '\n');
          }
        },
        function () {alert('Error getting names\n');},
        {type:'wide', item:'months'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkDateNames()">Click for date names</button>
  </body>
</html>

globalization.isDayLightSavingsTime

Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.

navigator.globalization.isDayLightSavingsTime(date, successCB, errorCB);

Description

It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a dst property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.

The inbound parameter date should be of type Date.

If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is GlobalizationError.UNKNOWN_ERROR.

Supported Platforms

Quick Example

In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true".

navigator.globalization.isDayLightSavingsTime(
  new Date(),
  function (date) {alert('dst: ' + date.dst + '\n');},
  function () {alert('Error getting names\n');}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkDayLightSavings() {
      navigator.globalization.isDayLightSavingsTime(
        new Date(),
        function (date) {alert('dst: ' + date.dst + '\n');},
        function () {alert('Error getting names\n');}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkDayLightSavings()">Click for daylight savings</button>
  </body>
</html>

globalization.getFirstDayOfWeek

Returns the first day of the week according to the client's user preferences and calendar.

navigator.globalization.getFirstDayOfWeek(successCB, errorCB);

Description

The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a value property with a Number value.

If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.UNKNOWN_ERROR.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "day: 1".

navigator.globalization.getFirstDayOfWeek(
  function (day) {alert('day: ' + day.value + '\n');},
  function () {alert('Error getting day\n');}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkFirstDay() {
      navigator.globalization.getFirstDayOfWeek(
        function (day) {alert('day: ' + day.value + '\n');},
        function () {alert('Error getting day\n');}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkFirstDay()">Click for first day of week</button>
  </body>
</html>

globalization.numberToString

Returns a number formatted as a string according to the client's user preferences.

navigator.globalization.numberToString(number, successCB, errorCB, options);

Description

It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a value property with a String value.

If there is an error formatting the number, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING_ERROR.

options.type can be 'decimal', 'percent', or 'currency'. The default options are {type:'decimal'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "number: 3.142"

navigator.globalization.numberToString(
  3.1415926,
  function (number) {alert('number: ' + number.value + '\n');},
  function () {alert('Error getting number\n');},
  {type:'decimal'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkNumber() {
      navigator.globalization.numberToString(
        3.1415926,
        function (number) {alert('number: ' + number.value + '\n');},
        function () {alert('Error getting number\n');},
        {type:'decimal'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkNumber()">Click for number</button>
  </body>
</html>

globalization.stringToNumber

Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.

navigator.globalization.stringToNumber(string, successCB, errorCB, options);

Description

It returns the number to the successCB callback with a properties object as a parameter. That object should have a value property with a Number value.

If there is an error parsing the number string, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PARSING_ERROR.

options.type can be 'decimal', 'percent', or 'currency'. The default options are {type:'decimal'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "number: 1234.56".

navigator.globalization.stringToNumber(
  '1234.56',
  function (number) {alert('number: ' + number.value + '\n');},
  function () {alert('Error getting number\n');},
  {type:'decimal'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkNumber() {
      navigator.globalization.stringToNumber(
        '1234.56',
        function (number) {alert('number: ' + number.value + '\n');},
        function () {alert('Error getting number\n');},
        {type:'decimal'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkNumber()">Click for parsed number</button>
  </body>
</html>

globalization.getNumberPattern

Returns a pattern string for formatting and parsing numbers according to the client's user preferences.

navigator.globalization.getNumberPattern(successCB, errorCB, options);

Description

It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:

If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.PATTERN_ERROR.

options.type can be 'decimal', 'percent', or 'currency'. The default options are {type:'decimal'}. The options parameter is optional.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to:

pattern: #,##0.###
symbol: .
fraction: 0
rounding: 0
positive: 
negative: -
decimal: .
grouping: ,

.

navigator.globalization.getNumberPattern(
  function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
                            'symbol: ' + pattern.symbol + '\n' +
                            'fraction: ' + pattern.fraction + '\n' +
                            'rounding: ' + pattern.rounding + '\n' +
                            'positive: ' + pattern.positive + '\n' +
                            'negative: ' + pattern.negative + '\n' +
                            'decimal: ' + pattern.decimal + '\n' +
                            'grouping: ' + pattern.grouping);},
  function () {alert('Error getting pattern\n');},
  {type:'decimal'}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkPattern() {
      navigator.globalization.getNumberPattern(
        function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
                                  'symbol: ' + pattern.symbol + '\n' +
                                  'fraction: ' + pattern.fraction + '\n' +
                                  'rounding: ' + pattern.rounding + '\n' +
                                  'positive: ' + pattern.positive + '\n' +
                                  'negative: ' + pattern.negative + '\n' +
                                  'decimal: ' + pattern.decimal + '\n' +
                                  'grouping: ' + pattern.grouping);},
        function () {alert('Error getting pattern\n');},
        {type:'decimal'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkPattern()">Click for pattern</button>
  </body>
</html>

Windows Phone 8 Quirks


globalization.getCurrencyPattern

Returns a pattern string for formatting and parsing currency values according to the client's user preferences and ISO 4217 currency code.

 navigator.globalization.getCurrencyPattern(currencyCode, successCB, errorCB);

Description

It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:

The inbound currencyCode parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'.

If there is an error obtaining the pattern, then the errorCB callback is invoked with a GlobalizationError object as a parameter. The expected code for this error is GlobalizationError.FORMATTING_ERROR.

Supported Platforms

Quick Example

In the case when the browser is set to the en_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to:

pattern: $#,##0.##;($#,##0.##)
code: USD
fraction: 2
rounding: 0
decimal: .
grouping: ,

.

navigator.globalization.getCurrencyPattern(
  'USD',
  function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
                            'code: ' + pattern.code + '\n' +
                            'fraction: ' + pattern.fraction + '\n' +
                            'rounding: ' + pattern.rounding + '\n' +
                            'decimal: ' + pattern.decimal + '\n' +
                            'grouping: ' + pattern.grouping);},
  function () {alert('Error getting pattern\n');}
);

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function checkPattern() {
      navigator.globalization.getCurrencyPattern(
        'USD',
        function (pattern) {alert('pattern: ' + pattern.pattern + '\n' +
                                  'code: ' + pattern.code + '\n' +
                                  'fraction: ' + pattern.fraction + '\n' +
                                  'rounding: ' + pattern.rounding + '\n' +
                                  'decimal: ' + pattern.decimal + '\n' +
                                  'grouping: ' + pattern.grouping);},
        function () {alert('Error getting pattern\n');}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkPattern()">Click for pattern</button>
  </body>
</html>

GlobalizationError

An object representing a error from the Globalization API.

Properties

Description

This object is created and populated by Cordova, and returned to a callback in the case of an error.

Supported Platforms

Quick Example

When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".

function errorCB(error) {
    alert('code: ' + error.code + '\n' +
          'message: ' + error.message + '\n');
};

Full Example

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.3.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    function successCB(date) {
      alert('month:' + date.month +
            ' day:' + date.day + 
            ' year:' + date.year + '\n');
    }

    function errorCB(error) {
      alert('code: ' + error.code + '\n' +
            'message: ' + error.message + '\n');
    };

    function checkError() {
      navigator.globalization.stringToDate(
        'notADate',
        successCB,
        errorCB,
        {selector:'foobar'}
      );
    }

    </script>
  </head>
  <body>
    <button onclick="checkError()">Click for error</button>
  </body>
</html>