elm-vega

Declarative visualization for Elm

This library allows you to create Vega and Vega-Lite specifications in Elm providing a pure functional interface for declarative visualization.

The library does not generate graphical output directly, but instead it allows you to create a JSON specification that can be sent to the Vega and Vega-Lite runtime to create the output. This is therefore a 'pure' Elm package without any external non-Elm dependencies.

Example

A simple scatterplot encoding engine power and efficiency as x- and y-position and country of origin with colour:

let
    cars =
        dataFromUrl "https://vega.github.io/vega-lite/data/cars.json" []

    enc =
        encoding
            << position X [ pName "Horsepower", pMType Quantitative ]
            << position Y [ pName "Miles_per_Gallon", pMType Quantitative ]
            << color [ mName "Origin", mMType Nominal ]
in
toVegaLite [ cars, circle [], enc [] ]

This generates a JSON specification that when sent to the Vega-Lite runtime produces the following output:

The specification generated by elm-vega for this example looks like this:

{
  "$schema": "https://vega.github.io/schema/vega-lite/v3.json",
  "data": {
    "url": "https://vega.github.io/vega-lite/data/cars.json",
    "format": {
      "type": "json"
    }
  },
  "mark": "circle",
  "encoding": {
    "x": {
      "field": "Horsepower",
      "type": "quantitative"
    },
    "y": {
      "field": "Miles_per_Gallon",
      "type": "quantitative"
    },
    "color": {
      "field": "Origin",
      "type": "nominal"
    }
  }
}

Why elm-vega?

A rationale for Elm programmers

There is a demand for good visualization packages with Elm. And there are certainly plenty of data visualization packages available, ranging from low level SVG rendering through a host of charting packages (e.g. Charty and elm-charts) to elegant, opinionated chart construction and a more comprehensive visualization library. The designs of each reflects a trade-off between concise expression, generalisability and comprehensive functionality.

Despite the numbers of libraries, there is a space for a higher level data visualization package (avoiding, for example the need for explicit construction of chart axes) but one that offers the flexibility to create a wide range data visualization types and styles. In particular no existing libraries offer easily constructed interaction and view composition (building 'dashboards' comprising many chart types). elm-vega is designed to fill that gap.

Characteristics of elm-vega

• Built upon the widely used Vega and Vega-Lite specifications that have an academic robustness and momentum behind its development (Vega-Lite is itself built upon the hugely influential Grammar of Graphics).

• High-level declarative specification (a chart can be fully specified in as few as five lines of code)

• Strict typing and friendly error messages means "the compiler is your friend" when building and debugging complex visualizations.

• Flexible interaction for selecting, filtering and zooming built-in to the specification.

• Hierarchical view composition allows complex visualization dashboards to be built from trees of simpler views.

• Full coverage of the Vega specification for more comprehensive and flexible visualization design.

A rationale for data visualisers

Vega-Lite hits the sweet spot of abstraction between lower-level specifications such as D3 and higher level visualization software such as Tableau, while Vega provides addtional flexiblity when it is needed. By using JSON to fully encode a visualization specification Vega and Vega-Lite are portable across a range of platforms and sits well in the JavaScript / Web ecosystem. Yet JSON is really an interchange format rather than one suited directly for visualization design and construction.

By wrapping Vega and Vega-Lite within the Elm language, we can avoid working with JSON directly and instead take advantage of a typed functional programming environment for improved error support and customisation. This greatly improves reusability of code (for example, it is easy to create custom chart types such as box-and-whisker plots that can be used with a range of datasets) and integration with larger programming projects.

Elm and elm-vega provide an ideal environment for educators wishing to teach Data Visualization combining the beginner-friendly design of Elm with the robust and theoretically underpinned design of a grammar of graphics.

Limitations

• elm-vega does not render graphics directly, but instead generates data visualization specifications that may be passed to JavaScript for rendering.

• While limited animation is possible through interaction and dynamic data generation, there is no direct support for animated transitions (unlike D3 for example).

Further Reading

• To get started with your first Elm-Vega program, we recommend starting with Vega-Lite: see Creating your first Vega-Lite visualization with Elm-Vega.
• If you are interested in working with Vega, see Creating your first Vega Visualization with Elm-Vega and Specifying a Vega bar chart.
• For a more thorough set of Vega-Lite examples/tutorial, see the Vega-Lite walkthrough.
• For a rich set of Vega examples see the Vega example gallery.
• For the elm-vega API documentation see http://package.elm-lang.org/packages/gicentre/elm-vega/latest
• Further examples can be found in the elm-vega vlExamples and elm-vega vExamples folders.
• For an example of fully embedding an elm-vega visualization in an elm SPA, see elm-embed-vega.