vega-tooltip

WebJar for vega-tooltip

License

License

BSD 3-Clause
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

vega-tooltip
Last Version

Last Version

0.23.2
Release Date

Release Date

Type

Type

jar
Description

Description

vega-tooltip
WebJar for vega-tooltip
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/vega/vega-tooltip

Download vega-tooltip

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/vega-tooltip/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>vega-tooltip</artifactId>
    <version>0.23.2</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/vega-tooltip/
implementation 'org.webjars.npm:vega-tooltip:0.23.2'
// https://jarcasting.com/artifacts/org.webjars.npm/vega-tooltip/
implementation ("org.webjars.npm:vega-tooltip:0.23.2")
'org.webjars.npm:vega-tooltip:jar:0.23.2'
<dependency org="org.webjars.npm" name="vega-tooltip" rev="0.23.2">
  <artifact name="vega-tooltip" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='vega-tooltip', version='0.23.2')
)
libraryDependencies += "org.webjars.npm" % "vega-tooltip" % "0.23.2"
[org.webjars.npm/vega-tooltip "0.23.2"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : vega-util jar [1.14.1,2)

Project Modules

There are no modules declared in this project.

Tooltip for Vega & Vega-Lite

npm version Build Status codecov code style: prettier

A tooltip plugin for Vega and Vega-Lite visualizations. This plugin implements a custom tooltip handler for Vega that uses custom HTML tooltips instead of the HTML title attribute. Vega Tooltip is installed in the Vega Editor.

demo image

Features

  • Renders nice tooltips for Vega and Vega-Lite charts
  • Supports dark and light theme
  • Renders object-valued tooltips as a table
  • Supports special keys title (becomes the title of the tooltip) and image (used as the url for an embedded image)

Demo

http://vega.github.io/vega-tooltip/

Installing

We recommend using Vega-Embed, which already comes with this tooltip plugin.

NPM or Yarn

Use npm install vega-tooltip or yarn add vega-tooltip.

Using Vega-tooltip with a CDN

You can import vega-tooltip directly from jsDelivr. Replace [VERSION] with the version that you want to use.

<!-- Import Vega 5 & Vega-Lite 4 (does not have to be from CDN) -->
<script src="https://cdn.jsdelivr.net/npm/vega@5"></script>
<script src="https://cdn.jsdelivr.net/npm/vega-lite@4"></script>

<script src="https://cdn.jsdelivr.net/npm/vega-tooltip@[VERSION]"></script>

Usage and APIs

If you use Vega-Embed, you don't need to install Vega Tooltip! Vega Embed already comes with Vega Tooltip. You can however pass tooltip customizations.

vegaEmbed("#vis", spec, {tooltip: {theme: 'dark'}})
  .then(function(result) {
    // result.view contains the Vega view
  })
  .catch(console.error);

If you want to ue a different version of the tooltip handler, you can override the default handler with the handler from Vega Tooltip (and you need to install it separately).

var handler = new vegaTooltip.Handler();
vegaEmbed("#vis", spec, {tooltip: handler.call})
  .then(function(result) {
    // result.view contains the Vega view
  })
  .catch(console.error);

See the API documentation for details.

Tutorials

  1. Creating Your Tooltip
  2. Customizing Your Tooltip

Run Instructions

  1. In the project folder vega-tooltip, type command yarn to install dependencies.
  2. Then, type yarn start. This will build the library and start a web server.
  3. In your browser, navigate to http://localhost:8000/, where you can see various Vega-Lite and Vega visualizations with tooltip interaction.

Release Process

To release a new version, make sure that everything works. Then run yarn version and bump the version number. Lastly, push to GitHub (with the release tag). Travis will build a bundle and make the npm release automatically.

org.webjars.npm

Vega

Data Visualization Languages & Tools

Versions

Version
0.23.2
0.20.1
0.15.0