npmpackage.info

Gathering detailed insights and metrics for d3plus-format

d3plus-format

Shorthand formatters for common number types.

1.2.8

MIT

JavaScript

388.26 kB

197,852 2.5

Installations

npm install d3plus-format

Developer Guide

BETA

Typescript

No

Module System

ESM

Node Version

16.16.0

NPM Version

8.17.0 Score

76.9

Supply Chain

99.5

Quality

77.1

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

22

Closed

14

Merged

8

Issues

Open

0

Total

2

Closed

2

Releases

v1.2.8

Published on 20 Aug 2024

v1.2.7

Published on 18 Jan 2024

v1.2.6

Published on 19 Jul 2023

v1.1.3

Published on 19 Jul 2023

v1.1.2

Published on 06 Jul 2023

v1.2.5

Published on 06 Jul 2023

View all 36 releases

Contributors

Unable to fetch Contributors

View all 8 contributors

Languages

JavaScript

JavaScript (100%)

Developer

d3plus

Download Statistics

Total Downloads

197,852

Last Day

Last Week

625

Last Month

3,571

Last Year

36,738

GitHub Statistics

1 Stars

165 Commits

5 Watching

2 Branches

8 Contributors

Maintainers

Package Meta Information

Latest Version

1.2.8

Package Id

d3plus-format@1.2.8

Unpacked Size

388.26 kB

Size

101.17 kB

File Count

NPM Version

8.17.0

Node Version

16.16.0

Publised On

20 Aug 2024

Total Downloads

Cumulative downloads

Total Downloads

197,852

Last day

-65.5%

Compared to previous day

Last week

-51.2%

625

Compared to previous week

Last month

-5.9%

3,571

Compared to previous month

Last year

20%

36,738

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

d3-format d3-time d3-time-format

Dev Dependencies

d3plus-dev

Versions

d3plus-format

Shorthand formatters for common number types.

Installing

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

1import modules from "d3plus-format";

d3plus-format can be loaded as a standalone library or bundled as part of D3plus. ES modules, AMD, CommonJS, and vanilla environments are supported. In vanilla, a d3plus global is exported:

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

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using d3plus-react. These examples are powered by the d3plus-storybook repo, and PRs are always welcome. :beers:

API Reference

format - An extension to d3's format function that adds more string formatting types and localizations.

The new specifier strings added by d3plus-format are:

.3~a - abbreviated decimal notation with a numeric suffix (ie. "k", "M", "B", etc). This is an alias of the formatAbbreviate function.

formatAbbreviate - Formats a number to an appropriate number of decimal places and rounding, adding suffixes if applicable (ie. 1200000 to "1.2M").
formatDate - 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.
formatDefaultLocale - An extension to d3's formatDefaultLocale function that allows setting the locale globally for formatters.

formatLocale - A set of default locale formatters used when assigning suffixes and currency in numbers.

Name	Default	Description
separator	""	Separation between the number with the suffix.
suffixes	[]	List of suffixes used to format numbers.
grouping	[3]	The array of group sizes,
delimiters	{thousands: ",", decimal: "."}	Decimal and group separators.
currency	["$", ""]	The currency prefix and suffix.

d3plus.format(specifier) <>

An extension to d3's format function that adds more string formatting types and localizations.

The new specifier strings added by d3plus-format are:

.3~a - abbreviated decimal notation with a numeric suffix (ie. "k", "M", "B", etc). This is an alias of the formatAbbreviate function.

This is a global function.

d3plus.formatAbbreviate(n, locale) <>

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

This is a global function.

Param	Type	Description
n	`Number` \| `String`	The number to be formatted.
locale	`Object` \| `String`	The locale config to be used. If value is an object, the function will format the numbers according the object. The object must include `suffixes`, `delimiter` and `currency` properties.

d3plus.formatDate(d, dataArray, [formatter]) <>

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.

This is a global function.

Param	Type	Default	Description
d	`Date`		The date string to be formatted.
dataArray	`Array`		The full array of ordered Date Objects.
[formatter]	`function`	`d3.timeFormat`	An optional instance of d3.timeFormat to be used for localization.

d3plus.formatDefaultLocale(definition) <>

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

This is a global function.

formatLocale <>

A set of default locale formatters used when assigning suffixes and currency in numbers.

Name	Default	Description
separator	""	Separation between the number with the suffix.
suffixes	[]	List of suffixes used to format numbers.
grouping	[3]	The array of group sizes,
delimiters	{thousands: ",", decimal: "."}	Decimal and group separators.
currency	["$", ""]	The currency prefix and suffix.

This is a global namespace.

_{Documentation generated on Tue, 20 Aug 2024 20:27:12 GMT}

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More