For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.util.Format

This class is a centralized place for formatting functions inside the library. It includes functions to format various different types of data, such as text, dates and numeric values.

Localization This class contains several options for localization. These can be set once the library has loaded, all calls to the functions from that point will use the locale settings that were specified. Options include: - thousandSeparator - decimalSeparator - currenyPrecision - currencySign - currencyAtEnd This class also uses the default date format defined here: Ext.date.defaultFormat.

Using with renderers There are two helper functions that return a new function that can be used in conjunction with grid renderers:

    columns: [{
        dataIndex: 'date',
        renderer: Ext.util.Format.dateRenderer('Y-m-d')
    }, {
        dataIndex: 'time',
        renderer: Ext.util.Format.numberRenderer('0.000')
    }]

Functions that only take a single argument can also be passed directly:

    columns: [{
        dataIndex: 'cost',
        renderer: Ext.util.Format.usMoney
    }, {
        dataIndex: 'productCode',
        renderer: Ext.util.Format.uppercase
    }]

Using with XTemplates XTemplates can also directly use Ext.util.Format functions:

    new Ext.XTemplate([
        'Date: {startDate:date("Y-m-d")}',
        'Cost: {cost:usMoney}'
    ]);

Defined By

### Properties

Ext.util.Format
view source
capitalize : Object

Capitalize the given string. See Ext.String.capitalize.

Capitalize the given string. See Ext.String.capitalize.

Ext.util.Format
view source
currencyAtEnd : Boolean
This may be set to true to make the currency function append the currency sign to the formatted value. This default...

This may be set to `true` to make the currency function append the currency sign to the formatted value.

This defaults to `false`, but may be overridden in a locale file.

Ext.util.Format
view source
currencyPrecision : Number
The number of decimal places that the currency function displays. This defaults to 2, but may be overridden in a lo...

The number of decimal places that the currency function displays.

This defaults to `2`, but may be overridden in a locale file.

Ext.util.Format
view source
currencySign : String

The currency sign that the currency function displays.

This defaults to `$`, but may be overridden in a locale file.

The currency sign that the currency function displays.

This defaults to `$`, but may be overridden in a locale file.

Ext.util.Format
view source
decimalSeparator : String
The character that the number function uses as a decimal point. This defaults to ., but may be overridden in a loca...

The character that the number function uses as a decimal point.

This defaults to `.`, but may be overridden in a locale file.

Ext.util.Format
view source
ellipsis : Object

Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length. See Ext.String.ellipsis.

Truncate a string and add an ellipsis ('...') to the end if it exceeds the specified length. See Ext.String.ellipsis.

Ext.util.Format
view source
format : Object

Formats to a string. See Ext.String.format

Formats to a string. See Ext.String.format

Ext.util.Format
view source
htmlDecode : Object

