Skip to content
This repository was archived by the owner on Jul 1, 2025. It is now read-only.

Commit da90418

Browse files
committed
updates documentation
1 parent d0d1363 commit da90418

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,18 @@ This is a global function.
7777
---
7878

7979
<a name="formatDate"></a>
80-
#### d3plus.**formatDate**(d, dataArray) [<>](https://github.com/d3plus/d3plus-format/blob/master/src/formatDate.js#L16)
80+
#### d3plus.**formatDate**(d, dataArray, [formatter]) [<>](https://github.com/d3plus/d3plus-format/blob/master/src/formatDate.js#L4)
8181

8282
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.
8383

8484

8585
This is a global function.
8686

87-
| Param | Type | Description |
88-
| --- | --- | --- |
89-
| d | <code>Date</code> | The date string to be formatted. |
90-
| dataArray | <code>Array</code> | The full array of ordered Date Objects. |
87+
| Param | Type | Default | Description |
88+
| --- | --- | --- | --- |
89+
| d | <code>Date</code> | | The date string to be formatted. |
90+
| dataArray | <code>Array</code> | | The full array of ordered Date Objects. |
91+
| [formatter] | <code>function</code> | <code>d3.timeFormat</code> | An optional instance of d3.timeFormat to be used for localization. |
9192

9293

9394
---
@@ -122,4 +123,4 @@ This is a global namespace.
122123

123124

124125

125-
###### <sub>Documentation generated on Wed, 19 Jul 2023 14:05:35 GMT</sub>
126+
###### <sub>Documentation generated on Thu, 18 Jan 2024 16:11:21 GMT</sub>

0 commit comments

Comments
 (0)