@d3plus/docs 3.0.4 → 3.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/.storybook/preview-head.html +5 -0
  2. package/args/core/charts/AreaPlot.args.jsx +4 -1
  3. package/args/core/charts/BarChart.args.jsx +5 -1
  4. package/args/core/charts/BoxWhisker.args.jsx +4 -1
  5. package/args/core/charts/BumpChart.args.jsx +8 -1
  6. package/args/core/charts/Donut.args.jsx +4 -2
  7. package/args/core/charts/Geomap.args.jsx +29 -13
  8. package/args/core/charts/LinePlot.args.jsx +3 -1
  9. package/args/core/charts/Matrix.args.jsx +13 -2
  10. package/args/core/charts/Network.args.jsx +29 -16
  11. package/args/core/charts/Pack.args.jsx +11 -2
  12. package/args/core/charts/Pie.args.jsx +8 -1
  13. package/args/core/charts/Plot.args.jsx +56 -23
  14. package/args/core/charts/Priestley.args.jsx +6 -0
  15. package/args/core/charts/Radar.args.jsx +7 -1
  16. package/args/core/charts/RadialMatrix.args.jsx +15 -4
  17. package/args/core/charts/Rings.args.jsx +21 -10
  18. package/args/core/charts/Sankey.args.jsx +17 -5
  19. package/args/core/charts/Tree.args.jsx +46 -6
  20. package/args/core/charts/Treemap.args.jsx +15 -5
  21. package/args/core/charts/Viz.args.jsx +102 -24
  22. package/args/core/components/Axis.args.jsx +49 -12
  23. package/args/core/components/AxisBottom.args.jsx +1 -1
  24. package/args/core/components/AxisLeft.args.jsx +1 -1
  25. package/args/core/components/AxisRight.args.jsx +1 -1
  26. package/args/core/components/AxisTop.args.jsx +1 -1
  27. package/args/core/components/ColorScale.args.jsx +37 -10
  28. package/args/core/components/Legend.args.jsx +21 -5
  29. package/args/core/components/TextBox.args.jsx +40 -7
  30. package/args/core/components/Timeline.args.jsx +29 -5
  31. package/args/core/components/Tooltip.args.jsx +40 -12
  32. package/args/core/shapes/Area.args.jsx +11 -1
  33. package/args/core/shapes/Bar.args.jsx +10 -1
  34. package/args/core/shapes/Box.args.jsx +19 -5
  35. package/args/core/shapes/Circle.args.jsx +4 -1
  36. package/args/core/shapes/Image.args.jsx +13 -1
  37. package/args/core/shapes/Line.args.jsx +7 -1
  38. package/args/core/shapes/Path.args.jsx +4 -1
  39. package/args/core/shapes/Rect.args.jsx +4 -1
  40. package/args/core/shapes/Shape.args.jsx +49 -13
  41. package/args/core/shapes/Whisker.args.jsx +13 -2
  42. package/args/core/utils/BaseClass.args.jsx +4 -0
  43. package/args/core/utils/accessor.args.jsx +1 -3
  44. package/args/core/utils/constant.args.jsx +1 -1
  45. package/args/data/dataConcat.args.jsx +1 -1
  46. package/args/data/dataLoad.args.jsx +1 -1
  47. package/args/data/isData.args.jsx +1 -3
  48. package/args/data/merge.args.jsx +1 -1
  49. package/args/data/unique.args.jsx +1 -1
  50. package/args/dom/attrize.args.jsx +1 -3
  51. package/args/dom/elem.args.jsx +1 -3
  52. package/args/dom/fontExists.args.jsx +1 -1
  53. package/args/dom/isObject.args.jsx +1 -3
  54. package/args/dom/parseSides.args.jsx +1 -1
  55. package/args/dom/stylize.args.jsx +1 -3
  56. package/args/dom/textWidth.args.jsx +1 -1
  57. package/args/export/saveElement.args.jsx +1 -3
  58. package/args/format/formatDate.args.jsx +2 -4
  59. package/args/math/closest.args.jsx +1 -1
  60. package/args/math/largestRect.args.jsx +1 -1
  61. package/args/math/lineIntersection.args.jsx +4 -4
  62. package/args/math/pointDistance.args.jsx +2 -2
  63. package/args/math/pointDistanceSquared.args.jsx +2 -2
  64. package/args/math/pointRotate.args.jsx +2 -2
  65. package/args/math/polygonInside.args.jsx +2 -2
  66. package/args/math/polygonRayCast.args.jsx +2 -2
  67. package/args/math/polygonRotate.args.jsx +2 -2
  68. package/args/math/segmentBoxContains.args.jsx +3 -3
  69. package/args/math/segmentsIntersect.args.jsx +4 -4
  70. package/helpers/configify.js +2 -10
  71. package/package.json +6 -6
  72. package/packages/core/charts/Tree.stories.jsx +40 -0
