vega-lite-api

vl.vconcat(…vconcat)

Vertically concatenate charts.

vconcat Method Overview

• autosize
• background
• bounds
• center
• config
• data
• datasets
• description
• facet
• name
• padding
• params
• render
• repeat
• resolve
• spacing
• title
• toSpec
• toString
• toView
• transform
• usermeta
• vconcat

vconcat API Reference

# vconcat.autosize(value)

How the visualization size should be determined. If a string, should be one of "pad", "fit" or "none". Object values can additionally specify parameters for content sizing and automatic resizing.

Default value: pad

# vconcat.background(value)

CSS color property to use as the background of the entire view.

Default value: "white"

# vconcat.bounds(value)

The bounds calculation method to use for determining the extent of a sub-plot. One of full (the default) or flush.

• If set to full, the entire calculated bounds (including axes, title, and legend) will be used.
• If set to flush, only the specified width and height values for the sub-view will be used. The flush setting can be useful when attempting to place sub-plots without axes or legends into a uniform grid structure.

Default value: "full"

# vconcat.center(value)

Boolean flag indicating if subviews should be centered relative to their respective rows or columns.

Default value: false

# vconcat.config(value)

Vega-Lite configuration object. This property can only be defined at the top-level of a specification.

# vconcat.data(data)

The input data specification.

The behavior of this method depends on the argument type:

• If the argument is an Array, sets the data.values property.
• If the argument is an Iterable, sets the data.values property.
• If the argument is a String, sets the data.url property.
• Otherwise, sets the data property.

# vconcat.datasets(value)

A global data store for named datasets. This is a mapping from names to inline datasets. This can be an array of objects or primitive values or a string. Arrays of primitive values are ingested as objects with a data property.

# vconcat.description(value)

Description of this mark for commenting purpose.

# vconcat.facet(…values)

Facet a chart into sub-plots by partitioning data values.

# vconcat.name(value)

Name of the visualization for later reference.

# vconcat.padding(value)

The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle. If a number, specifies padding for all sides. If an object, the value should have the format {"left": 5, "top": 5, "right": 5, "bottom": 5} to specify padding for each side of the visualization.

Default value: 5

# vconcat.params(…params)

An array of parameters that may be simple variables or more complex selections that map user input to data queries.

# vconcat.render(…values)

Compile and render the Vega-Lite visualization and return the DOM element containing the Vega View.

# vconcat.repeat(…values)

Repeat a chart template to generate multiple plots.

# vconcat.resolve(value)

Scale, axis, and legend resolutions for view composition specifications.

# vconcat.spacing(value)

The spacing in pixels between sub-views of the concat operator.

Default value: 10

# vconcat.title(value)

Title for the plot.

# vconcat.toSpec(…values)

Return the Vega-Lite specification as a JavaScript object.

# vconcat.toString(…values)

Return the Vega-Lite specification as a JSON string.

# vconcat.toView(…values)

Compile the Vega-Lite specification and return the resulting Vega View object.

# vconcat.transform(…transform)

The data transformations to apply.

# vconcat.usermeta(value)

Optional metadata that will be passed to Vega. This object is completely ignored by Vega and Vega-Lite and can be used for custom metadata.

# vconcat.vconcat(…value)

A list of views to be concatenated and put into a column.

This site is open source. Improve this page.