@jrkasprzyk/parcoord-es 3.0.0 → 3.0.1
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 -14
- package/dist/parcoords.esm.js +1 -1
- package/dist/parcoords.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @jrkasprzyk/parcoord-es
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@jrkasprzyk/parcoord-es)
|
|
4
|
+
|
|
5
|
+
A maintained fork of [BigFatDog/parcoords-es](https://github.com/BigFatDog/parcoords-es), an ES6 module of Syntagmatic's [Parallel Coordinates](https://github.com/syntagmatic/parallel-coordinates) (aka. parcoords). This library is completely based on the D3 V7 API.
|
|
6
|
+
|
|
7
|
+
## About this fork
|
|
8
|
+
|
|
9
|
+
The upstream `parcoord-es` package is built on D3 V5 and is no longer actively maintained. This fork:
|
|
10
|
+
|
|
11
|
+
* Migrates the library to **D3 V7** modules
|
|
12
|
+
* Updates the build toolchain (Rollup 4, Babel 7, ESLint 8, Mocha 11) and resolves all known dependency vulnerabilities
|
|
13
|
+
* Is published to npm as [`@jrkasprzyk/parcoord-es`](https://www.npmjs.com/package/@jrkasprzyk/parcoord-es)
|
|
4
14
|
|
|
5
15
|
|
|
6
16
|
## Features
|
|
@@ -20,13 +30,13 @@ This section only lists api that are <b>deviated</b> from the original parallel
|
|
|
20
30
|
|
|
21
31
|
<a name="parcoords_brush_extents" href="#parcoords_brush_extents">#</a> parcoords.<b>brushExtents</b>(extents) supports 1D multi brushes:
|
|
22
32
|
|
|
23
|
-
1D brush [<>](https://github.com/
|
|
33
|
+
1D brush [<>](https://github.com/jrkasprzyk/parcoords-es/blob/master/demo/setterForBrushes.html "Source")
|
|
24
34
|
```javascript
|
|
25
35
|
.brushMode("1D-axes")
|
|
26
36
|
.brushExtents({"2": [3,4]});
|
|
27
37
|
```
|
|
28
38
|
|
|
29
|
-
1D multi brush [<>](https://github.com/
|
|
39
|
+
1D multi brush [<>](https://github.com/jrkasprzyk/parcoords-es/blob/master/demo/setterForMultiBrushes.html "Source")
|
|
30
40
|
```javascript
|
|
31
41
|
.brushMode("1D-axes-multi")
|
|
32
42
|
.brushExtents({"2": [[3,4], [6,8], [10, 14]]});
|
|
@@ -56,7 +66,7 @@ const data = [...];
|
|
|
56
66
|
const pc = ParCoords().data(data)...;
|
|
57
67
|
parcoords.mark(data.filter(d => d.volume > 10));
|
|
58
68
|
```
|
|
59
|
-
Please refer to [marking demo](https://github.com/
|
|
69
|
+
Please refer to [marking demo](https://github.com/jrkasprzyk/parcoords-es/blob/master/demo/marking.html "Source") for details
|
|
60
70
|
|
|
61
71
|
<a name="parcoords_unmark" href="#parcoords_unmark">#</a> parcoords.<b>unmark</b>()
|
|
62
72
|
clears all permanently highlighted data that is added by <a href="#parcoords_marking">mark([values])</a>
|
|
@@ -76,27 +86,27 @@ parcoords.on('brushstart', function(brushed, args){
|
|
|
76
86
|
} = args;
|
|
77
87
|
})
|
|
78
88
|
```
|
|
79
|
-
Please refer to [brushing with arguments demo](https://github.com/
|
|
89
|
+
Please refer to [brushing with arguments demo](https://github.com/jrkasprzyk/parcoords-es/blob/master/demo/brush-with-arguments.html "Source") for details
|
|
80
90
|
|
|
81
91
|
## Usage
|
|
82
92
|
|
|
83
93
|
### ES6
|
|
84
94
|
1. Install library in your project
|
|
85
95
|
```
|
|
86
|
-
npm install parcoord-es --save
|
|
96
|
+
npm install @jrkasprzyk/parcoord-es --save
|
|
87
97
|
```
|
|
88
98
|
|
|
89
99
|
2. import module
|
|
90
100
|
|
|
91
101
|
```
|
|
92
|
-
import 'parcoord-es/dist/parcoords.css';
|
|
93
|
-
import ParCoords from 'parcoord-es';
|
|
102
|
+
import '@jrkasprzyk/parcoord-es/dist/parcoords.css';
|
|
103
|
+
import ParCoords from '@jrkasprzyk/parcoord-es';
|
|
94
104
|
|
|
95
105
|
const chart = ParCoords()....
|
|
96
106
|
```
|
|
97
107
|
### Standalone
|
|
98
108
|
|
|
99
|
-
parcoords.standalone.js contains all dependencies and can be used directly in your html page. Please note that only essential D3
|
|
109
|
+
parcoords.standalone.js contains all dependencies and can be used directly in your html page. Please note that only essential D3 V7 modules are bundled, your global namespace won't be polluted.
|
|
100
110
|
```
|
|
101
111
|
<link rel="stylesheet" type="text/css" href="./parcoords.css">
|
|
102
112
|
<script src="./parcoords.standalone.js"></script>
|
|
@@ -104,8 +114,6 @@ parcoords.standalone.js contains all dependencies and can be used directly in yo
|
|
|
104
114
|
var parcoords = ParCoords()("#example")
|
|
105
115
|
```
|
|
106
116
|
|
|
107
|
-
You are free to use either D3 V3 or D3 V5 in your html. demo/superformula.html demonstrates how to use parcoords-es with d3 V3.
|
|
108
|
-
|
|
109
117
|
## Development
|
|
110
118
|
|
|
111
119
|
Follow this instruction to setup development environment for parcoords-es
|
|
@@ -142,7 +150,7 @@ npm run test:cover
|
|
|
142
150
|
|
|
143
151
|
## Built With
|
|
144
152
|
|
|
145
|
-
* [D3
|
|
153
|
+
* [D3 V7](https://d3js.org/) - D3 modules are used
|
|
146
154
|
* [Rollup](https://github.com/rollup/rollup) - Module bundler
|
|
147
155
|
|
|
148
156
|
|
|
@@ -151,7 +159,7 @@ npm run test:cover
|
|
|
151
159
|
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
|
|
152
160
|
|
|
153
161
|
## Contributors
|
|
154
|
-
This project gets supports from open-source community. Many thanks to
|
|
162
|
+
This project gets supports from open-source community. Many thanks to the [upstream contributors](https://github.com/BigFatDog/parcoords-es/graphs/contributors)
|
|
155
163
|
|
|
156
164
|
## Contribution Notes
|
|
157
165
|
Run `npm run pretty` before committing.
|
package/dist/parcoords.esm.js
CHANGED
package/dist/parcoords.js
CHANGED