victory-voronoi 30.6.1 → 31.2.0
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.
- package/README.md +22 -24
- package/dist/victory-voronoi.js +1417 -1167
- package/dist/victory-voronoi.min.js +1 -1
- package/es/helper-methods.js +2 -1
- package/es/victory-voronoi.js +8 -2
- package/lib/helper-methods.js +3 -1
- package/lib/victory-voronoi.js +8 -2
- package/package.json +2 -2
- package/src/helper-methods.js +54 -15
- package/src/victory-voronoi.js +32 -12
- package/src/voronoi.js +39 -14
package/README.md
CHANGED
|
@@ -92,7 +92,7 @@ See the [Data Accessors Guide][] for more detail on formatting and processing da
|
|
|
92
92
|
|
|
93
93
|
See the [Custom Components Guide][] for more detail on creating your own `dataComponents`
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
_default:_ `<Voronoi/>`
|
|
96
96
|
|
|
97
97
|
```jsx
|
|
98
98
|
dataComponent={<Voronoi events={{ onClick: handleClick }}/>}
|
|
@@ -125,7 +125,7 @@ domainPadding={{x: [10, -10], y: 5}}
|
|
|
125
125
|
`VictoryVoronoi` uses the standard `eventKey` prop to specify how event targets are addressed. **This prop is not commonly used.** [Read about the `eventKey` prop in more detail here](https://formidable.com/open-source/victory/docs/common-props#eventkey)
|
|
126
126
|
|
|
127
127
|
```jsx
|
|
128
|
-
eventKey="x"
|
|
128
|
+
eventKey = "x";
|
|
129
129
|
```
|
|
130
130
|
|
|
131
131
|
### events
|
|
@@ -172,7 +172,7 @@ See the [Events Guide][] for more information on defining events.
|
|
|
172
172
|
|
|
173
173
|
`VictoryVoronoi` uses the standard `groupComponent` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#groupcomponent)
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
_default:_ `<g/>`
|
|
176
176
|
|
|
177
177
|
```jsx
|
|
178
178
|
groupComponent={<g transform="translate(10, 10)" />}
|
|
@@ -184,7 +184,7 @@ groupComponent={<g transform="translate(10, 10)" />}
|
|
|
184
184
|
|
|
185
185
|
`VictoryVoronoi` uses the standard `height` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#height)
|
|
186
186
|
|
|
187
|
-
|
|
187
|
+
_default (provided by default theme):_ `height={300}`
|
|
188
188
|
|
|
189
189
|
```jsx
|
|
190
190
|
height={400}
|
|
@@ -196,7 +196,7 @@ height={400}
|
|
|
196
196
|
|
|
197
197
|
`VictoryVoronoi` uses the standard `labelComponent` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#labelcomponent)
|
|
198
198
|
|
|
199
|
-
|
|
199
|
+
_default:_ `<VictoryLabel/>`
|
|
200
200
|
|
|
201
201
|
```playground
|
|
202
202
|
<VictoryVoronoi
|
|
@@ -233,7 +233,6 @@ height={400}
|
|
|
233
233
|
|
|
234
234
|
`VictoryVoronoi` uses the standard `maxDomain` prop. [Read about it in detail](https://formidable.com/open-source/victory/docs/common-props#maxDomain)
|
|
235
235
|
|
|
236
|
-
|
|
237
236
|
### minDomain
|
|
238
237
|
|
|
239
238
|
`type: number || { x: number, y: number }`
|
|
@@ -247,7 +246,7 @@ height={400}
|
|
|
247
246
|
The `name` prop is used to reference a component instance when defining shared events.
|
|
248
247
|
|
|
249
248
|
```jsx
|
|
250
|
-
name="series-1"
|
|
249
|
+
name = "series-1";
|
|
251
250
|
```
|
|
252
251
|
|
|
253
252
|
### origin
|
|
@@ -264,7 +263,7 @@ name="series-1"
|
|
|
264
263
|
|
|
265
264
|
`VictoryVoronoi` uses the standard `padding` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#padding)
|
|
266
265
|
|
|
267
|
-
|
|
266
|
+
_default (provided by default theme):_ `padding={50}`
|
|
268
267
|
|
|
269
268
|
```jsx
|
|
270
269
|
padding={{ top: 20, bottom: 60 }}
|
|
@@ -292,7 +291,7 @@ padding={{ top: 20, bottom: 60 }}
|
|
|
292
291
|
|
|
293
292
|
`VictoryVoronoi` uses the standard `samples` prop to generate data when plotting functions. [Read about it in more detail here](https://formidable.com/open-source/victory/docs/common-props#samples)
|
|
294
293
|
|
|
295
|
-
|
|
294
|
+
_default:_ `samples={50}`
|
|
296
295
|
|
|
297
296
|
```jsx
|
|
298
297
|
samples={100}
|
|
@@ -305,7 +304,7 @@ samples={100}
|
|
|
305
304
|
`VictoryVoronoi` uses the standard `scale` prop. [Read about it here](https://formidable.com/open-source/victory/docs/common-props#scale)
|
|
306
305
|
Options for scale include "linear", "time", "log", "sqrt" and the `d3-scale` functions that correspond to these options.
|
|
307
306
|
|
|
308
|
-
|
|
307
|
+
_default:_ `scale="linear"`
|
|
309
308
|
|
|
310
309
|
```jsx
|
|
311
310
|
scale={{x: "linear", y: "log"}}
|
|
@@ -344,7 +343,7 @@ The size prop determines the maximum size of each voronoi area. When this prop i
|
|
|
344
343
|
`VictoryVoronoi` uses the standard `sortKey` prop to determine how data should be ordered. [Read about it in more detail here](https://formidable.com/open-source/victory/docs/common-props#sortkey)
|
|
345
344
|
|
|
346
345
|
```jsx
|
|
347
|
-
sortKey="x"
|
|
346
|
+
sortKey = "x";
|
|
348
347
|
```
|
|
349
348
|
|
|
350
349
|
### sortOrder
|
|
@@ -353,7 +352,7 @@ sortKey="x"
|
|
|
353
352
|
|
|
354
353
|
The `sortOrder` prop specifies whether sorted data should be returned in ascending or descending order.
|
|
355
354
|
|
|
356
|
-
|
|
355
|
+
_default:_ `sortOrder="ascending"`
|
|
357
356
|
|
|
358
357
|
### standalone
|
|
359
358
|
|
|
@@ -363,7 +362,7 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
|
|
|
363
362
|
|
|
364
363
|
**note:** When `VictoryVoronoi` is nested within a component like `VictoryChart`, this prop will be set to `false`
|
|
365
364
|
|
|
366
|
-
|
|
365
|
+
_default:_ `standalone={true}`
|
|
367
366
|
|
|
368
367
|
```playground
|
|
369
368
|
<svg width={300} height={300}>
|
|
@@ -377,14 +376,13 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
|
|
|
377
376
|
</svg>
|
|
378
377
|
```
|
|
379
378
|
|
|
380
|
-
|
|
381
379
|
### style
|
|
382
380
|
|
|
383
381
|
`type: { parent: object, data: object, labels: object }`
|
|
384
382
|
|
|
385
383
|
`VictoryVoronoi` uses the standard `style` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#style)
|
|
386
384
|
|
|
387
|
-
|
|
385
|
+
_default (provided by default theme):_ See [grayscale theme][] for more detail
|
|
388
386
|
|
|
389
387
|
```playground
|
|
390
388
|
<VictoryVoronoi
|
|
@@ -410,7 +408,7 @@ The `sortOrder` prop specifies whether sorted data should be returned in ascendi
|
|
|
410
408
|
|
|
411
409
|
See the [Themes Guide][] for information about creating custom themes.
|
|
412
410
|
|
|
413
|
-
|
|
411
|
+
_default:_ `theme={VictoryTheme.grayscale}`
|
|
414
412
|
|
|
415
413
|
```jsx
|
|
416
414
|
theme={VictoryTheme.material}
|
|
@@ -422,7 +420,7 @@ theme={VictoryTheme.material}
|
|
|
422
420
|
|
|
423
421
|
`VictoryVoronoi` uses the standard `width` prop. [Read about it in detail here](https://formidable.com/open-source/victory/docs/common-props#width)
|
|
424
422
|
|
|
425
|
-
|
|
423
|
+
_default (provided by default theme):_ `width={450}`
|
|
426
424
|
|
|
427
425
|
```jsx
|
|
428
426
|
width={400}
|
|
@@ -437,7 +435,7 @@ width={400}
|
|
|
437
435
|
See the [Data Accessors Guide][] for more detail on formatting and processing data.
|
|
438
436
|
|
|
439
437
|
```jsx
|
|
440
|
-
x="employee.name"
|
|
438
|
+
x = "employee.name";
|
|
441
439
|
```
|
|
442
440
|
|
|
443
441
|
### y
|
|
@@ -458,10 +456,10 @@ y={(d) => d.value + d.error}
|
|
|
458
456
|
|
|
459
457
|
**It is not common to set a `y0` prop with `VictoryVoronoi`, as baselines for `VictoryVoronoi` are only relevant for stacked charts.** [Read more about the `y0` prop here](https://formidable.com/open-source/victory/docs/common-props#y0)
|
|
460
458
|
|
|
461
|
-
[
|
|
462
|
-
[
|
|
463
|
-
[
|
|
464
|
-
[
|
|
465
|
-
[
|
|
466
|
-
[`
|
|
459
|
+
[animations guide]: https://formidable.com/open-source/victory/guides/animations
|
|
460
|
+
[data accessors guide]: https://formidable.com/open-source/victory/guides/data-accessors
|
|
461
|
+
[custom components guide]: https://formidable.com/open-source/victory/guides/custom-components
|
|
462
|
+
[events guide]: https://formidable.com/open-source/victory/guides/events
|
|
463
|
+
[themes guide]: https://formidable.com/open-source/victory/guides/themes
|
|
464
|
+
[`victorychart`]: https://formidable.com/open-source/victory/docs/victory-chart
|
|
467
465
|
[grayscale theme]: https://github.com/FormidableLabs/victory-core/blob/master/src/victory-theme/grayscale.js
|