d3-svg-annotation
Advanced tools
d3-svg-annotation - npm Package Compare versions
Comparing version 0.0.0 to 1.0.0
| { | ||
| "name": "d3-svg-annotation", | ||
| "version": "0.0.0", | ||
| "version": "1.0.0", | ||
| "description": "", | ||
| "main": "d3-annotation.js", | ||
| "jsnext:main": "d3-annotation.mjs", | ||
| "files": [ | ||
| "lib", | ||
| "index.js", | ||
| "d3-annotation.*" | ||
| ], | ||
| "keywords": [ | ||
| ], | ||
| "directories": { | ||
| }, | ||
| "keywords": [], | ||
| "directories": {}, | ||
| "devDependencies": { | ||
| "babel-plugin-external-helpers": "6.18.0", | ||
| "babel-plugin-transform-object-rest-spread": "6.20.2", | ||
| "babel-preset-es2015": "6.18.0", | ||
| "babelify": "7.3.0", | ||
| "babelrc-rollup": "3.0.0", | ||
| "browserify": "13.1.1", | ||
| "http-server": "0.9.0", | ||
| "marked": "0.3.6", | ||
| "markedify": "0.0.2", | ||
| "npm-watch": "0.1.6", | ||
| "rollup": "0.34.7", | ||
| "rollup-plugin-babel": "2.6.1", | ||
| "uglify-js": "^2.8.1" | ||
| }, | ||
| "scripts": { | ||
| "start": "npm run server & npm run watch", | ||
| "server": "http-server", | ||
| "browserify": "browserify web.js -o d3-annotation.js -t [ babelify --presets [ es2015 ] ]", | ||
| "docs": "node docs/browserify-docs.js && npm run docs-bundle", | ||
| "docs-bundle": "uglifyjs --source-map=docs/bundle.map --source-map-url=bundle.map -- docs/vendor/jquery2.1.1.min.js docs/vendor/materialize.min.js docs/vendor/d3-selection.js docs/vendor/d3-shape.js d3-annotation.js docs/docs-compiled.js > docs/bundle.js", | ||
| "watch": "npm-watch", | ||
| "uglify": "uglifyjs d3-annotation.js -o d3-annotation.min.js -c -m", | ||
| "prepublish": "npm run uglify" | ||
| }, | ||
| "watch": { | ||
| "browserify": [ | ||
| "src/*.js", | ||
| "src/**/*.js" | ||
| ], | ||
| "docs": { | ||
| "patterns": [ | ||
| "docs/docs.js", | ||
| "d3-annotation.js", | ||
| "docs/content/*.md" | ||
| ], | ||
| "extensions": "js,md" | ||
| } | ||
| }, | ||
| "repository": { | ||
@@ -21,4 +57,3 @@ "type": "git", | ||
| }, | ||
| "license": "ISC", | ||
| "license": "Apache-2.0", | ||
| "bugs": { | ||
@@ -28,3 +63,8 @@ "url": "https://github.com/susielu/d3-annotation/issues" | ||
| "dependencies": { | ||
| "d3-dispatch": "1.0.2", | ||
| "d3-drag": "1.0.2", | ||
| "d3-selection": "1.0.2", | ||
| "d3-shape": "1.0.4", | ||
| "d3-transition": "1.0.3" | ||
| } | ||
| } |
| # d3-annotation | ||
| Full documentation: [http://d3-annotation.susielu.com](http://d3-annotation.susielu.com) | ||
| ## Setup | ||
| ### Include the file directly | ||
| You must include the [d3 library](http://d3js.org/) before including the annotation file. Then you can add the compiled js file to your website | ||
| - [Unminified](https://github.com/susielu/d3-annotation/blob/master/d3-annotation.js) | ||
| - [Minified](https://github.com/susielu/d3-annotation/blob/master/d3-annotation.min.js) | ||
| ### Using NPM | ||
| You can add d3-annotation as a node module by running | ||
| ```bash | ||
| npm i d3-svg-annotation -S | ||
| ``` | ||
| ## Feedback | ||
| I would love to hear from you about any additional features that would be useful, please say hi on twitter [@DataToViz](https://www.twitter.com/DataToViz). | ||
| ## Prior art | ||
| - [Andrew Mollica](https://bl.ocks.org/armollica/67f3cf7bf08a02d95d48dc9f0c91f26c), [d3-ring-note](https://github.com/armollica/d3-ring-note) D3 plugin for placing circle and text annotation, and [HTML Annotation](http://bl.ocks.org/armollica/78894d0b3cbd46d8d8d19d135c6ca34d) | ||
| - [Scatterplot with d3-annotate](https://bl.ocks.org/cmpolis/f9805a98b8a455aaccb56e5ee59964f8), by Chris Polis, example using [d3-annotate](https://github.com/cmpolis/d3-annotate) | ||
| - [Rickshaw](http://code.shutterstock.com/rickshaw/) has an annotation tool | ||
| - [Benn Stancil](https://modeanalytics.com/benn/reports/21ebfb6b6138) has an annotation example for a line chart | ||
| - [Adam Pearce](http://blockbuilder.org/1wheel/68073eeba4d19c454a8c25fcd6e9e68a) has arc-arrows and [swoopy drag](http://1wheel.github.io/swoopy-drag/) | ||
| - [Micah Stubbs](http://bl.ocks.org/micahstubbs/fa129089b7989975e96b166077f74de4#annotations.json) has a nice VR chart based on swoopy drag | ||
| - [Scott Logic](http://blog.scottlogic.com/2014/08/26/two-line-components-for-d3-charts.html) evokes “line annotation” in a graph (different concept). | ||
| - [Seven Features You’ll Want In Your Next Charting Tool](http://vis4.net/blog/posts/seven-features-youll-wantin-your-next-charting-tool/) shows how the NYT does annotations | ||
| - [John Burn-Murdoch](https://bl.ocks.org/johnburnmurdoch/bcdb4e85c7523a2b0e64961f0d227154) example with adding/removing and repositioning annotations |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Dynamic require
Supply chain riskDynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.
Found 1 instance in 1 package
Minified code
QualityThis package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.
Found 1 instance in 1 package
Unidentified License
License(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Empty package
Supply chain riskPackage does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by68309.3%
294160
- Number of package files
- increased by400%
10
- Lines of code
- increased byInfinity%
5151
- Number of lines in readme file
- increased by2050%
43
Worsened metrics
- Dependency count
- increased byInfinity%
5
- Dev dependency count
- increased byInfinity%
13
- Number of low license alerts
- increased byInfinity%
1
- License quality
- decreased by-20%
80
- Number of low supply chain risk alerts
- increased byInfinity%
4
Dependency changes
+ Addedd3-dispatch@1.0.2
+ Addedd3-drag@1.0.2
+ Addedd3-selection@1.0.2
+ Addedd3-shape@1.0.4
+ Addedd3-transition@1.0.3
+ Addedd3-color@1.4.1(transitive)
+ Addedd3-dispatch@1.0.2(transitive)
+ Addedd3-drag@1.0.2(transitive)
+ Addedd3-ease@1.0.7(transitive)
+ Addedd3-interpolate@1.4.0(transitive)
+ Addedd3-path@1.0.9(transitive)
+ Addedd3-selection@1.0.2(transitive)
+ Addedd3-shape@1.0.4(transitive)
+ Addedd3-timer@1.0.10(transitive)
+ Addedd3-transition@1.0.3(transitive)