DataTable.BodyView.Formatters Class

Returns a formatter function that returns the texts "true" or "false" and assigns the CSS classNames yui3-datatable-true or yui3-datatable-false based on the value of the cell.

If either a booleanLabels configuration object is defined for the column or a booleanLabels configuration attribute is defined for the datatable, the formatter will use the values for the properties true or false of either of those objects as the text to show.

It returns nulls or undefineds unchanged so that the emptyCellValue configuration attribute will eventually apply.

 {key:"active", formatter: "boolean", booleanLabels: {
     "true": "yes",
     "false": "no"
 }}

Returns a formatter that produces a BUTTON element using the value of the buttonLabel column definition attribute as its label or the text Click if not found.

Applies the CSS className yui3-datatable-button to the cell.

Returns a formatter function that formats values as currency using the Number.format method. It looks for the format to apply in the currencyFormat property of the column or in the currencyFormat attribute of the whole table.

{key: "amount", formatter: "currency", currencyFormat: {
    decimalPlaces:2,
    decimalSeparator: ",",
    thousandsSeparator: ".",
    suffix: "€"
}}

See Number.format for the available format specs.

Anything that cannot be parsed as a number will be returned unchanged.

Applies the CSS className yui3-datatable-currency to the cell.

Returns a date formatting function. It looks for the format to apply in the dateFormat property of the column or in the dateFormat attribute of the whole table.

{key: "DOB", formatter: "date", dateFormat: "%I:%M:%S %p"}

See Date.format for the available format specs.

Anything that is not a date is returned unchanged.

Applies the CSS className yui3-datatable-date to the cell.

Returns a function that produces email links. If the column definition contains a property linkFrom it will use the value in that field for the link, otherwise, the same column value will be used for both link and text.

{key: "contact", formatter: "email", linkFrom: "contactEmail"}

It will use the respective emptyCellValue column configuration attribute for each of the value and the link if either is empty. If the link value is still empty, it will return the value with no link.

Applies the CSS className yui3-datatable-email to the cell.

Returns a function that produces links. If the column definition contains a property linkFrom it will use the value in that field for the link, otherwise, the same column value will be used for both link and text.

{key: "company", formatter: "link", linkFrom: "webSite"}

It will use the respective emptyCellValue column configuration attribute for each of the value and the link if either is empty. If the link value is still empty, it will return the value with no link.

Applies the CSS className yui3-datatable-link to the cell.

Returns a date-only (no time part) formatting function using the current locale.

{key: "DOB", formatter: "localDate"}

Anything that is not a date is returned unchanged.

Applies the CSS className yui3-datatable-date to the cell.

Returns a date formatting function using the current locale.

{key: "DOB", formatter: "localDateTime"}

Anything that is not a date is returned unchanged.

Applies the CSS className yui3-datatable-date to the cell.

Returns a time-only (no date part) formatting function using the current locale.

{key: "startTime", formatter: "localTime"}

Anything that is not a date is returned unchanged.

Applies the CSS className yui3-datatable-date to the cell.

Returns a formatter function that returns texts from a lookup table based on the stored value.

It looks for the translation to apply in the lookupTable property of the column in either of these two formats:

{key: "status", formatter: "lookup", lookupTable: {
    0: "unknown",
    1: "requested",
    2: "approved",
    3: "delivered"
}},
{key: "otherStatus", formatter: "lookup", lookupTable: [
    {value:0, text: "unknown"},
    {value:1, text: "requested"},
    {value:2, text: "approved"},
    {value:3, text: "delivered"}
]}

Applies the CSS className yui3-datatable-lookup to the cell.

Returns a formatter function that formats values using the Number.format method. It looks for the format to apply in the numberFormat property of the column or in the numberFormat attribute of the whole table.

 {key: "weight", formatter: "number", numberFormat: {
     decimalPlaces:2,
     decimalSeparator: ",",
     thousandsSeparator: ",",
     suffix: "kg"
 }}

See Number.format for the available format specs.

Anything that cannot be parsed as a number will be returned unchanged.

Applies the CSS className yui3-datatable-number to the cell.

Creates the <tfoot> Node and inserts it after the <thead> Node.