vega-lite-api

vl.yOffset(…values)

Specify the yOffset encoding channel.

yOffset Method Overview

• aggregate
• argmax
• argmin
• average
• bandPosition
• bin
• ci0
• ci1
• count
• date
• datum
• day
• distinct
• field
• fieldN
• fieldO
• fieldQ
• fieldT
• hours
• if
• max
• mean
• median
• milliseconds
• min
• minutes
• missing
• month
• product
• q1
• q3
• quarter
• scale
• seconds
• sort
• stderr
• stdev
• stdevp
• sum
• timeHM
• timeHMS
• timeMD
• timeMDH
• timeMS
• timeQM
• timeSMS
• timeUnit
• timeYM
• timeYMD
• timeYMDH
• timeYMDHM
• timeYMDHMS
• timeYQ
• timeYQM
• title
• type
• 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

yOffset API Reference

# yOffset.aggregate(value)

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

Default value: undefined (None)

See also: aggregate documentation.

# yOffset.argmax(field)

Apply the argmax aggregate operation prior to encoding.

# yOffset.argmin(field)

Apply the argmin aggregate operation prior to encoding.

# yOffset.average(field)

Apply the average aggregate operation prior to encoding.

# yOffset.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.

# yOffset.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.

# yOffset.ci0(field)

Apply the ci0 aggregate operation prior to encoding.

# yOffset.ci1(field)

Apply the ci1 aggregate operation prior to encoding.

# yOffset.count()

Apply the count aggregate operation prior to encoding.

# yOffset.date(field)

Apply the date timeUnit operation prior to encoding.

# yOffset.datum(value)

A constant value in data domain.

# yOffset.day(field)

Apply the day timeUnit operation prior to encoding.

# yOffset.distinct(field)

Apply the distinct aggregate operation prior to encoding.

# yOffset.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.

# yOffset.fieldN(field)

Encode the field as a nominal data type.

# yOffset.fieldO(field)

Encode the field as an ordinal data type.

# yOffset.fieldQ(field)

Encode the field as a quantitative data type.

# yOffset.fieldT(field)

Encode the field as a temporal data type.

# yOffset.hours(field)

Apply the hours timeUnit operation prior to encoding.

# yOffset.if(…condition)

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

# yOffset.max(field)

Apply the max aggregate operation prior to encoding.

# yOffset.mean(field)

Apply the mean aggregate operation prior to encoding.

# yOffset.median(field)

Apply the median aggregate operation prior to encoding.

# yOffset.milliseconds(field)

Apply the milliseconds timeUnit operation prior to encoding.

# yOffset.min(field)

Apply the min aggregate operation prior to encoding.

# yOffset.minutes(field)

Apply the minutes timeUnit operation prior to encoding.

# yOffset.missing(field)

Apply the missing aggregate operation prior to encoding.

# yOffset.month(field)

Apply the month timeUnit operation prior to encoding.

# yOffset.product(field)

Apply the product aggregate operation prior to encoding.

# yOffset.q1(field)

Apply the q1 aggregate operation prior to encoding.

# yOffset.q3(field)

Apply the q3 aggregate operation prior to encoding.

# yOffset.quarter(field)

Apply the quarter timeUnit operation prior to encoding.

# yOffset.scale(value)

An object defining properties of the channel’s scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.

If null, the scale will be disabled and the data value will be directly encoded.

Default value: If undefined, default scale properties are applied.

See also: scale documentation.

# yOffset.seconds(field)

Apply the seconds timeUnit operation prior to encoding.

# yOffset.sort(value)

Sort order for the encoded field.

For continuous fields (quantitative or temporal), sort can be either "ascending" or "descending".

For discrete fields, sort can be one of the following:

