vega-scenegraph

What is vega-scenegraph?

The vega-scenegraph npm package is a low-level library for rendering and manipulating scene graphs, which are hierarchical structures representing graphical scenes. It is part of the Vega ecosystem, which is designed for creating, sharing, and exploring data visualizations. The package provides tools for creating and managing graphical elements, handling rendering contexts, and performing hit testing.

What are vega-scenegraph's main functionalities?

Creating and Managing Scene Graphs

This feature allows you to create and manage scene graphs. The code sample demonstrates how to create a new scene graph, add a rectangle mark to it, and append the rectangle to the scene.

const vega = require('vega-scenegraph');

// Create a new scenegraph
const scene = new vega.Scenegraph();

// Add a rectangle mark
const rect = scene.mark('rect').item({
  x: 10,
  y: 10,
  width: 100,
  height: 50,
  fill: 'blue'
});

// Add the rectangle to the scene
scene.root.append(rect);

Rendering Contexts

This feature provides tools for creating rendering contexts. The code sample shows how to create a new scene graph, initialize a canvas rendering context, and render the scene.

const vega = require('vega-scenegraph');

// Create a new scenegraph
const scene = new vega.Scenegraph();

// Create a rendering context
const renderer = new vega.CanvasRenderer().initialize(document.querySelector('canvas'), 500, 500);

// Render the scene
renderer.render(scene.root);

Hit Testing

This feature allows for hit testing, which is the process of determining whether a point or area intersects with graphical elements. The code sample demonstrates how to create a scene graph, add a rectangle, and perform a hit test to check if a point is within the rectangle.

const vega = require('vega-scenegraph');

// Create a new scenegraph
const scene = new vega.Scenegraph();

// Add a rectangle mark
const rect = scene.mark('rect').item({
  x: 10,
  y: 10,
  width: 100,
  height: 50,
  fill: 'blue'
});

// Add the rectangle to the scene
scene.root.append(rect);

// Create a hit test
const hitTest = new vega.HitTest(scene.root);

// Check if a point is within the rectangle
const hit = hitTest.test(20, 20);
console.log(hit); // true if the point (20, 20) is within the rectangle

Other packages similar to vega-scenegraph

d3

D3.js (Data-Driven Documents) is a JavaScript library for producing dynamic, interactive data visualizations in web browsers. It uses HTML, SVG, and CSS. Compared to vega-scenegraph, D3 provides a higher-level API for data visualization and is more focused on data binding and transformation.

three

Three.js is a JavaScript library that makes it easy to create 3D graphics in the browser. It provides a scene graph and rendering engine for 3D graphics. While vega-scenegraph is focused on 2D scene graphs for data visualization, Three.js is specialized in 3D graphics and animations.

pixi

PixiJS is a 2D rendering engine that allows developers to create rich, interactive graphics and applications. It is highly performant and supports WebGL and HTML5 Canvas. Compared to vega-scenegraph, PixiJS is more focused on game development and interactive applications rather than data visualization.

README

vega-scenegraph

Vega scenegraph and renderers.

Renderers and event handlers for Vega's mark-based scenegraph. This module supports both pixel-based (canvas) and vector graphics (SVG) output. Renderers can either (re-)draw a complete scene or perform incremental re-rendering for a set of provided "dirty" items. A fast SVG string renderer is also provided to generate static SVG for export.

The node-canvas library is used for server-side canvas rendering and bounds calculation. Node-canvas requires the native Cairo graphics library and attempts to compile native code as part of the installation process. In some instances this may result in installation hiccups. Should you run into issues, you are likely to resolve them more quickly if you first search for help regarding node-canvas (as opposed to vega-scenegraph) installation. However, node-canvas is an optional dependency, and is not needed for SVG rendering. Bounds calculation can be performed without node-canvas, though in the case of text marks the resulting bounds may be inaccurate due to approximate text size calculations.

Scenegraph Definition

The Vega scenegraph is a hierarchical (tree) data structure. The levels of the tree alternate between an enclosing mark definition and contained sets of mark instances called items.

For example, here is a simple scenegraph containing three rectangles:

{
  "marktype": "rect",
  "items": [
    {"x": 0, "y": 0, "width": 50, "height": 50, "fill": "steelblue"},
    {"x": 100, "y": 50, "width": 50, "height": 50, "fill": "firebrick"},
    {"x": 50, "y": 100, "width": 50, "height": 50, "fill": "forestgreen"}
  ]
}

The supported mark types are rectangles (rect), plotting symbols (symbol), general paths or polygons (path), circular arcs (arc), filled areas (area), lines (line), images (image), text labels (text), and chart gridlines or rules (rule). Each item has a set of supported properties (x, y, width, fill, and so on) appropriate to the mark type.

Scenegraphs may also contain group marks, which serve as containers for other marks. For example, a top-level group mark may look like:

{
  "marktype": "group",
  "items": [
    {
      "x": 0,
      "y": 0,
      "width": 200,
      "height": 200,
      "items": [...] // array of contained mark instances
    }
  ]
}

In this example, the group mark contains only a single group item. In practice, a group mark may contain any number of group items, for example to describe a scene with multiple layers or sub-plots.

For more information regarding supported mark properties, please see the Vega marks documentation.

Scenegraph Serialization

The top-level export of this package includes fromJSON and toJSON methods to support scenegraph serialization. The fromJSON method expects a JSON string as input (similar to the examples listed above). It will then add additional parent pointers to the tree structure. For example, each item will have a mark property pointing to it's parent mark, and each mark will have a group property pointing to it's parent group (if any). The toJSON method maps a scenegraph instance to a JSON string, stripping any parent pointers or other non-standard properties.

Test Suite

The vega-scengraph test suite compares rendered output for both Canvas (PNG) and SVG (text) renderers. Due to differences among platforms, pixel-level rendering by node-canvas can differ across operating systems. As a result, some test cases may break when running on a system other than Mac OS X (our standard platform for testing). If you are running on Linux or Windows and experience test failures, it does not necessarily indicate an issue with vega-scenegraph. In such cases, we recommend running the node-canvas test-server (npm run test-server from the node-canvas repository) to compare server-side and client-side rendering.