Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/susielu/d3-annotation
Use d3-annotation with built-in annotation types, or extend it to make custom annotations. It is made for d3-v4 in SVG.
https://github.com/susielu/d3-annotation
annotations d3 d3-annotation d3-module
Last synced: about 2 months ago
JSON representation
Use d3-annotation with built-in annotation types, or extend it to make custom annotations. It is made for d3-v4 in SVG.
- Host: GitHub
- URL: https://github.com/susielu/d3-annotation
- Owner: susielu
- License: apache-2.0
- Created: 2016-10-18T00:01:21.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T03:25:24.000Z (almost 2 years ago)
- Last Synced: 2024-04-18T13:23:28.194Z (5 months ago)
- Topics: annotations, d3, d3-annotation, d3-module
- Language: JavaScript
- Homepage: http://d3-annotation.susielu.com/
- Size: 6.28 MB
- Stars: 746
- Watchers: 16
- Forks: 75
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-d3 - d3-annotation - Annotaion helper with built-in annotation types (Utils)
- awesome-d3 - d3-annotation - Annotaion helper with built-in annotation types (Utils)
- awesome-d3 - d3-annotation - Annotation helper with built-in annotation types (Utils)
README
# 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 CDN
You can add the latest version of [d3-annotation hosted on cdnjs](https://cdnjs.com/libraries/d3-annotation).
### 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