• "ascending" or "descending" – for sorting by the values’ natural order in JavaScript.
• A string indicating an encoding channel name to sort by (e.g., "x" or "y") with an optional minus prefix for descending sort (e.g., "-x" to sort by x-field, descending). This channel string is short-form of a sort-by-encoding definition. For example, "sort": "-x" is equivalent to "sort": {"encoding": "x", "order": "descending"}.
• A sort field definition for sorting by another field.
• An array specifying the field values in preferred order. In this case, the sort order will obey the values in the array, followed by any unspecified values in their original order. For discrete time field, values in the sort array can be date-time definition objects. In addition, for time units "month" and "day", the values can be the month or day names (case insensitive) or their 3-letter initials (e.g., "Mon", "Tue").
• null indicating no sort.

Default value: "ascending"

Note: null and sorting by another channel is not supported for row and column.

See also: sort documentation.

# yOffset.stderr(field)

Apply the stderr aggregate operation prior to encoding.

# yOffset.stdev(field)

Apply the stdev aggregate operation prior to encoding.

# yOffset.stdevp(field)

Apply the stdevp aggregate operation prior to encoding.

# yOffset.sum(field)

Apply the sum aggregate operation prior to encoding.

# yOffset.timeHM(field)

Apply the hoursminutes timeUnit operation prior to encoding.

# yOffset.timeHMS(field)

Apply the hoursminutesseconds timeUnit operation prior to encoding.

# yOffset.timeMD(field)

Apply the monthdate timeUnit operation prior to encoding.

# yOffset.timeMDH(field)

Apply the monthdatehours timeUnit operation prior to encoding.

# yOffset.timeMS(field)

Apply the minutesseconds timeUnit operation prior to encoding.

# yOffset.timeQM(field)

Apply the quartermonth timeUnit operation prior to encoding.

# yOffset.timeSMS(field)

Apply the secondsmilliseconds timeUnit operation prior to encoding.

# yOffset.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.

# yOffset.timeYM(field)

Apply the yearmonth timeUnit operation prior to encoding.

# yOffset.timeYMD(field)

Apply the yearmonthdate timeUnit operation prior to encoding.

# yOffset.timeYMDH(field)

Apply the yearmonthdatehours timeUnit operation prior to encoding.

# yOffset.timeYMDHM(field)

Apply the yearmonthdatehoursminutes timeUnit operation prior to encoding.

# yOffset.timeYMDHMS(field)

Apply the yearmonthdatehoursminutesseconds timeUnit operation prior to encoding.

# yOffset.timeYQ(field)

Apply the yearquarter timeUnit operation prior to encoding.

# yOffset.timeYQM(field)

Apply the yearquartermonth timeUnit operation prior to encoding.

# yOffset.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.

# yOffset.type(value)

The type of measurement ("quantitative", "temporal", "ordinal", or "nominal") for the encoded field or constant value (datum). It can also be a "geojson" type for encoding ‘geoshape’.

Vega-Lite automatically infers data types in many cases as discussed below. However, type is required for a field if: (1) the field is not nominal and the field encoding has no specified aggregate (except argmin and argmax), bin, scale type, custom sort order, nor timeUnit or (2) if you wish to use an ordinal scale for a field with bin or timeUnit.

Default value:

1) For a data field, "nominal" is the default data type unless the field encoding has aggregate, channel, bin, scale type, sort, or timeUnit that satisfies the following criteria:

• "quantitative" is the default type if (1) the encoded field contains bin or aggregate except "argmin" and "argmax", (2) the encoding channel is latitude or longitude channel or (3) if the specified scale type is a quantitative scale.
• "temporal" is the default type if (1) the encoded field contains timeUnit or (2) the specified scale type is a time or utc scale
• "ordinal" is the default type if (1) the encoded field contains a custom sort order, (2) the specified scale type is an ordinal/point/band scale, or (3) the encoding channel is order.

2) For a constant value in data domain (datum):

• "quantitative" if the datum is a number
• "nominal" if the datum is a string
• "temporal" if the datum is a date time object

Note:

