vega-lite-api

Vega-Lite API Reference

Chart Constructors

• vl.mark - Create a new mark of unspecified type.
• vl.markArc - Create a new arc mark.
• vl.markArea - Create a new area mark.
• vl.markBar - Create a new bar mark.
• vl.markBoxplot - Create a new boxplot mark.
• vl.markCircle - Create a new circle mark.
• vl.markErrorband - Create a new errorband mark.
• vl.markErrorbar - Create a new errorbar mark.
• vl.markGeoshape - Create a new geoshape mark.
• vl.markImage - Create a new image mark.
• vl.markLine - Create a new line mark.
• vl.markPoint - Create a new point mark.
• vl.markRect - Create a new rect mark.
• vl.markRule - Create a new rule mark.
• vl.markSquare - Create a new square mark.
• vl.markText - Create a new text mark.
• vl.markTick - Create a new tick mark.
• vl.markTrail - Create a new trail mark.
• vl.layer - Create a new layered chart.
• vl.concat - Concatenate charts.
• vl.hconcat - Horizontally concatenate charts.
• vl.vconcat - Vertically concatenate charts.
• vl.spec - Create an arbitrary Vega-Lite specification.

Utilities

• vl.register - Register Vega and Vega-Lite with the API.
• vl.render - Render a provided Vega-Lite specification.
• vl.vega - Access the registered Vega instance.
• vl.vegalite - Access the registered Vega-Lite instance.

Data

• vl.data - Create a new data reference for a chart or lookup.
• vl.urlData - Define a url data source.
• vl.inlineData - Define a inline data source.
• vl.sequence - Define a sequence data generator.
• vl.sphere - Define a sphere data generator.
• vl.graticule - Define a graticule data generator.
• vl.csv - Define a data source for csv format data.
• vl.dsv - Define a data source for dsv format data.
• vl.json - Define a data source for json format data.
• vl.topojson - Define a data source for topojson format data.
• vl.tsv - Define a data source for tsv format data.
• vl.csvFormat - Specify parsing of csv format data.
• vl.dsvFormat - Specify parsing of dsv format data.
• vl.jsonFormat - Specify parsing of json format data.
• vl.topojsonFormat - Specify parsing of topojson format data.
• vl.tsvFormat - Specify parsing of tsv format data.
• vl.lookupData - Specify a lookup on a secondary data source.
• vl.lookupSelection - Specify a lookup on an interactive selection.

Encodings

• vl.angle - Specify the angle encoding channel.
• vl.color - Specify the color encoding channel.
• vl.column - Specify the column encoding channel.
• vl.description - Specify the description encoding channel.
• vl.detail - Specify the detail encoding channel.
• vl.facet - Specify the facet encoding channel.
• vl.fill - Specify the fill encoding channel.
• vl.fillOpacity - Specify the fillOpacity encoding channel.
• vl.href - Specify the href encoding channel.
• vl.key - Specify the key encoding channel.
• vl.latitude - Specify the latitude encoding channel.
• vl.latitude2 - Specify the latitude2 encoding channel.
• vl.longitude - Specify the longitude encoding channel.
• vl.longitude2 - Specify the longitude2 encoding channel.
• vl.opacity - Specify the opacity encoding channel.
• vl.order - Specify the order encoding channel.
• vl.radius - Specify the radius encoding channel.
• vl.radius2 - Specify the radius2 encoding channel.
• vl.row - Specify the row encoding channel.
• vl.shape - Specify the shape encoding channel.
• vl.size - Specify the size encoding channel.
• vl.stroke - Specify the stroke encoding channel.
• vl.strokeDash - Specify the strokeDash encoding channel.
• vl.strokeOpacity - Specify the strokeOpacity encoding channel.
• vl.strokeWidth - Specify the strokeWidth encoding channel.
• vl.text - Specify the text encoding channel.
• vl.theta - Specify the theta encoding channel.
• vl.theta2 - Specify the theta2 encoding channel.
• vl.tooltip - Specify the tooltip encoding channel.
• vl.url - Specify the url encoding channel.
• vl.x - Specify the x encoding channel.
• vl.x2 - Specify the x2 encoding channel.
• vl.xError - Specify the xError encoding channel.
• vl.xError2 - Specify the xError2 encoding channel.
• vl.xOffset - Specify the xOffset encoding channel.
• vl.y - Specify the y encoding channel.
• vl.y2 - Specify the y2 encoding channel.
• vl.yError - Specify the yError encoding channel.
• vl.yError2 - Specify the yError2 encoding channel.
• vl.yOffset - Specify the yOffset encoding channel.

