Skip to content

formatOrdinal

Formats a whole number as an ordinal for the given locale (1 to "1st" in English, "1.º" in Spanish, "1º" in Portuguese, "第1" in Chinese). BumpChart’s tooltips use it to read each rank.

English picks its suffix by the number’s ordinal plural category, so 11 reads as 11th but 22 as 22nd; other locales take their own form.

import {formatOrdinal} from "@d3plus/format";

formatOrdinal(1);
formatOrdinal(2);
formatOrdinal(3);
formatOrdinal(11);
formatOrdinal(22);
formatOrdinal(2, "es-ES");
formatOrdinal(2, "pt-BR");
formatOrdinal(2, "zh-CN");

Parameters

import {formatOrdinal} from "@d3plus/format";
nrequirednumber

The number to be formatted.

localestringDefault en-US

The locale, as a language-region tag ("es-ES") or a 2-letter language code ("es").