Terminology - abudaan/vega-multi-view GitHub Wiki

A spec is a Vega specification, it tells the Vega runtime what to render on the page.

A view is the rendered instance of that spec on a HTML page.

The vega-multi-view wrapper applies settings to the Vega runtime before rendering, such as setting the renderer type (canvas or svg), and performs some extra steps after rendering, notably connecting the signals of the views.

The global configuration of vega-multi-view defines which specs will be added as views to your page, and you can set parameters that are applied to the pre- and post-processing of these views.

With a view specific configuration you can override some of the global settings and add extra parameters that for instance tell vega-multi-view which signals to publish or to subscribe to.

This view specific configuration can be added to a spec (inlined), for this you can use the key vmvConfig (see example #1). You can also provide a configuration separately. It is also possible to use no view specific configuration at all: then the view will be rendered with the global settings.

Both the global and the view specific configuration, as well as the Vega spec can be created from a:

  • javascript object (POJO)
  • JSON string
  • uri of a JSON, BSON, CSON or YAML file.

Types

Below the mapping of the terms above to their javascript types; these types are used in the upcoming API chapter:

  • spec: VegaSpecType
  • view: VegaViewType
  • global configuration: ConfigType
  • view specific configuration: ViewConfigType

For the type definition of VegaSpecType see this part of the Vega 3 documentation.

For the type definition of VegaViewType see this part of the Vega 3 documentation.