Convert certain characters (&, <, >, and ') from their HTML character equivalents. See Ext.string.htmlDecode.

Convert certain characters (&, <, >, and ') from their HTML character equivalents. See Ext.string.htmlDecode.

Ext.util.Format
view source
htmlEncode : Object
Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pag...

Convert certain characters (&, <, >, and ') to their HTML character equivalents for literal display in web pages. See Ext.String.htmlEncode.

Ext.util.Format
view source
leftPad : Object

Adds left padding to a string. See Ext.String.leftPad

Adds left padding to a string. See Ext.String.leftPad

Ext.util.Format
view source
thousandSeparator : String
The character that the number function uses as a thousand separator. This defaults to ,, but may be overridden in a...

The character that the number function uses as a thousand separator.

This defaults to `,`, but may be overridden in a locale file.

Ext.util.Format
view source
trim : Object

Trims any whitespace from either side of a string. See Ext.String.trim.

Trims any whitespace from either side of a string. See Ext.String.trim.

Defined By

### Methods

Ext.util.Format
view source
currency( Number/String value, String sign, Number decimals, Boolean end) : String

Format a number as a currency

Format a number as a currency

### Parameters

- value : Number/String

  The numeric value to format

- sign : String

  The currency sign to use (defaults to currencySign)

- decimals : Number

  The number of decimals to use for the currency (defaults to currencyPrecision)

- end : Boolean

  True if the currency sign should be at the end of the string (defaults to currencyAtEnd)

### Returns

- String

  The formatted currency string

Ext.util.Format
view source
date( String/Date value, String format) : String

Formats the passed date using the specified format pattern.

Formats the passed date using the specified format pattern.

### Parameters

- value : String/Date

  The value to format. If a string is passed, it is converted to a Date by the Javascript Date object's parse() method.

- format : String

  (Optional) Any valid date format string. Defaults to Ext.Date.defaultFormat.

### Returns

- String

  The formatted date string.

Ext.util.Format
view source
dateRenderer( String format) : Function

Returns a date rendering function that can be reused to apply a date format multiple times efficiently

Returns a date rendering function that can be reused to apply a date format multiple times efficiently

### Parameters

- format : String

  Any valid date format string. Defaults to Ext.Date.defaultFormat.

### Returns

- Function

  The date formatting function

Ext.util.Format
view source
defaultValue( Mixed value, String defaultValue) : String

Checks a reference and converts it to the default value if it's empty

Checks a reference and converts it to the default value if it's empty

### Parameters

- value : Mixed

  Reference to check

- defaultValue : String

  The value to insert of it's undefined (defaults to "")

### Returns

- String

Ext.util.Format
view source
escapeRegex( String str) : String

Escapes the passed string for use in a regular expression

Escapes the passed string for use in a regular expression

### Parameters

- str : String

### Returns

- String

Ext.util.Format
view source
fileSize( Number/String size) : String

Simple format for a file size (xxx bytes, xxx KB, xxx MB)

Simple format for a file size (xxx bytes, xxx KB, xxx MB)

### Parameters

- size : Number/String

  The numeric value to format

### Returns

- String

  The formatted file size

Ext.util.Format
view source
lowercase( String value) : String

Converts a string to all lower case letters

Converts a string to all lower case letters

### Parameters

- value : String

  The text to convert

### Returns

- String

  The converted text

Ext.util.Format
view source
math : Function
It does simple math for use in a template, for example: var tpl = new Ext.Template('{value} * 10 = {value:math("* 10...

It does simple math for use in a template, for example:

    var tpl = new Ext.Template('{value} * 10 = {value:math("* 10")}');

### Returns

- Function

  A function that operates on the passed value.

Ext.util.Format
view source
nl2br( String The) : String

Converts newline characters to the HTML tag <br/>

Converts newline characters to the HTML tag <br/>

### Parameters

- The : String

  string value to format.

### Returns

- String

  The string with embedded <br/> tags in place of newlines.

Ext.util.Format
view source
number( Number v, String format) : String
Formats the passed number according to the passed format string. The number of digits after the decimal separator c...

Formats the passed number according to the passed format string.

The number of digits after the decimal separator character specifies the number of decimal places in the resulting string. The local-specific decimal character is used in the result.

The presence of a thousand separator character in the format string specifies that the locale-specific thousand separator (if any) is inserted separating thousand groups.

By default, "," is expected as the thousand separator, and "." is expected as the decimal separator.

New to Ext4

Locale-specific characters are always used in the formatted output when inserting thousand and decimal separators.

The format string must specify separator characters according to US/UK conventions ("," as the thousand separator, and "." as the decimal separator)

To allow specification of format strings according to local conventions for separator characters, add the string `/i` to the end of the format string.

examples (123456.789):
0 - (123456) show only digits, no precision
0.00 - (123456.78) show only digits, 2 precision
0.0000 - (123456.7890) show only digits, 4 precision
0,000 - (123,456) show comma and digits, no precision
0,000.00 - (123,456.78) show comma and digits, 2 precision
0,0.00 - (123,456.78) shortcut method, show comma and digits, 2 precision
To allow specification of the formatting string using UK/US grouping characters (,) and decimal (.) for international numbers, add /i to the end. For example: 0.000,00/i

### Parameters

- v : Number

  The number to format.

- format : String

  The way you would like to format this text.

### Returns

- String

  The formatted number.

Ext.util.Format
view source
numberRenderer( String format) : Function

Returns a number rendering function that can be reused to apply a number format multiple times efficiently

Returns a number rendering function that can be reused to apply a number format multiple times efficiently

### Parameters

- format : String

  Any valid number format string for number

### Returns

- Function

  The number formatting function

Ext.util.Format
view source
parseBox( Number|String v) : Object
Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, ...

Parses a number or string representing margin sizes into an object. Supports CSS-style margin declarations (e.g. 10, "10", "10 10", "10 10 10" and "10 10 10 10" are all valid options and would return the same result)

### Parameters

- v : Number|String

  The encoded margins

### Returns

- Object

  An object with margin sizes for top, right, bottom and left

Ext.util.Format
view source
plural( Number value, String singular, [String plural]) : void
Selectively do a plural form of a word based on a numeric value. For example, in a template, {commentCount:plural("Co...

Selectively do a plural form of a word based on a numeric value. For example, in a template, {commentCount:plural("Comment")} would result in "1 Comment" if commentCount was 1 or would be "x Comments" if the value is 0 or greater than 1.

### Parameters

- value : Number

  The value to compare against

- singular : String

  The singular form of the word

- plural : String

  (optional) The plural form of the word (defaults to the singular with an "s")

### Returns

- void

Ext.util.Format
view source
round( Number/String value, Number precision) : Number

Rounds the passed number to the required decimal precision.

Rounds the passed number to the required decimal precision.

### Parameters

- value : Number/String

  The numeric value to round.

- precision : Number

  The number of decimal places to which to round the first parameter's value.

### Returns

- Number

  The rounded value.

Ext.util.Format
view source
stripScripts( Mixed value) : String

Strips all script tags

Strips all script tags

### Parameters

- value : Mixed

  The text from which to strip script tags

### Returns

- String

  The stripped text

Ext.util.Format
view source
stripTags( Mixed value) : String

Strips all HTML tags

Strips all HTML tags

### Parameters

- value : Mixed

  The text from which to strip tags

### Returns

- String

  The stripped text

Ext.util.Format
view source
substr( String value, Number start, Number length) : String

Returns a substring from within an original string

Returns a substring from within an original string

### Parameters

- value : String

  The original text

- start : Number

  The start index of the substring

- length : Number

  The length of the substring

### Returns

- String

  The substring

Ext.util.Format
view source
undef( Mixed value) : Mixed

Checks a reference and converts it to empty string if it is undefined

Checks a reference and converts it to empty string if it is undefined

### Parameters

- value : Mixed

  Reference to check

### Returns

- Mixed

  Empty string if converted, otherwise the original value

Ext.util.Format
view source
uppercase( String value) : String

Converts a string to all upper case letters

Converts a string to all upper case letters

### Parameters

- value : String

  The text to convert

### Returns

- String

  The converted text

Ext.util.Format
view source
usMoney( Number/String value) : String

Format a number as US currency

Format a number as US currency

### Parameters

- value : Number/String

  The numeric value to format

### Returns

- String

  The formatted currency string