Formatting Dates, Numbers and Strings

Topic Overview

Purpose

This topic explains how to format dates, numbers and strings using the $.ig.formatter utility function.

In this topic

This topic contains the following sections:

• Introduction
• Formatting Dates
• Formatting Numbers
• Formatting Strings

Introduction

The infragistics.util files contain an utility function $.ig.formatter that is used to format dates, numbers and strings across the Ignite UI for jQuery controls. For example the igGrid uses it in the format option. The function signature is: $.ig.formatter = function (val, type, format, notTemplate, enableUTCDates, displayStyle, labelText, tabIndex). Result is of type string.

The topic will focus only on the first three parameters of the function:

• val - the value that is going to be formatted.
• type - data type of the value.
• format - format specifier (explained in detail in the following sections).

The function takes into an account the regional settings configured in the $.ig.regional.defaults variable.

Following sections will explain the usage of $.ig.formatter in greater detail.

Formatting Dates

When type parameter is "date" the $.ig.formatter function parses dates. The val argument should be of type Date.

In JavaScript:

var result = $.ig.formatter(new Date(2016, 05, 01), "date", "yyyy-MM-dd"); // result is "2016-06-01"

List of supported format specifiers:

Formatting Numbers

When type parameter is "number" the $.ig.formatter function parses numbers. The val argument should be of type Number.

In JavaScript:

var result = $.ig.formatter(0.55, "number", "0.0"); // result is "0.6"

List of supported format specifiers:

Formatting Strings

When type parameter is "string" the $.ig.formatter function parses strings. The {0} placeholder can be used in the format parameter to denote the position of the value parameter in the resulting string.

In JavaScript:

var result = $.ig.formatter("Black", "string", "Color is {0}");