vega-lite-api

vl.xError(…values)

Specify the xError encoding channel.

xError Method Overview

• aggregate
• argmax
• argmin
• average
• bandPosition
• bin
• ci0
• ci1
• count
• date
• day
• distinct
• field
• fieldN
• fieldO
• fieldQ
• fieldT
• hours
• if
• max
• mean
• median
• milliseconds
• min
• minutes
• missing
• month
• product
• q1
• q3
• quarter
• seconds
• stderr
• stdev
• stdevp
• sum
• timeHM
• timeHMS
• timeMD
• timeMDH
• timeMS
• timeQM
• timeSMS
• timeUnit
• timeYM
• timeYMD
• timeYMDH
• timeYMDHM
• timeYMDHMS
• timeYQ
• timeYQM
• title
• utcHM
• utcHMS
• utcMD
• utcMDH
• utcMS
• utcQM
• utcSMS
• utcYM
• utcYMD
• utcYMDH
• utcYMDHM
• utcYMDHMS
• utcYQ
• utcYQM
• utcdate
• utcday
• utchours
• utcmilliseconds
• utcminutes
• utcmonth
• utcquarter
• utcseconds
• utcyear
• utcyearmonth
• valid
• value
• variance
• variancep
• year
• yearmonth

xError API Reference

# xError.aggregate(value)

Aggregation function for the field (e.g., "mean", "sum", "median", "min", "max", "count").

Default value: undefined (None)

See also: aggregate documentation.

# xError.argmax(field)

Apply the argmax aggregate operation prior to encoding.

# xError.argmin(field)

Apply the argmin aggregate operation prior to encoding.

# xError.average(field)

Apply the average aggregate operation prior to encoding.

# xError.bandPosition(value)

Relative position on a band of a stacked, binned, time unit, or band scale. For example, the marks will be positioned at the beginning of the band if set to 0, and at the middle of the band if set to 0.5.

# xError.bin(value)

A flag for binning a quantitative field, an object defining binning parameters, or indicating that the data for x or y channel are binned before they are imported into Vega-Lite ("binned").

• If true, default binning parameters will be applied.

• If "binned", this indicates that the data for the x (or y) channel are already binned. You can map the bin-start field to x (or y) and the bin-end field to x2 (or y2). The scale and axis will be formatted similar to binning in Vega-Lite. To adjust the axis ticks based on the bin step, you can also set the axis’s tickMinStep property.

Default value: false

See also: bin documentation.

# xError.ci0(field)

Apply the ci0 aggregate operation prior to encoding.

# xError.ci1(field)

Apply the ci1 aggregate operation prior to encoding.

# xError.count()

Apply the count aggregate operation prior to encoding.

# xError.date(field)

Apply the date timeUnit operation prior to encoding.

# xError.day(field)

Apply the day timeUnit operation prior to encoding.

# xError.distinct(field)

Apply the distinct aggregate operation prior to encoding.

# xError.field(value)

Required. A string defining the name of the field from which to pull a data value or an object defining iterated values from the repeat operator.

See also: field documentation.

Notes: 1) Dots (.) and brackets ([ and ]) can be used to access nested objects (e.g., "field": "foo.bar" and "field": "foo['bar']"). If field names contain dots or brackets but are not nested, you can use \\ to escape dots and brackets (e.g., "a\\.b" and "a\\[0\\]"). See more details about escaping in the field documentation. 2) field is not required if aggregate is count.

# xError.fieldN(field)

Encode the field as a nominal data type.

# xError.fieldO(field)

Encode the field as an ordinal data type.

# xError.fieldQ(field)

Encode the field as a quantitative data type.

# xError.fieldT(field)

Encode the field as a temporal data type.

# xError.hours(field)

Apply the hours timeUnit operation prior to encoding.

# xError.if(…condition)

Perform a conditional encoding. If the provided condition (first argument) evaluates to true, apply the provided encoding (second argument).

# xError.max(field)

Apply the max aggregate operation prior to encoding.

# xError.mean(field)

Apply the mean aggregate operation prior to encoding.

# xError.median(field)

Apply the median aggregate operation prior to encoding.

# xError.milliseconds(field)

Apply the milliseconds timeUnit operation prior to encoding.

# xError.min(field)

Apply the min aggregate operation prior to encoding.

# xError.minutes(field)

Apply the minutes timeUnit operation prior to encoding.

# xError.missing(field)

Apply the missing aggregate operation prior to encoding.

# xError.month(field)

Apply the month timeUnit operation prior to encoding.

# xError.product(field)

Apply the product aggregate operation prior to encoding.

# xError.q1(field)

Apply the q1 aggregate operation prior to encoding.

# xError.q3(field)

Apply the q3 aggregate operation prior to encoding.

# xError.quarter(field)

Apply the quarter timeUnit operation prior to encoding.

# xError.seconds(field)

Apply the seconds timeUnit operation prior to encoding.

# xError.stderr(field)

Apply the stderr aggregate operation prior to encoding.

# xError.stdev(field)

Apply the stdev aggregate operation prior to encoding.

# xError.stdevp(field)

Apply the stdevp aggregate operation prior to encoding.

# xError.sum(field)

Apply the sum aggregate operation prior to encoding.