• Data type describes the semantics of the data rather than the primitive data types (number, string, etc.). The same primitive data type can have different types of measurement. For example, numeric data can represent quantitative, ordinal, or nominal data.
• Data values for a temporal field can be either a date-time string (e.g., "2015-03-07 12:32:17", "17:01", "2015-03-16". "2015") or a timestamp number (e.g., 1552199579097).
• When using with bin, the type property can be either "quantitative" (for using a linear bin scale) or "ordinal" (for using an ordinal bin scale).
• When using with timeUnit, the type property can be either "temporal" (default, for using a temporal scale) or "ordinal" (for using an ordinal scale).
• When using with aggregate, the type property refers to the post-aggregation data type. For example, we can calculate count distinct of a categorical field "cat" using {"aggregate": "distinct", "field": "cat"}. The "type" of the aggregate output is "quantitative".
• Secondary channels (e.g., x2, y2, xError, yError) do not have type as they must have exactly the same type as their primary channels (e.g., x, y).

See also: type documentation.

# yOffset.utcHM(field)

Apply the utchoursminutes timeUnit operation prior to encoding.

# yOffset.utcHMS(field)

Apply the utchoursminutesseconds timeUnit operation prior to encoding.

# yOffset.utcMD(field)

Apply the utcmonthdate timeUnit operation prior to encoding.

# yOffset.utcMDH(field)

Apply the utcmonthdatehours timeUnit operation prior to encoding.

# yOffset.utcMS(field)

Apply the utcminutesseconds timeUnit operation prior to encoding.

# yOffset.utcQM(field)

Apply the utcquartermonth timeUnit operation prior to encoding.

# yOffset.utcSMS(field)

Apply the utcsecondsmilliseconds timeUnit operation prior to encoding.

# yOffset.utcYM(field)

Apply the utcyearmonth timeUnit operation prior to encoding.

# yOffset.utcYMD(field)

Apply the utcyearmonthdate timeUnit operation prior to encoding.

# yOffset.utcYMDH(field)

Apply the utcyearmonthdatehours timeUnit operation prior to encoding.

# yOffset.utcYMDHM(field)

Apply the utcyearmonthdatehoursminutes timeUnit operation prior to encoding.

# yOffset.utcYMDHMS(field)

Apply the utcyearmonthdatehoursminutesseconds timeUnit operation prior to encoding.

# yOffset.utcYQ(field)

Apply the utcyearquarter timeUnit operation prior to encoding.

# yOffset.utcYQM(field)

Apply the utcyearquartermonth timeUnit operation prior to encoding.

# yOffset.utcdate(field)

Apply the utcdate timeUnit operation prior to encoding.

# yOffset.utcday(field)

Apply the utcday timeUnit operation prior to encoding.

# yOffset.utchours(field)

Apply the utchours timeUnit operation prior to encoding.

# yOffset.utcmilliseconds(field)

Apply the utcmilliseconds timeUnit operation prior to encoding.

# yOffset.utcminutes(field)

Apply the utcminutes timeUnit operation prior to encoding.

# yOffset.utcmonth(field)

Apply the utcmonth timeUnit operation prior to encoding.

# yOffset.utcquarter(field)

Apply the utcquarter timeUnit operation prior to encoding.

# yOffset.utcseconds(field)

Apply the utcseconds timeUnit operation prior to encoding.

# yOffset.utcyear(field)

Apply the utcyear timeUnit operation prior to encoding.

# yOffset.utcyearmonth(field)

Apply the utcyearmonth timeUnit operation prior to encoding.

# yOffset.valid(field)

Apply the valid aggregate operation prior to encoding.

# yOffset.value(value)

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

# yOffset.variance(field)

Apply the variance aggregate operation prior to encoding.

# yOffset.variancep(field)

Apply the variancep aggregate operation prior to encoding.

# yOffset.year(field)

Apply the year timeUnit operation prior to encoding.

# yOffset.yearmonth(field)

Apply the yearmonth timeUnit operation prior to encoding.

This site is open source. Improve this page.