@@ -27,6 +27,7 @@ export const argTypes = assign(
27
27
  type: "text"
28
28
  },
29
29
  defaultValue: "d => d[\"arrow\"]",
30
+ description: "Sets the inner HTML content of the arrow element, which by default is empty.",
30
31
  table: {
31
32
  defaultValue: {
32
33
  detail: "d => d[\"arrow\"]",
@@ -43,6 +44,7 @@ export const argTypes = assign(
43
44
  type: "object"
44
45
  },
45
46
  defaultValue: "{content: , background: inherit, border: inherit, border-width: 0 1px 1px 0, height: 10px, position: absolute, transform: rotate(45deg), width: 10px, z-index: -1}",
47
+ description: "If *value* is specified, sets the arrow styles to the specified values and returns this generator. If *value* is not specified, returns the current arrow styles.",
46
48
  table: {
47
49
  defaultValue: {
48
50
  summary: "{content: , background: inherit, border: inherit, border-width: 0 1px 1px 0, height: 10px, position: absolute, transform: rotate(45deg), width: 10px, z-index: -1}"
@@ -58,6 +60,7 @@ export const argTypes = assign(
58
60
  type: "text"
59
61
  },
60
62
  defaultValue: "colorDefaults.light",
63
+ description: "If *value* is specified, sets the background accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current background accessor.",
61
64
  table: {
62
65
  defaultValue: {
63
66
  summary: "colorDefaults.light"
@@ -73,6 +76,7 @@ export const argTypes = assign(
73
76
  type: "text"
74
77
  },
75
78
  defaultValue: "d => d[\"body\"]",
79
+ description: "If *value* is specified, sets the body accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current body accessor.",
76
80
  table: {
77
81
  defaultValue: {
78
82
  detail: "d => d[\"body\"]",
@@ -89,6 +93,7 @@ export const argTypes = assign(
89
93
  type: "object"
90
94
  },
91
95
  defaultValue: "{font-size: 12px, font-weight: 400, z-index: 1}",
96
+ description: "If *value* is specified, sets the body styles to the specified values and returns this generator. If *value* is not specified, returns the current body styles.",
92
97
  table: {
93
98
  defaultValue: {
94
99
  summary: "{font-size: 12px, font-weight: 400, z-index: 1}"
@@ -104,6 +109,7 @@ export const argTypes = assign(
104
109
  type: "text"
105
110
  },
106
111
  defaultValue: "1px solid rgba(0, 0, 0, 0.25)",
112
+ description: "If *value* is specified, sets the border accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current border accessor.",
107
113
  table: {
108
114
  defaultValue: {
109
115
  summary: "1px solid rgba(0, 0, 0, 0.25)"
@@ -119,6 +125,7 @@ export const argTypes = assign(
119
125
  type: "text"
120
126
  },
121
127
  defaultValue: "4px",
128
+ description: "If *value* is specified, sets the border-radius accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current border-radius accessor.",
122
129
  table: {
123
130
  defaultValue: {
124
131
  summary: "4px"
@@ -134,6 +141,7 @@ export const argTypes = assign(
134
141
  type: "text"
135
142
  },
136
143
  defaultValue: "d3plus-tooltip",
144
+ description: "If *value* is specified, sets the class name to the specified string and returns this generator. If *value* is not specified, returns the current class name.",
137
145
  table: {
138
146
  defaultValue: {
139
147
  summary: "d3plus-tooltip"
@@ -146,12 +154,13 @@ export const argTypes = assign(
146
154
  },
147
155
  data: {
148
156
  control: {
149
- type: "array"
157
+ type: "object"
150
158
  },
151
- defaultValue: "[\n\n]",
159
+ defaultValue: "[ ]",
160
+ description: "If *data* is specified, sets the data array to the specified array and returns this generator. If *data* is not specified, returns the current data array.",
152
161
  table: {
153
162
  defaultValue: {
154
- summary: "[\n\n]"
163
+ summary: "[ ]"
155
164
  }
156
165
  },
157
166
  type: {
@@ -164,6 +173,7 @@ export const argTypes = assign(
164
173
  type: "text"
165
174
  },
166
175
  defaultValue: "d => d[\"footer\"]",
176
+ description: "If *value* is specified, sets the footer accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current footer accessor.",
167
177
  table: {
168
178
  defaultValue: {
169
179
  detail: "d => d[\"footer\"]",
@@ -180,6 +190,7 @@ export const argTypes = assign(
180
190
  type: "object"
181
191
  },
182
192
  defaultValue: "{font-size: 9px, font-weight: 400, margin-top: 5px, z-index: 1}",
193
+ description: "If *value* is specified, sets the footer styles to the specified values and returns this generator. If *value* is not specified, returns the current footer styles.",
183
194
  table: {
184
195
  defaultValue: {
185
196
  summary: "{font-size: 9px, font-weight: 400, margin-top: 5px, z-index: 1}"
@@ -195,6 +206,7 @@ export const argTypes = assign(
195
206
  type: "text"
196
207
  },
197
208
  defaultValue: "auto",
209
+ description: "If *value* is specified, sets the height accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current height accessor.",
198
210
  table: {
199
211
  defaultValue: {
200
212
  summary: "auto"
@@ -210,6 +222,7 @@ export const argTypes = assign(
210
222
  type: "text"
211
223
  },
212
224
  defaultValue: "(d, i) => `${i}`",
225
+ description: "If *value* is specified, sets the id accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current id accessor.",
213
226
  table: {
214
227
  defaultValue: {
215
228
  detail: "(d, i) => `${i}`",
@@ -226,6 +239,7 @@ export const argTypes = assign(
226
239
  type: "number"
227
240
  },
228
241
  defaultValue: 5,
242
+ description: "If *value* is specified, sets the offset accessor to the specified function or number and returns this generator. If *value* is not specified, returns the current offset accessor.",
229
243
  table: {
230
244
  defaultValue: {
231
245
  summary: 5
@@ -241,6 +255,7 @@ export const argTypes = assign(
241
255
  type: "text"
242
256
  },
243
257
  defaultValue: "10px",
258
+ description: "If *value* is specified, sets the padding accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current padding accessor.",
244
259
  table: {
245
260
  defaultValue: {
246
261
  summary: "10px"
@@ -256,6 +271,7 @@ export const argTypes = assign(
256
271
  type: "text"
257
272
  },
258
273
  defaultValue: "auto",
274
+ description: "If *value* is specified, sets the pointer-events accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current pointer-events accessor.",
259
275
  table: {
260
276
  defaultValue: {
261
277
  summary: "auto"
@@ -268,12 +284,13 @@ export const argTypes = assign(
268
284
  },
269
285
  position: {
270
286
  control: {
271
- type: "array"
287
+ type: "object"
272
288
  },
273
- defaultValue: "(d) => [\nd.x,\nd.y\n]",
289
+ defaultValue: "(d) => [\n d.x,\nd.y\n]",
290
+ description: "If *value* is specified, sets the position accessor to the specified function or array and returns this generator. If *value* is not specified, returns the current position accessor. If *value* is an HTMLElement, anchors the Tooltip to that HTMLElement. If *value* is a selection string, anchors the Tooltip to the HTMLElement selected by that string. Otherwise, coordinate points must be in reference to the client viewport, not the overall page.",
274
291
  table: {
275
292
  defaultValue: {
276
- detail: "(d) => [\nd.x,\nd.y\n]",
293
+ detail: "(d) => [\n d.x,\nd.y\n]",
277
294
  summary: "function"
278
295
  }
279
296
  },
@@ -287,6 +304,7 @@ export const argTypes = assign(
287
304
  type: "object"
288
305
  },
289
306
  defaultValue: "{border-collapse: collapse, border-spacing: 0, width: 100%}",
307
+ description: "If *value* is specified, sets the table styles to the specified values and returns this generator. If *value* is not specified, returns the current table styles.",
290
308
  table: {
291
309
  defaultValue: {
292
310
  summary: "{border-collapse: collapse, border-spacing: 0, width: 100%}"
@@ -299,12 +317,13 @@ export const argTypes = assign(
299
317
  },
300
318
  tbody: {
301
319
  control: {
302
- type: "array"
320
+ type: "object"
303
321
  },
304
- defaultValue: "[\n\n]",
322
+ defaultValue: "[ ]",
323
+ description: "If *value* is specified, sets the contents of the table body to the specified array of functions or strings and returns this generator. If *value* is not specified, returns the current table body data.",
305
324
  table: {
306
325
  defaultValue: {
307
- summary: "[\n\n]"
326
+ summary: "[ ]"
308
327
  }
309
328
  },
310
329
  type: {
@@ -317,6 +336,7 @@ export const argTypes = assign(
317
336
  type: "object"
318
337
  },
319
338
  defaultValue: "{font-size: 12px, text-align: center}",
339
+ description: "If *value* is specified, sets the table body styles to the specified values and returns this generator. If *value* is not specified, returns the current table body styles.",
320
340
  table: {
321
341
  defaultValue: {
322
342
  summary: "{font-size: 12px, text-align: center}"
@@ -332,6 +352,7 @@ export const argTypes = assign(
332
352
  type: "object"
333
353
  },
334
354
  defaultValue: "{}",
355
+ description: "An object with CSS keys and values to be applied to all <td> elements inside of each <tr>.",
335
356
  table: {
336
357
  defaultValue: {
337
358
  summary: "{}"
@@ -344,12 +365,13 @@ export const argTypes = assign(
344
365
  },
345
366
  thead: {
346
367
  control: {
347
- type: "array"
368
+ type: "object"
348
369
  },
349
- defaultValue: "[\n\n]",
370
+ defaultValue: "[ ]",
371
+ description: "If *value* is specified, sets the contents of the table head to the specified array of functions or strings and returns this generator. If *value* is not specified, returns the current table head data.",
350
372
  table: {
351
373
  defaultValue: {
352
- summary: "[\n\n]"
374
+ summary: "[ ]"
353
375
  }
354
376
  },
355
377
  type: {
@@ -362,6 +384,7 @@ export const argTypes = assign(
362
384
  type: "object"
363
385
  },
364
386
  defaultValue: "{font-size: 12px, font-weight: 600, text-align: center}",
387
+ description: "If *value* is specified, sets the table head styles to the specified values and returns this generator. If *value* is not specified, returns the current table head styles.",
365
388
  table: {
366
389
  defaultValue: {
367
390
  summary: "{font-size: 12px, font-weight: 600, text-align: center}"
@@ -377,6 +400,7 @@ export const argTypes = assign(
377
400
  type: "text"
378
401
  },
379
402
  defaultValue: "d => d[\"title\"]",
403
+ description: "If *value* is specified, sets the title accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current title accessor.",
380
404
  table: {
381
405
  defaultValue: {
382
406
  detail: "d => d[\"title\"]",
@@ -393,6 +417,7 @@ export const argTypes = assign(
393
417
  type: "object"
394
418
  },
395
419
  defaultValue: "{font-size: 14px, font-weight: 600, margin-bottom: 5px}",
420
+ description: "If *value* is specified, sets the title styles to the specified values and returns this generator. If *value* is not specified, returns the current title styles.",
396
421
  table: {
397
422
  defaultValue: {
398
423
  summary: "{font-size: 14px, font-weight: 600, margin-bottom: 5px}"
@@ -408,6 +433,7 @@ export const argTypes = assign(
408
433
  type: "object"
409
434
  },
410
435
  defaultValue: "{box-shadow: 0 1px 5px rgba(0, 0, 0, 0.25), color: colorDefaults.dark, font-family: fontFamilyStringify(fontFamily)}",
436
+ description: "If *value* is specified, sets the overall tooltip styles to the specified values and returns this generator. If *value* is not specified, returns the current title styles.",
411
437
  table: {
412
438
  defaultValue: {
413
439
  summary: "{box-shadow: 0 1px 5px rgba(0, 0, 0, 0.25), color: colorDefaults.dark, font-family: fontFamilyStringify(fontFamily)}"
@@ -423,6 +449,7 @@ export const argTypes = assign(
423
449
  type: "object"
424
450
  },
425
451
  defaultValue: "{border-top: (d, i) => i ? 1px solid rgba(0, 0, 0, 0.1) : none}",
452
+ description: "An object with CSS keys and values to be applied to all <tr> elements inside of each <tbody>.",
426
453
  table: {
427
454
  defaultValue: {
428
455
  detail: "{border-top: (d, i) => i ? 1px solid rgba(0, 0, 0, 0.1) : none}",
@@ -439,6 +466,7 @@ export const argTypes = assign(
439
466
  type: "text"
440
467
  },
441
468
  defaultValue: "150px",
469
+ description: "If *value* is specified, sets the width accessor to the specified function or string and returns this generator. If *value* is not specified, returns the current width accessor.",
442
470
  table: {
443
471
  defaultValue: {
444
472
  summary: "150px"
@@ -27,6 +27,7 @@ export const argTypes = assign(
27
27
  type: "text"
28
28
  },
29
29
  defaultValue: "linear",
30
+ description: "If *value* is specified, sets the area curve to the specified string and returns the current class instance. If *value* is not specified, returns the current area curve.",
30
31
  table: {
31
32
  defaultValue: {
32
33
  summary: "linear"
@@ -40,6 +41,7 @@ export const argTypes = assign(
40
41
  defined: {
41
42
  control: {},
42
43
  defaultValue: "() => true",
44
+ description: "If *value* is specified, sets the defined accessor to the specified function and returns the current class instance. If *value* is not specified, returns the current defined accessor.",
43
45
  table: {
44
46
  defaultValue: {
45
47
  detail: "() => true",
@@ -54,7 +56,7 @@ export const argTypes = assign(
54
56
  labelBounds: {
55
57
  control: {},
56
58
  defaultValue: "(d, i, aes) => {\n const r = largestRect(aes.points);\n if (!r) return null;\n return {\n angle: r.angle,\n width: r.width,\n height: r.height,\n x: r.cx - r.width / 2 - this._x(d, i),\n y: r.cy - r.height / 2 - this._y(d, i)\n };\n}",
57
- description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`. If an array is returned from the function, each value will be used in conjunction with each label.",
59
+ description: "If *bounds* is specified, sets the label bounds to the specified function and returns the current class instance. If *bounds* is not specified, returns the current inner bounds accessor.",
58
60
  table: {
59
61
  defaultValue: {
60
62
  detail: "(d, i, aes) => {\n const r = largestRect(aes.points);\n if (!r) return null;\n return {\n angle: r.angle,\n width: r.width,\n height: r.height,\n x: r.cx - r.width / 2 - this._x(d, i),\n y: r.cy - r.height / 2 - this._y(d, i)\n };\n}",
@@ -71,6 +73,7 @@ export const argTypes = assign(
71
73
  type: "object"
72
74
  },
73
75
  defaultValue: "Object.assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})",
76
+ description: "A pass-through to the config method of the TextBox class used to create a shape's labels.",
74
77
  table: {
75
78
  defaultValue: {
76
79
  summary: "Object.assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})"
@@ -83,6 +86,7 @@ export const argTypes = assign(
83
86
  },
84
87
  render: {
85
88
  control: {},
89
+ description: "Draws the area polygons.",
86
90
  table: {
87
91
  defaultValue: {
88
92
  summary: "undefined"
@@ -98,6 +102,7 @@ export const argTypes = assign(
98
102
  type: "number"
99
103
  },
100
104
  defaultValue: "d => d[\"x\"]",
105
+ description: "If *value* is specified, sets the x accessor to the specified function or number and returns the current class instance.",
101
106
  table: {
102
107
  defaultValue: {
103
108
  detail: "d => d[\"x\"]",
@@ -114,6 +119,7 @@ export const argTypes = assign(
114
119
  type: "number"
115
120
  },
116
121
  defaultValue: "d => d[\"x\"]",
122
+ description: "If *value* is specified, sets the x0 accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current x0 accessor.",
117
123
  table: {
118
124
  defaultValue: {
119
125
  detail: "d => d[\"x\"]",
@@ -130,6 +136,7 @@ export const argTypes = assign(
130
136
  type: "number"
131
137
  },
132
138
  defaultValue: "null",
139
+ description: "If *value* is specified, sets the x1 accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current x1 accessor.",
133
140
  table: {
134
141
  defaultValue: {
135
142
  summary: "null"
@@ -145,6 +152,7 @@ export const argTypes = assign(
145
152
  type: "number"
146
153
  },
147
154
  defaultValue: 0,
155
+ description: "If *value* is specified, sets the y accessor to the specified function or number and returns the current class instance.",
148
156
  table: {
149
157
  defaultValue: {
150
158
  summary: 0
@@ -160,6 +168,7 @@ export const argTypes = assign(
160
168
  type: "number"
161
169
  },
162
170
  defaultValue: 0,
171
+ description: "If *value* is specified, sets the y0 accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current y0 accessor.",
163
172
  table: {
164
173
  defaultValue: {
165
174
  summary: 0
@@ -175,6 +184,7 @@ export const argTypes = assign(
175
184
  type: "number"
176
185
  },
177
186
  defaultValue: "d => d[\"y\"]",
187
+ description: "If *value* is specified, sets the y1 accessor to the specified function or number and returns the current class instance. If *value* is not specified, returns the current y1 accessor.",
178
188
  table: {
179
189
  defaultValue: {
180
190
  detail: "d => d[\"y\"]",
@@ -27,6 +27,7 @@ export const argTypes = assign(
27
27
  type: "number"
28
28
  },
29
29
  defaultValue: 10,
30
+ description: "If *value* is specified, sets the height accessor to the specified function or number and returns the current class instance.",
30
31
  table: {
31
32
  defaultValue: {
32
33
  summary: 10
@@ -40,7 +41,7 @@ export const argTypes = assign(
40
41
  labelBounds: {
41
42
  control: {},
42
43
  defaultValue: "(d, i, s) => ({width: s.width, height: s.height, x: this._x1 !== null ? this._getX(d, i) : -s.width / 2, y: this._x1 === null ? this._getY(d, i) : -s.height / 2})",
43
- description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`. If an array is returned from the function, each value will be used in conjunction with each label.",
44
+ description: "If *bounds* is specified, sets the label bounds to the specified function and returns the current class instance. If *bounds* is not specified, returns the current inner bounds accessor.",
44
45
  table: {
45
46
  defaultValue: {
46
47
  detail: "(d, i, s) => ({width: s.width, height: s.height, x: this._x1 !== null ? this._getX(d, i) : -s.width / 2, y: this._x1 === null ? this._getY(d, i) : -s.height / 2})",
@@ -54,6 +55,7 @@ export const argTypes = assign(
54
55
  },
55
56
  render: {
56
57
  control: {},
58
+ description: "Draws the bars.",
57
59
  table: {
58
60
  defaultValue: {
59
61
  summary: "undefined"
@@ -69,6 +71,7 @@ export const argTypes = assign(
69
71
  type: "number"
70
72
  },
71
73
  defaultValue: 10,
74
+ description: "If *value* is specified, sets the width accessor to the specified function or number and returns the current class instance.",
72
75
  table: {
73
76
  defaultValue: {
74
77
  summary: 10
@@ -84,6 +87,7 @@ export const argTypes = assign(
84
87
  type: "number"
85
88
  },
86
89
  defaultValue: "d => d[\"x\"]",
90
+ description: "If *value* is specified, sets the x accessor to the specified function or number and returns the current class instance.",
87
91
  table: {
88
92
  defaultValue: {
89
93
  detail: "d => d[\"x\"]",
@@ -100,6 +104,7 @@ export const argTypes = assign(
100
104
  type: "number"
101
105
  },
102
106
  defaultValue: "d => d[\"x\"]",
107
+ description: "If *value* is specified, sets the x0 accessor to the specified function or number and returns the current class instance.",
103
108
  table: {
104
109
  defaultValue: {
105
110
  detail: "d => d[\"x\"]",
@@ -116,6 +121,7 @@ export const argTypes = assign(
116
121
  type: "number"
117
122
  },
118
123
  defaultValue: "null",
124
+ description: "If *value* is specified, sets the x1 accessor to the specified function or number and returns the current class instance.",
119
125
  table: {
120
126
  defaultValue: {
121
127
  summary: "null"
@@ -131,6 +137,7 @@ export const argTypes = assign(
131
137
  type: "number"
132
138
  },
133
139
  defaultValue: 0,
140
+ description: "If *value* is specified, sets the y accessor to the specified function or number and returns the current class instance.",
134
141
  table: {
135
142
  defaultValue: {
136
143
  summary: 0
@@ -146,6 +153,7 @@ export const argTypes = assign(
146
153
  type: "number"
147
154
  },
148
155
  defaultValue: 0,
156
+ description: "If *value* is specified, sets the y0 accessor to the specified function or number and returns the current class instance.",
149
157
  table: {
150
158
  defaultValue: {
151
159
  summary: 0
@@ -161,6 +169,7 @@ export const argTypes = assign(
161
169
  type: "number"
162
170
  },
163
171
  defaultValue: "d => d[\"y\"]",
172
+ description: "If *value* is specified, sets the y1 accessor to the specified function or number and returns the current class instance.",
164
173
  table: {
165
174
  defaultValue: {
166
175
  detail: "d => d[\"y\"]",
@@ -24,6 +24,7 @@ export const argTypes = assign(
24
24
  {
25
25
  active: {
26
26
  control: {},
27
+ description: "Sets the highlight accessor to the Shape class's active function.",
27
28
  table: {
28
29
  defaultValue: {
29
30
  summary: "undefined"
@@ -36,9 +37,10 @@ export const argTypes = assign(
36
37
  },
37
38
  data: {
38
39
  control: {
39
- type: "array"
40
+ type: "object"
40
41
  },
41
42
  defaultValue: "[]",
43
+ description: "If *data* is specified, sets the data array to the specified array and returns the current class instance. If *data* is not specified, returns the current data array.",
42
44
  table: {
43
45
  defaultValue: {
44
46
  summary: "[]"
@@ -51,6 +53,7 @@ export const argTypes = assign(
51
53
  },
52
54
  hover: {
53
55
  control: {},
56
+ description: "Sets the highlight accessor to the Shape class's hover function.",
54
57
  table: {
55
58
  defaultValue: {
56
59
  summary: "undefined"
@@ -66,6 +69,7 @@ export const argTypes = assign(
66
69
  type: "object"
67
70
  },
68
71
  defaultValue: "{fill: black}",
72
+ description: "If *value* is specified, sets the config method for median and returns the current class instance.",
69
73
  table: {
70
74
  defaultValue: {
71
75
  summary: "{fill: black}"
@@ -81,7 +85,7 @@ export const argTypes = assign(
81
85
  type: "text"
82
86
  },
83
87
  defaultValue: "d => d[\"orient\"] || vertical",
84
- description: "Accepts \"vertical\" or \"horizontal\"",
88
+ description: "If *value* is specified, sets the orientation to the specified value. If *value* is not specified, returns the current orientation.",
85
89
  table: {
86
90
  defaultValue: {
87
91
  detail: "d => d[\"orient\"] || vertical",
@@ -98,6 +102,7 @@ export const argTypes = assign(
98
102
  type: "text"
99
103
  },
100
104
  defaultValue: "d => d[\"outlier\"] || Circle",
105
+ description: "If *value* is specified, sets the outlier accessor to the specified function or string and returns the current class instance.",
101
106
  table: {
102
107
  defaultValue: {
103
108
  detail: "d => d[\"outlier\"] || Circle",
@@ -114,6 +119,7 @@ export const argTypes = assign(
114
119
  type: "object"
115
120
  },
116
121
  defaultValue: "{Circle: {r: d => d[\"r\"] || 5}, Rect: {height: (d, i) => this._orient(d, i) === vertical ? 5 : 20, width: (d, i) => this._orient(d, i) === vertical ? 20 : 5}}",
122
+ description: "If *value* is specified, sets the config method for each outlier point and returns the current class instance.",
117
123
  table: {
118
124
  defaultValue: {
119
125
  detail: "{Circle: {r: d => d[\"r\"] || 5}, Rect: {height: (d, i) => this._orient(d, i) === vertical ? 5 : 20, width: (d, i) => this._orient(d, i) === vertical ? 20 : 5}}",
@@ -130,6 +136,7 @@ export const argTypes = assign(
130
136
  type: "object"
131
137
  },
132
138
  defaultValue: "{fill: white, stroke: black, strokeWidth: 1}",
139
+ description: "If *value* is specified, sets the config method for rect shape and returns the current class instance.",
133
140
  table: {
134
141
  defaultValue: {
135
142
  summary: "{fill: white, stroke: black, strokeWidth: 1}"
@@ -145,6 +152,7 @@ export const argTypes = assign(
145
152
  type: "number"
146
153
  },
147
154
  defaultValue: 50,
155
+ description: "If *value* is specified, sets the width accessor to the specified function or number and returns the current class instance.",
148
156
  table: {
149
157
  defaultValue: {
150
158
  summary: 50
@@ -157,6 +165,7 @@ export const argTypes = assign(
157
165
  },
158
166
  render: {
159
167
  control: {},
168
+ description: "Draws the Box.",
160
169
  table: {
161
170
  defaultValue: {
162
171
  summary: "undefined"
@@ -172,6 +181,7 @@ export const argTypes = assign(
172
181
  type: "text"
173
182
  },
174
183
  defaultValue: "d3.select(\"body\").append(\"svg\")",
184
+ description: "If *selector* is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If *selector* is not specified, returns the current SVG container element.",
175
185
  table: {
176
186
  defaultValue: {
177
187
  summary: "d3.select(\"body\").append(\"svg\")"
@@ -187,6 +197,7 @@ export const argTypes = assign(
187
197
  type: "object"
188
198
  },
189
199
  defaultValue: "{}",
200
+ description: "If *value* is specified, sets the config method for whisker and returns the current class instance.",
190
201
  table: {
191
202
  defaultValue: {
192
203
  summary: "{}"
@@ -199,12 +210,13 @@ export const argTypes = assign(
199
210
  },
200
211
  whiskerMode: {
201
212
  control: {
202
- type: "text"
213
+ type: "number"
203
214
  },
204
- defaultValue: "[\ntukey,\ntukey\n]",
215
+ defaultValue: "[\n tukey,\ntukey\n]",
216
+ description: "Determines the value used for each whisker. Can be passed a single value to apply for both whiskers, or an Array of 2 values for the lower and upper whiskers (in that order). Accepted values are `\"tukey\"`, `\"extent\"`, or a Number representing a quantile.",
205
217
  table: {
206
218
  defaultValue: {
207
- summary: "[\ntukey,\ntukey\n]"
219
+ summary: "[\n tukey,\ntukey\n]"
208
220
  }
209
221
  },
210
222
  type: {
@@ -217,6 +229,7 @@ export const argTypes = assign(
217
229
  type: "number"
218
230
  },
219
231
  defaultValue: "d => d[\"x\"] || 250",
232
+ description: "If *value* is specified, sets the x axis to the specified function or number and returns the current class instance.",
220
233
  table: {
221
234
  defaultValue: {
222
235
  detail: "d => d[\"x\"] || 250",
@@ -233,6 +246,7 @@ export const argTypes = assign(
233
246
  type: "number"
234
247
  },
235
248
  defaultValue: "d => d[\"y\"] || 250",
249
+ description: "If *value* is specified, sets the y axis to the specified function or number and returns the current class instance.",
236
250
  table: {
237
251
  defaultValue: {
238
252
  detail: "d => d[\"y\"] || 250",
@@ -25,7 +25,7 @@ export const argTypes = assign(
25
25
  labelBounds: {
26
26
  control: {},
27
27
  defaultValue: "(d, i, s) => ({width: s.r * 1.5, height: s.r * 1.5, x: -s.r * 0.75, y: -s.r * 0.75})",
28
- description: "The given function is passed the data point, index, and internally defined properties of the shape and should return an object containing the following values: `width`, `height`, `x`, `y`. If an array is returned from the function, each value will be used in conjunction with each label.",
28
+ description: "If *bounds* is specified, sets the label bounds to the specified function and returns the current class instance. If *bounds* is not specified, returns the current inner bounds accessor.",
29
29
  table: {
30
30
  defaultValue: {
31
31
  detail: "(d, i, s) => ({width: s.r * 1.5, height: s.r * 1.5, x: -s.r * 0.75, y: -s.r * 0.75})",
@@ -42,6 +42,7 @@ export const argTypes = assign(
42
42
  type: "object"
43
43
  },
44
44
  defaultValue: "assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})",
45
+ description: "A pass-through to the config method of the TextBox class used to create a shape's labels.",
45
46
  table: {
46
47
  defaultValue: {
47
48
  summary: "assign(this._labelConfig, {textAnchor: middle, verticalAlign: middle})"
@@ -57,6 +58,7 @@ export const argTypes = assign(
57
58
  type: "number"
58
59
  },
59
60
  defaultValue: "d => d[\"r\"]",
61
+ description: "If *value* is specified, sets the radius accessor to the specified function or number and returns the current class instance.",
60
62
  table: {
61
63
  defaultValue: {
62
64
  detail: "d => d[\"r\"]",
@@ -70,6 +72,7 @@ export const argTypes = assign(
70
72
  },
71
73
  render: {
72
74
  control: {},
75
+ description: "Draws the circles.",
73
76
  table: {
74
77
  defaultValue: {
75
78
  summary: "undefined"