@d3plus/format

JavaScript formatters for localized numbers and dates.

Installing

If using npm, npm install @d3plus/format. Otherwise, you can download the latest release from GitHub or load from a CDN.

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

In a vanilla environment, a d3plus global is exported from the pre-bundled version:

<script src="https://cdn.jsdelivr.net/npm/@d3plus/format"></script>
<script>
  console.log(d3plus);
</script>

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using @d3plus/react.

API Reference

| Functions | Description | | --- | --- | | format | | | formatAbbreviate | Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 t | | formatDate | A default set of date formatters, which takes into account both the interval in between in each data point but also the | | formatDefaultLocale | An extension to d3's formatDefaultLocale function that allows setting t |

Functions

format()

format(specifier: string): Formatter

Defined in: format.ts:10

Parameters

| Parameter | Type | | ------ | ------ | | specifier | string |

Returns

Formatter

formatAbbreviate()

formatAbbreviate(n: string | number, locale?: string | FormatLocaleDefinition, precision?: string): string

Defined in: formatAbbreviate.ts:55

Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 to "1.2M").

Parameters

| Parameter | Type | Default | Description | | ------ | ------ | ------ | ------ | | n | string | number | required | The number to be formatted. | | locale | string | FormatLocaleDefinition | "en-US" | The locale config to be used. If an object is provided, the function will format the numbers according to the object. The object must include suffixes, delimiter and currency properties. | | precision? | string | required | Number of significant digits to display. |

Returns

string

formatDate()

formatDate(d: Date, dataArray: Date[], formatter?: DateFormatter): string

Defined in: formatDate.ts:12

A default set of date formatters, which takes into account both the interval in between in each data point but also the start/end data points.

Parameters

| Parameter | Type | Default | Description | | ------ | ------ | ------ | ------ | | d | Date | required | The date to format. | | dataArray | Date[] | required | The full array of ordered Date Objects. | | formatter | DateFormatter | timeFormat | Optional custom format string or function. |

Returns

string

formatDefaultLocale()

formatDefaultLocale(definition: FormatLocaleDefinition): Record<string, unknown>

Defined in: formatDefaultLocale.ts:8

An extension to d3's formatDefaultLocale function that allows setting the locale globally for formatters.

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | definition | FormatLocaleDefinition | The localization definition. |

Returns

Record<string, unknown>