question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

add `annotations` guide

See original GitHub issue

Following this vega-lite related issue as well as #749 , I wonder whether it would make sense adding a more general annotations guide in the same fashion as the axes or legends guides, allowing to place a text annotation anywhere in the visualisation. Examples of annotations are title, subtitle, source, explanations within the graph, etc.

Placement could happen in a similar fashion than legends (top, right, bottom, left, etc. , (x, y) values in encoding block, or even scale dependent x and y values). An array could contain several annotation objects, each one specified and placed on its own.

text marks can currently be used for that purpose but their use as annotations is not obvious to everyone. When there are many annotations, the use of text mark & co. will remain the way to go. Maybe a good short run solution would be to provide a quick tutorial or example on how annotations can already be implemented.

The advantages of annotations as a guide over annotations as a text mark instance are:

  • more intuitive use for single instance annotations outside of the plot (e.g. title) and their better visibility in the spec, thus improving the documentation of the latter;
  • no need for extra data, scale, filter transform, etc. definitions to render a single piece of text;

Issue Analytics

  • State:open
  • Created 6 years ago
  • Reactions:4
  • Comments:16 (8 by maintainers)

github_iconTop GitHub Comments

5reactions
Filcommented, Apr 22, 2017

Yes. Please take a look at the fantastic work on annotations by @susielu http://d3-annotation.susielu.com/

3reactions
groodlookercommented, Jan 8, 2019

I just wanted to point out that when using vega-embed, the susielu d3 annotations work quite well with vega if you use SVG as the renderer. If you don’t mind blending the two, I’d recommend going that route for anyone else looking to incorporate annotations for the time being!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Annotation Guide
Add page references and/or notes as well as you read. Make a list of vocabulary words on a back page or the inside...
Read more >
4 ways to Annotate a text:
Annotating a text, or marking the pages with notes, is an excellent, if not essential, way to make the most out of the...
Read more >
Annotating Texts - UNC Learning Center
How do you annotate? · Use headers and words in bold to guide you · Look for main ideas, arguments, and points of...
Read more >
Annotation Guide Teaching Resources - TPT
Browse annotation guide resources on Teachers Pay Teachers, a marketplace trusted by millions of teachers for original educational ...
Read more >
Annotating a Text - Hunter College - CUNY
Highlighting or underlining key words and phrases or major ideas is the most common form of annotating texts. Many people use this method...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found