Projections

• vl.projection - Define a cartographic projection for longitude, latitude coordinates.

References

• vl.field - A reference to a data field.
• vl.fieldN - A reference to a nominal data field.
• vl.fieldO - A reference to an ordinal data field.
• vl.fieldQ - A reference to a quantitative data field.
• vl.fieldT - A reference to a temporal data field.
• vl.encoding - A reference to an encoding channel.
• vl.repeat - A field variable reference for a repeated chart.
• vl.value - A constant encoding value.
• vl.expr - An expression in the Vega expression language.

Parameters

• vl.param - Define or reference a variable parameter.
• vl.selectInterval - Define or reference a interval selection parameter.
• vl.selectPoint - Define or reference a point selection parameter.
• vl.selectSingle - Define or reference a point selection parameter. This method provides backwards compatiblity with earlier API versions; it is deprecated and may be removed in future versions. Use selectPoint() instead.
• vl.selectMulti - Define or reference a point selection parameter. This method provides backwards compatiblity with earlier API versions; it is deprecated and may be removed in future versions. Use selectPoint() instead.
• vl.configInterval - Configure interval selections.
• vl.configPoint - Configure point selections.

Parameter Bindings

• vl.checkbox - Define a new HTML checkbox input element binding.
• vl.menu - Define a new HTML select input element binding.
• vl.radio - Define a new HTML radio input element binding.
• vl.slider - Define a new HTML range input element binding.

Logical Operations

• vl.not - Logical NOT operation.
• vl.and - Logical AND operation.
• vl.or - Logical OR operation.

Data Transformations

• vl.aggregate - Group and summarize data as counts, sums, averages, etc.
• vl.bin - Discretize numeric values into uniform bins.
• vl.calculate - Calculate a new data field value.
• vl.density - Estimate smoothed densities for numeric values.
• vl.filter - Remove data that does not match provided conditions.
• vl.flatten - Map array fields to new records, one per array entry.
• vl.fold - Collapse one or more data fields into two key, value fields.
• vl.impute - Fill in missing values with imputed values.
• vl.joinaggregate - Extend input data with aggregate values as new fields.
• vl.join - A convenient shorthand for joinaggregate.
• vl.loess - Fit a smoothed trend line using local regression.
• vl.lookup - Extend input data with values from another data source.
• vl.pivot - Pivot unique values to new aggregate fields.
• vl.quantile - Calculate sample quantile values for input data.
• vl.regression - Fit regression models to smooth and predict values.
• vl.sample - Filter random records from the data limit its size.
• vl.stack - Compute running sums to stack groups of values.
• vl.timeUnit - Discretize date/time values into meaningful intervals.
• vl.window - Perform running calculations over sorted groups.
• vl.groupby - Group by fields for aggregate or window transforms.

Aggregate Operations

• vl.count - Specify a count aggregate operation.
• vl.valid - Specify a valid aggregate operation.
• vl.missing - Specify a missing aggregate operation.
• vl.distinct - Specify a distinct aggregate operation.
• vl.sum - Specify a sum aggregate operation.
• vl.mean - Specify a mean aggregate operation.
• vl.product - Specify a product aggregate operation.
• vl.average - Specify an average aggregate operation.
• vl.variance - Specify a variance aggregate operation.
• vl.variancep - Specify a variancep aggregate operation.
• vl.stdev - Specify a stdev aggregate operation.
• vl.stdevp - Specify a stdevp aggregate operation.
• vl.stderr - Specify a stderr aggregate operation.
• vl.median - Specify a median aggregate operation.
• vl.q1 - Specify a q1 aggregate operation.
• vl.q3 - Specify a q3 aggregate operation.
• vl.ci0 - Specify a ci0 aggregate operation.
• vl.ci1 - Specify a ci1 aggregate operation.
• vl.min - Specify a min aggregate operation.
• vl.max - Specify a max aggregate operation.
• vl.argmin - Specify an argmin aggregate operation.
• vl.argmax - Specify an argmax aggregate operation.

