boomack-plugin-vega
v0.12.2
Published
Boomack PlugIn for rendering Vega visualizations
Downloads
5
Readme
Boomack Plug-In Vega
Installation
If your using the Windows MSI installer for Boomack, this plug-in is installed by default. You can however, deselect it in the setup dialog during the installation.
The Docker image also contains this plug-in.
If you are using npm for installation, you can install this plug-in with:
==| TABS |== ::| Shell / Command Line
npm i -g boomack-plugin-vega
==|------|==
Features
PlugIn ID: vega
Text Transformation vega
Generate HTML with a Vega visualization.
Input
The input is expected to be valid JSON or YAML. It is interpreted as a Vega specification to render.
Display Options
vega.padding
Sets the view padding in pixels. See Vega docs for details.vega.width
Sets the view width in pixels. See Vega docs for details. Note that Vega-Lite overrides this option.vega.height
Sets the view height in pixels. See Vega docs for details. Note that Vega-Lite overrides this option.vega.renderer
The renderer to use for the view. One of "canvas" (default) or "svg". See Vega docs for details.vega.hover
A boolean or an object. Enable hover event processing. Hover event processing is enabled on Vega by default.
Boolean: Enables/disables hover event processing.
Object: Optional keys (hoverSet
,updateSet
) to specify which named encoding sets to invoke upon mouseover and mouseout.
Text Transformation vega-lite
Generate HTML with a Vega Lite visualization.
Input
The input is expected to be valid JSON or YAML. It is interpreted as a Vega Lite specification to render.
Display Options
vega.padding
Sets the view padding in pixels. See Vega docs for details.vega.zoomFit
A switch to fit the visualization to the slot size. Defaults totrue
.vega.renderer
The renderer to use for the view. One of "canvas" (default) or "svg". See Vega docs for details.vega.hover
A boolean or an object. Enable hover event processing. Hover event processing is enabled on Vega by default.
Boolean: Enables/disables hover event processing.
Object: Optional keys (hoverSet
,updateSet
) to specify which named encoding sets to invoke upon mouseover and mouseout.
Renderer vega
Generate HTML with a Vega visualization.
Takes the Vega specification from display option vega.spec
and inserts the resource URL in every data.[*].url
with is null
.
Input
The input is expected to be a data format, supported by Vega.
In Vega 5 json
, csv
, tsv
, dsv
, and topojson
are supported.
The data format must be specified in the Vega specification in data.[*].format.type
.
Display Options
vega.padding
Sets the view padding in pixels. See Vega docs for details.vega.width
Sets the view width in pixels. See Vega docs for details. Note that Vega-Lite overrides this option.vega.height
Sets the view height in pixels. See Vega docs for details. Note that Vega-Lite overrides this option.vega.renderer
The renderer to use for the view. One of "canvas" (default) or "svg". See Vega docs for details.vega.hover
A boolean or an object. Enable hover event processing. Hover event processing is enabled on Vega by default.
Boolean: Enables/disables hover event processing.
Object: Optional keys (hoverSet
,updateSet
) to specify which named encoding sets to invoke upon mouseover and mouseout.vega.spec
An object which is interpreted as a Vega specification to render. It should have at least one item in thedata
array with the propertyurl
set tonull
as placeholder for the resource URL.
Renderer vega-lite
Generate HTML with a Vega Lite visualization.
Taking the Vega Lite specification from display option vega.spec
and inserting the resource URL in data.url
.
Input
The input is expected to be a data format, supported by Vega Lite.
In Vega Lite 5 json
, csv
, tsv
, and dsv
are supported.
The data format must be specified in the Vega Lite specification in data.format.type
.
Display Options
vega.padding
Sets the view padding in pixels. See Vega docs for details.vega.zoomFit
A switch to fit the visualization to the slot size. Defaults totrue
.vega.renderer
The renderer to use for the view. One of "canvas" (default) or "svg". See Vega docs for details.vega.hover
A boolean or an object. Enable hover event processing. Hover event processing is enabled on Vega by default.
Boolean: Enables/disables hover event processing.
Object: Optional keys (hoverSet
,updateSet
) to specify which named encoding sets to invoke upon mouseover and mouseout.vega.spec
An object which is interpreted as a Vega Lite specification to render. It should have an object in thedata
property with theurl
set tonull
.
Media Types
The plug-in provides the following media types:
application/x-vega-spec
application/x-vega-lite-spec