# xError.timeHM(field)

Apply the hoursminutes timeUnit operation prior to encoding.

# xError.timeHMS(field)

Apply the hoursminutesseconds timeUnit operation prior to encoding.

# xError.timeMD(field)

Apply the monthdate timeUnit operation prior to encoding.

# xError.timeMDH(field)

Apply the monthdatehours timeUnit operation prior to encoding.

# xError.timeMS(field)

Apply the minutesseconds timeUnit operation prior to encoding.

# xError.timeQM(field)

Apply the quartermonth timeUnit operation prior to encoding.

# xError.timeSMS(field)

Apply the secondsmilliseconds timeUnit operation prior to encoding.

# xError.timeUnit(value)

Time unit (e.g., year, yearmonth, month, hours) for a temporal field. or a temporal field that gets casted as ordinal.

Default value: undefined (None)

See also: timeUnit documentation.

# xError.timeYM(field)

Apply the yearmonth timeUnit operation prior to encoding.

# xError.timeYMD(field)

Apply the yearmonthdate timeUnit operation prior to encoding.

# xError.timeYMDH(field)

Apply the yearmonthdatehours timeUnit operation prior to encoding.

# xError.timeYMDHM(field)

Apply the yearmonthdatehoursminutes timeUnit operation prior to encoding.

# xError.timeYMDHMS(field)

Apply the yearmonthdatehoursminutesseconds timeUnit operation prior to encoding.

# xError.timeYQ(field)

Apply the yearquarter timeUnit operation prior to encoding.

# xError.timeYQM(field)

Apply the yearquartermonth timeUnit operation prior to encoding.

# xError.title(value)

A title for the field. If null, the title will be removed.

Default value: derived from the field’s name and transformation function (aggregate, bin and timeUnit). If the field has an aggregate function, the function is displayed as part of the title (e.g., "Sum of Profit"). If the field is binned or has a time unit applied, the applied function is shown in parentheses (e.g., "Profit (binned)", "Transaction Date (year-month)"). Otherwise, the title is simply the field name.

Notes:

1) You can customize the default field title format by providing the fieldTitle property in the config or fieldTitle function via the compile function’s options.

2) If both field definition’s title and axis, header, or legend title are defined, axis/header/legend title will be used.

# xError.utcHM(field)

Apply the utchoursminutes timeUnit operation prior to encoding.

# xError.utcHMS(field)

Apply the utchoursminutesseconds timeUnit operation prior to encoding.

# xError.utcMD(field)

Apply the utcmonthdate timeUnit operation prior to encoding.

# xError.utcMDH(field)

Apply the utcmonthdatehours timeUnit operation prior to encoding.

# xError.utcMS(field)

Apply the utcminutesseconds timeUnit operation prior to encoding.

# xError.utcQM(field)

Apply the utcquartermonth timeUnit operation prior to encoding.

# xError.utcSMS(field)

Apply the utcsecondsmilliseconds timeUnit operation prior to encoding.

# xError.utcYM(field)

Apply the utcyearmonth timeUnit operation prior to encoding.

# xError.utcYMD(field)

Apply the utcyearmonthdate timeUnit operation prior to encoding.

# xError.utcYMDH(field)

Apply the utcyearmonthdatehours timeUnit operation prior to encoding.

# xError.utcYMDHM(field)

Apply the utcyearmonthdatehoursminutes timeUnit operation prior to encoding.

# xError.utcYMDHMS(field)

Apply the utcyearmonthdatehoursminutesseconds timeUnit operation prior to encoding.

# xError.utcYQ(field)

Apply the utcyearquarter timeUnit operation prior to encoding.

# xError.utcYQM(field)

Apply the utcyearquartermonth timeUnit operation prior to encoding.

# xError.utcdate(field)

Apply the utcdate timeUnit operation prior to encoding.

# xError.utcday(field)

Apply the utcday timeUnit operation prior to encoding.

# xError.utchours(field)

Apply the utchours timeUnit operation prior to encoding.

# xError.utcmilliseconds(field)

Apply the utcmilliseconds timeUnit operation prior to encoding.

# xError.utcminutes(field)

Apply the utcminutes timeUnit operation prior to encoding.

# xError.utcmonth(field)

Apply the utcmonth timeUnit operation prior to encoding.

# xError.utcquarter(field)

Apply the utcquarter timeUnit operation prior to encoding.

# xError.utcseconds(field)

Apply the utcseconds timeUnit operation prior to encoding.

# xError.utcyear(field)

Apply the utcyear timeUnit operation prior to encoding.

# xError.utcyearmonth(field)

Apply the utcyearmonth timeUnit operation prior to encoding.

# xError.valid(field)

Apply the valid aggregate operation prior to encoding.

# xError.value(value)

A constant value in visual domain (e.g., "red" / "#0099ff" / gradient definition for color, values between 0 to 1 for opacity).

# xError.variance(field)

Apply the variance aggregate operation prior to encoding.

# xError.variancep(field)

Apply the variancep aggregate operation prior to encoding.

# xError.year(field)

Apply the year timeUnit operation prior to encoding.

# xError.yearmonth(field)

Apply the yearmonth timeUnit operation prior to encoding.

This site is open source. Improve this page.