Window Operations

• vl.row_number - A row_number window operation.
• vl.rank - A rank window operation.
• vl.dense_rank - A dense_rank window operation.
• vl.percent_rank - A percent_rank window operation.
• vl.cume_dist - A cume_dist window operation.
• vl.ntile - A ntile window operation.
• vl.lag - A lag window operation.
• vl.lead - A lead window operation.
• vl.first_value - A first_value window operation.
• vl.last_value - A last_Value window operation.
• vl.nth_value - A nth_value window operation.

TimeUnit Operations

• vl.year - A time unit operation for year.
• vl.quarter - A time unit operation for quarter.
• vl.month - A time unit operation for month.
• vl.day - A time unit operation for day.
• vl.date - A time unit operation for date.
• vl.hours - A time unit operation for hours.
• vl.minutes - A time unit operation for minutes.
• vl.seconds - A time unit operation for seconds.
• vl.milliseconds - A time unit operation for milliseconds.
• vl.yearmonth - A time unit operation for yearmonth.
• vl.timeYQ - A time unit operation for yearquarter.
• vl.timeYQM - A time unit operation for yearquartermonth.
• vl.timeYM - A time unit operation for yearmonth.
• vl.timeYMD - A time unit operation for yearmonthdate.
• vl.timeYMDH - A time unit operation for yearmonthdatehours.
• vl.timeYMDHM - A time unit operation for yearmonthdatehoursminutes.
• vl.timeYMDHMS - A time unit operation for yearmonthdatehoursminutesseconds.
• vl.timeQM - A time unit operation for quartermonth.
• vl.timeMD - A time unit operation for monthdate.
• vl.timeMDH - A time unit operation for monthdatehours.
• vl.timeHM - A time unit operation for hoursminutes.
• vl.timeHMS - A time unit operation for hoursminutesseconds.
• vl.timeMS - A time unit operation for minutesseconds.
• vl.timeSMS - A time unit operation for secondsmilliseconds.
• vl.utcyear - A time unit operation for utcyear.
• vl.utcquarter - A time unit operation for utcquarter.
• vl.utcmonth - A time unit operation for utcmonth.
• vl.utcday - A time unit operation for utcday.
• vl.utcdate - A time unit operation for utcdate.
• vl.utchours - A time unit operation for utchours.
• vl.utcminutes - A time unit operation for utcminutes.
• vl.utcseconds - A time unit operation for utcseconds.
• vl.utcmilliseconds - A time unit operation for utcmilliseconds.
• vl.utcyearmonth - A time unit operation for utcyearmonth.
• vl.utcYQ - A time unit operation for utcyearquarter.
• vl.utcYQM - A time unit operation for utcyearquartermonth.
• vl.utcYM - A time unit operation for utcyearmonth.
• vl.utcYMD - A time unit operation for utcyearmonthdate.
• vl.utcYMDH - A time unit operation for utcyearmonthdatehours.
• vl.utcYMDHM - A time unit operation for utcyearmonthdatehoursminutes.
• vl.utcYMDHMS - A time unit operation for utcyearmonthdatehoursminutesseconds.
• vl.utcQM - A time unit operation for utcquartermonth.
• vl.utcMD - A time unit operation for utcmonthdate.
• vl.utcMDH - A time unit operation for utcmonthdatehours.
• vl.utcHM - A time unit operation for utchoursminutes.
• vl.utcHMS - A time unit operation for utchoursminutesseconds.
• vl.utcMS - A time unit operation for utcminutesseconds.
• vl.utcSMS - A time unit operation for utcsecondsmilliseconds.

This site is open source. Improve this page.