inspect_viz.view
Scores
scores_by_task
Bar plot for comparing eval scores.
Summarize eval scores using a bar plot. By default, scores (y) are plotted by “task_display_name” (fx) and “model_display_name” (x). By default, confidence intervals are also plotted (disable this with y_ci=False).
def scores_by_task(
data: Data,
model_name: str = ...,
task_name: str = ...,
score_value: str = ...,
score_stderr: str = ...,
score_label: str | None | NotGiven = ...,
ci: bool | float = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
width: float | Param | None = ...,
height: float | Param | None = ...,
legend: Legend | NotGiven | None = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table. This is typically created using a data frame read with the inspect evals_df() function.
model_namestr-
Name of field for the model name (defaults to “model_display_name”)
task_namestr-
Name of field for the task name (defaults to “task_display_name”)
score_valuestr-
Name of field for the score value (defaults to “score_headline_value”).
score_stderrstr-
Name of field for stderr (defaults to “score_headline_metric”).
score_labelstr | None | NotGiven-
Score axis label (pass None for no label).
cibool | float-
Confidence interval (e.g. 0.80, 0.90, 0.95, etc.). Defaults to 0.95.
titlestr | Title | None-
Title for plot (
stror mark created with the title() function). marksMarks | None-
Additional marks to include in the plot.
widthfloat | Param | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
heightfloat | Param | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio)
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_by_factor
Summarize eval scores with a factor of variation (e.g ‘No hint’ vs. ‘Hint’).
def scores_by_factor(
data: Data,
factor: str,
factor_labels: tuple[str, str],
score_value: str = ...,
score_stderr: str = ...,
score_label: str = ...,
model: str = ...,
model_label: str = ...,
ci: bool | float = ...,
color: str | tuple[str, str] = ...,
title: str | Mark | None = ...,
marks: Marks | None = ...,
width: float | Param | None = ...,
height: float | Param | None = ...,
legend: Legend | NotGiven | None = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table. This is typically created using a data frame read with the inspect evals_df() function.
factorstr-
Field with factor of variation (should be of type boolean).
factor_labelstuple[str, str]-
Tuple of labels for factor of variation.
Falsevalue should be first, e.g.("No hint", "Hint"). score_valuestr-
Name of field for x (scoring) axis (defaults to “score_headline_value”).
score_stderrstr-
Name of field for scoring stderr (defaults to “score_headline_stderr”).
score_labelstr-
Label for x-axis (defaults to “Score”).
modelstr-
Name of field for y axis (defaults to “model”).
model_labelstr-
Lable for y axis (defaults to “Model”).
cibool | float-
Confidence interval (e.g. 0.80, 0.90, 0.95, etc.). Defaults to 0.95.)
colorstr | tuple[str, str]-
Hex color value (or tuple of two values). If one value is provided the second is computed by lightening the main color.
titlestr | Mark | None-
Title for plot (
stror mark created with the title() function). marksMarks | None-
Additional marks to include in the plot.
widthfloat | Param | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
heightfloat | Param | None-
The outer height of the plot in pixels, including margins. Default to 65 pixels for each item on the “y” axis.
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_timeline
Eval scores by model, organization, and release date.
def scores_timeline(
data: Data,
task_name: str = ...,
model_name: str = ...,
model_organization: str = ...,
model_release_date: str = ...,
score_name: str = ...,
score_value: str = ...,
score_stderr: str = ...,
organizations: list[str] | None = ...,
filters: bool | list[Literal['task', 'organization']] = ...,
ci: float | bool | NotGiven = ...,
time_label: str = ...,
score_label: str = ...,
eval_label: str = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
width: float | Param | None = ...,
height: float | Param | None = ...,
regression: bool = ...,
legend: Legend | NotGiven | None = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Data read using evals_df() and amended with model metadata using the model_info() prepare operation (see Data Preparation for details).
task_namestr-
Column for task name (defaults to “task_display_name”).
model_namestr-
Column for model name (defaults to “model_display_name”).
model_organizationstr-
Column for model organization (defaults to “model_organization_name”).
model_release_datestr-
Column for model release date (defaults to “model_release_date”).
score_namestr-
Column for scorer name (defaults to “score_headline_name”).
score_valuestr-
Column for score value (defaults to “score_headline_value”).
score_stderrstr-
Column for score stderr (defaults to “score_headline_stderr”)
organizationslist[str] | None-
List of organizations to include (in order of desired presentation).
filtersbool | list[Literal['task', 'organization']]-
Provide UI to filter plot by task and organization(s).
cifloat | bool | NotGiven-
Confidence interval (defaults to 0.95, pass
Falsefor no confidence intervals) time_labelstr-
Label for time (x-axis).
score_labelstr-
Label for score (y-axis).
eval_labelstr-
Label for eval select input.
titlestr | Title | None-
Title for plot (
stror mark created with the title() function). marksMarks | None-
Additional marks to include in the plot.
widthfloat | Param | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
heightfloat | Param | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio)
regressionbool-
If
True, adds a regression line to the plot (uses the confidence interval passed using ci). Defaults to False. legendLegend | NotGiven | None-
Legend to use for the plot (defaults to
None, which uses the default legend). aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_by_model
Bar plot for comparing the scores of different models on a single evaluation.
Summarize eval scores using a bar plot. By default, scores (y) are plotted by “model_display_name” (y). By default, confidence intervals are also plotted (disable this with y_ci=False).
def scores_by_model(
data: Data,
*,
model_name: str = ...,
score_value: str = ...,
score_stderr: str = ...,
ci: float = ...,
sort: Literal['asc', 'desc'] | None = ...,
score_label: str | None | NotGiven = ...,
model_label: str | None | NotGiven = ...,
color: str | None = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
width: float | None = ...,
height: float | None = ...,
legend: Legend | NotGiven | None = ...,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table. This is typically created using a data frame read with the inspect evals_df() function.
model_namestr-
Column containing the model name (defaults to “model_display_name”)
score_valuestr-
Column containing the score value (defaults to “score_headline_value”).
score_stderrstr-
Column containing the score standard error (defaults to “score_headline_stderr”).
cifloat-
Confidence interval (e.g. 0.80, 0.90, 0.95, etc.). Defaults to 0.95.
sortLiteral['asc', 'desc'] | None-
Sort order for the bars (sorts using the ‘x’ value). Can be “asc” or “desc”. Defaults to “asc”.
score_labelstr | None | NotGiven-
x-axis label (defaults to None).
model_labelstr | None | NotGiven-
x-axis label (defaults to None).
colorstr | None-
The color for the bars. Defaults to “#416AD0”. Pass any valid hex color value.
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio)
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_heatmap
Creates a heatmap plot of success rate of eval data.
def scores_heatmap(
data: Data,
task_name: str = ...,
task_label: str | None | NotGiven = ...,
model_name: str = ...,
model_label: str | None | NotGiven = ...,
score_value: str = ...,
cell: CellOptions | None = ...,
tip: bool = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
height: float | None = ...,
width: float | None = ...,
legend: Legend | NotGiven | None = ...,
sort: Literal['ascending', 'descending'] | SortOrder | None = ...,
orientation: Literal['horizontal', 'vertical'] = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table.
task_namestr-
Name of column to use for columns.
task_labelstr | None | NotGiven-
x-axis label (defaults to None).
model_namestr-
Name of column to use for rows.
model_labelstr | None | NotGiven-
y-axis label (defaults to None).
score_valuestr-
Name of the column to use as values to determine cell color.
cellCellOptions | None-
Options for the cell marks.
tipbool-
Whether to show a tooltip with the value when hovering over a cell (defaults to True).
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio).
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
sortLiteral['ascending', 'descending'] | SortOrder | None-
Sort order for the x and y axes. If ascending, the highest values will be sorted to the top right. If descending, the highest values will appear in the bottom left. If None, no sorting is applied. If a SortOrder is provided, it will be used to sort the x and y axes.
orientationLiteral['horizontal', 'vertical']-
The orientation of the heatmap. If “horizontal”, the tasks will be on the x-axis and models on the y-axis. If “vertical”, the tasks will be on the y-axis and models on the x-axis.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_by_limit
Visualizes success rate as a function of a resource limit (time, tokens).
Model success rate is plotted as a function of the time, tokens, or other resource limit.
def scores_by_limit(
data: Data,
model: str = ...,
success: str = ...,
stderr: str | None = ...,
facet: str | None = ...,
other_termination_rate: str | bool = ...,
limit: str | None = ...,
limit_label: str | NotGiven = ...,
scale: Literal['log', 'linear', 'auto'] = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
height: float | None = ...,
width: float | None = ...,
legend: Legend | NotGiven | None = ...,
ci: float = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
A dataframe prepared using the
prepare_limit_dataframefunction. modelstr-
Name of field holding the model (defaults to “model_display_name”).
successstr-
Name of field containing the success rate (defaults to “success_rate”).
stderrstr | None-
Name of field containing the standard_error (defaults to “standard_error”).
facetstr | None-
Name of field to use for faceting (defaults to None).
other_termination_ratestr | bool-
Name of field containing the other termination rate (defaults to “other_termination_rate”).
limitstr | None-
Name of field for x axis (by default, will detect limit type using the columns present in the data frame).
limit_labelstr | NotGiven-
The limit label (by default, will select limit label using the columns present in the data frame). Pass None for no label.
scaleLiteral['log', 'linear', 'auto']-
The scale type for the limit access. If ‘auto’, will use log scale if the range is 2 or more orders of magnitude (defaults to ‘auto’).
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio)
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
cifloat-
Confidence interval (e.g. 0.80, 0.90, 0.95, etc.). Defaults to 0.95.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
scores_by_limit_df
Prepares a dataframe for plotting success rate as a function of a resource limit (time, tokens).
def scores_by_limit_df(
df: pd.DataFrame,
score: str,
limit: Literal["total_tokens", "total_time", "working_time"] = "total_tokens",
scale: Literal["log", "linear", "auto"] = "auto",
steps: int = 100,
) -> pd.DataFramedfpd.DataFrame-
A dataframe containing sample summaries and eval information.
scorestr-
Name of field containing the score (0 = fail, 1 = success).
limitLiteral['total_tokens', 'total_time', 'working_time']-
The resource limit to use (one of ‘total_tokens’, ‘total_time’, ‘working_time’). Defaults to ‘total_tokens’.
scaleLiteral['log', 'linear', 'auto']-
The scale type for the limit access. If ‘auto’, will use log scale if the range is 2 or more orders of magnitude (defaults to ‘auto’).
stepsint-
The number of points to use when sampling the limit range (defaults to 100).
Samples
sample_tool_calls
Heat map visualising tool calls over evaluation turns.
def sample_tool_calls(
data: Data,
x: str = ...,
y: str = ...,
tool: str = ...,
limit: str = ...,
tools: list[str] | None = ...,
x_label: str | None = ...,
y_label: str | None = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
width: float | None = ...,
height: float | None = ...,
legend: Legend | NotGiven | None = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Messages data table. This is typically created using a data frame read with the inspect messages_df() function.
xstr-
Name of field for x axis (defaults to “order”)
ystr-
Name of field for y axis (defaults to “id”).
toolstr-
Name of field with tool name (defaults to “tool_call_function”)
limitstr-
Name of field with sample limit (defaults to “limit”).
toolslist[str] | None-
Tools to include in plot (and order to include them). Defaults to all tools found in
data. x_labelstr | None-
x-axis label (defaults to “Message”).
y_labelstr | None-
y-axis label (defaults to “Sample”).
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio)
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
sample_heatmap
Creates a heatmap plot of success rate of eval data.
def sample_heatmap(
data: Data,
id: str = ...,
id_label: str | None | NotGiven = ...,
model_name: str = ...,
model_label: str | None | NotGiven = ...,
score_value: str | None = ...,
cell: CellOptions | None = ...,
tip: bool = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
height: float | None = ...,
width: float | None = ...,
legend: Legend | NotGiven | None = ...,
sort: Literal['ascending', 'descending'] | SortOrder | None = ...,
orientation: Literal['horizontal', 'vertical'] = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table.
idstr-
Name of column to use for displaying the sample id.
id_labelstr | None | NotGiven-
x-axis label (defaults to None).
model_namestr-
Name of column to use for rows.
model_labelstr | None | NotGiven-
y-axis label (defaults to None).
score_valuestr | None-
Name of the column to use as values to determine cell color.
cellCellOptions | None-
Options for the cell marks.
tipbool-
Whether to show a tooltip with the value when hovering over a cell (defaults to True).
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio).
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
sortLiteral['ascending', 'descending'] | SortOrder | None-
Sort order for the x and y axes. If ascending, the highest values will be sorted to the top right. If descending, the highest values will appear in the bottom left. If None, no sorting is applied. If a SortOrder is provided, it will be used to sort the x and y axes.
orientationLiteral['horizontal', 'vertical']-
The orientation of the heatmap. If “horizontal”, the tasks will be on the x-axis and models on the y-axis. If “vertical”, the tasks will be on the y-axis and models on the x-axis.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
General
heatmap
Creates a heatmap plot of arbitrary data.
def heatmap(
data: Data,
x_value: str = ...,
x_label: str | None | NotGiven = ...,
y_value: str = ...,
y_label: str | None | NotGiven = ...,
color_value: str | None = ...,
channels: dict[str, Any] | None = ...,
cell: CellOptions | None = ...,
tip: bool = ...,
title: str | Title | None = ...,
marks: Marks | None = ...,
height: float | None = ...,
width: float | None = ...,
legend: Legend | NotGiven | None = ...,
sort: Literal['ascending', 'descending'] | SortOrder | None = ...,
orientation: Literal['horizontal', 'vertical'] = ...,
*,
aspect_ratio: float | bool | None | Param | None = ...,
margin: float | Param | None = ...,
margin_top: float | Param | None = ...,
margin_right: float | Param | None = ...,
margin_bottom: float | Param | None = ...,
margin_left: float | Param | None = ...,
margins: dict[str, float | Param] | None = ...,
inset: float | Param | None = ...,
style: str | dict[str, str] | None | Param = ...,
align: float | Param | None = ...,
padding: float | Param | None = ...,
axis: Literal['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param = ...,
grid: bool | str | Param = ...,
aria_label: str | None = ...,
aria_description: str | None = ...,
clip: Literal['frame', 'sphere'] | bool | None | Param = ...,
x_scale: PositionScale | None | Param | None = ...,
x_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
x_range: Sequence[str | float | bool] | Param | None = ...,
x_nice: bool | float | Interval | Param | None = ...,
x_inset: float | Param | None = ...,
x_inset_right: float | Param | None = ...,
x_inset_left: float | Param | None = ...,
x_clamp: bool | Param | None = ...,
x_round: bool | Param | None = ...,
x_align: float | Param | None = ...,
x_padding: float | Param | None = ...,
x_padding_inner: float | Param | None = ...,
x_padding_outer: float | Param | None = ...,
x_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
x_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
x_tick_size: float | Param | None = ...,
x_tick_spacing: float | Param | None = ...,
x_tick_padding: float | Param | None = ...,
x_tick_format: str | None | Param | None = ...,
x_tick_rotate: float | Param | None = ...,
x_grid: bool | str | Interval | list[str | float] | Param = ...,
x_line: bool | Param | None = ...,
x_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
x_label_arrow: LabelArrow | Param | None = ...,
x_label_offset: float | Param | None = ...,
x_font_variant: str | Param | None = ...,
x_aria_label: str | Param | None = ...,
x_aria_description: str | Param | None = ...,
x_percent: bool | Param | None = ...,
x_reverse: bool | Param | None = ...,
x_zero: bool | Param | None = ...,
x_exponent: float | Param | None = ...,
x_base: float | Param | None = ...,
x_constant: float | Param | None = ...,
y_scale: PositionScale | None | Param | None = ...,
y_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
y_range: Sequence[str | float | bool] | Param | None = ...,
y_nice: bool | float | Interval | Param | None = ...,
y_inset: float | Param | None = ...,
y_inset_top: float | Param | None = ...,
y_inset_bottom: float | Param | None = ...,
y_clamp: bool | Param | None = ...,
y_round: bool | Param | None = ...,
y_align: float | Param | None = ...,
y_padding: float | Param | None = ...,
y_padding_inner: float | Param | None = ...,
y_padding_outer: float | Param | None = ...,
y_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
y_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
y_tick_size: float | Param | None = ...,
y_tick_spacing: float | Param | None = ...,
y_tick_padding: float | Param | None = ...,
y_tick_format: str | None | Param | None = ...,
y_tick_rotate: float | Param | None = ...,
y_grid: bool | str | Interval | list[str | float] | Param = ...,
y_line: bool | Param | None = ...,
y_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
y_label_arrow: LabelArrow | Param | None = ...,
y_label_offset: float | Param | None = ...,
y_font_variant: str | Param | None = ...,
y_aria_label: str | Param | None = ...,
y_aria_description: str | Param | None = ...,
y_percent: bool | Param | None = ...,
y_reverse: bool | Param | None = ...,
y_zero: bool | Param | None = ...,
y_exponent: float | Param | None = ...,
y_base: float | Param | None = ...,
y_constant: float | Param | None = ...,
xy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
facet_margin: float | Param | None = ...,
facet_margin_top: float | Param | None = ...,
facet_margin_bottom: float | Param | None = ...,
facet_margin_left: float | Param | None = ...,
facet_margin_right: float | Param | None = ...,
facet_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
facet_label: str | None | Param | None = ...,
fx_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fx_range: Sequence[str | float | bool] | Param | None = ...,
fx_inset: float | Param | None = ...,
fx_inset_right: float | Param | None = ...,
fx_inset_left: float | Param | None = ...,
fx_round: bool | Param | None = ...,
fx_align: float | Param | None = ...,
fx_padding: float | Param | None = ...,
fx_padding_inner: float | Param | None = ...,
fx_padding_outer: float | Param | None = ...,
fx_axis: Literal['top', 'bottom', 'both'] | bool | None | Param | None = ...,
fx_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_tick_size: float | Param | None = ...,
fx_tick_spacing: float | Param | None = ...,
fx_tick_padding: float | Param | None = ...,
fx_tick_format: str | None | Param | None = ...,
fx_tick_rotate: float | Param | None = ...,
fx_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fx_line: bool | Param | None = ...,
fx_label_anchor: Literal['right', 'left', 'center'] | Param | None = ...,
fx_label_offset: float | Param | None = ...,
fx_font_variant: str | Param | None = ...,
fx_aria_label: str | Param | None = ...,
fx_aria_description: str | Param | None = ...,
fx_reverse: bool | Param | None = ...,
fy_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
fy_range: Sequence[str | float | bool] | Param | None = ...,
fy_inset: float | Param | None = ...,
fy_inset_top: float | Param | None = ...,
fy_inset_bottom: float | Param | None = ...,
fy_round: bool | Param | None = ...,
fy_align: float | Param | None = ...,
fy_padding: float | Param | None = ...,
fy_padding_inner: float | Param | None = ...,
fy_padding_outer: float | Param | None = ...,
fy_axis: Literal['left', 'right', 'both'] | bool | None | Param | None = ...,
fy_ticks: float | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_tick_size: float | Param | None = ...,
fy_tick_spacing: float | Param | None = ...,
fy_tick_padding: float | Param | None = ...,
fy_tick_format: str | None | Param | None = ...,
fy_tick_rotate: float | Param | None = ...,
fy_grid: bool | str | Interval | Sequence[str | float | bool] | Param | None = ...,
fy_line: bool | Param | None = ...,
fy_label_anchor: Literal['top', 'bottom', 'center'] | Param | None = ...,
fy_label_offset: float | Param | None = ...,
fy_font_variant: str | Param | None = ...,
fy_aria_label: str | Param | None = ...,
fy_aria_description: str | Param | None = ...,
fy_reverse: bool | Param | None = ...,
color_scale: ColorScale | None | Param | None = ...,
color_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
color_range: Sequence[str | float | bool] | Param | None = ...,
color_clamp: bool | Param | None = ...,
color_n: float | Param | None = ...,
color_nice: bool | float | Interval | Param | None = ...,
color_scheme: ColorScheme | Param | None = ...,
color_interpolate: Interpolate | Param | None = ...,
color_pivot: Any | Param | None = ...,
color_symmetric: bool | Param | None = ...,
color_label: str | None | Param | None = ...,
color_percent: bool | Param | None = ...,
color_reverse: bool | Param | None = ...,
color_zero: bool | Param | None = ...,
color_tick_format: str | None | Param | None = ...,
color_exponent: float | Param | None = ...,
color_base: float | Param | None = ...,
color_constant: float | Param | None = ...,
opacity_scale: ContinuousScale | None | Param | None = ...,
opacity_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
opacity_range: Sequence[str | float | bool] | Param | None = ...,
opacity_clamp: bool | Param | None = ...,
opacity_nice: bool | float | Interval | Param | None = ...,
opacity_label: str | None | Param | None = ...,
opacity_percent: bool | Param | None = ...,
opacity_reverse: bool | Param | None = ...,
opacity_zero: bool | Param | None = ...,
opacity_tick_format: str | None | Param | None = ...,
opacity_exponent: float | Param | None = ...,
opacity_base: float | Param | None = ...,
opacity_constant: float | Param | None = ...,
symbol_scale: Literal['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param = ...,
symbol_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
symbol_range: Sequence[str | float | bool] | Param | None = ...,
r_scale: ContinuousScale | None | Param | None = ...,
r_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
r_range: Sequence[str | float | bool] | Param | None = ...,
r_clamp: Any | None = ...,
r_nice: bool | float | Interval | Param | None = ...,
r_label: str | None | Param | None = ...,
r_percent: bool | Param | None = ...,
r_zero: bool | Param | None = ...,
r_exponent: float | Param | None = ...,
r_base: float | Param | None = ...,
r_constant: float | Param | None = ...,
length_scale: ContinuousScale | None | Param | None = ...,
length_domain: Literal['fixed'] | Sequence[str | float | bool] | Param | None = ...,
length_range: Sequence[str | float | bool] | Param | None = ...,
length_clamp: Any | None = ...,
length_nice: bool | float | Interval | Param | None = ...,
length_percent: bool | Param | None = ...,
length_zero: bool | Param | None = ...,
length_exponent: float | Param | None = ...,
length_base: float | Param | None = ...,
length_constant: float | Param | None = ...,
projection_type: Projection | None | Param | None = ...,
projection_domain: object | Param | None = ...,
projection_rotate: Sequence[float | Param] | Param | None = ...,
projection_parallels: Sequence[float | Param] | Param | None = ...,
projection_precision: float | Param | None = ...,
projection_clip: bool | float | Literal['frame'] | None | Param | None = ...,
projection_inset: float | Param | None = ...,
projection_inset_top: float | Param | None = ...,
projection_inset_right: float | Param | None = ...,
projection_inset_bottom: float | Param | None = ...,
projection_inset_left: float | Param | None = ...,
) -> ComponentdataData-
Evals data table.
x_valuestr-
x-axis value
x_labelstr | None | NotGiven-
x-axis label (defaults to None).
y_valuestr-
y axis value
y_labelstr | None | NotGiven-
y-axis label (defaults to None).
color_valuestr | None-
Name of the column to use as values to determine cell color.
channelsdict[str, Any] | None-
Channels to use for the plot. If None, the default channels are used.
cellCellOptions | None-
Options for the cell marks.
tipbool-
Whether to show a tooltip with the value when hovering over a cell (defaults to True).
titlestr | Title | None-
Title for plot (
stror mark created with the title() function) marksMarks | None-
Additional marks to include in the plot.
heightfloat | None-
The outer height of the plot in pixels, including margins. The default is width / 1.618 (the golden ratio).
widthfloat | None-
The outer width of the plot in pixels, including margins. Defaults to 700.
legendLegend | NotGiven | None-
Options for the legend. Pass None to disable the legend.
sortLiteral['ascending', 'descending'] | SortOrder | None-
Sort order for the x and y axes. If ascending, the highest values will be sorted to the top right. If descending, the highest values will appear in the bottom left. If None, no sorting is applied. If a SortOrder is provided, it will be used to sort the x and y axes.
orientationLiteral['horizontal', 'vertical']-
The orientation of the heatmap. If “horizontal”, the tasks will be on the x-axis and models on the y-axis. If “vertical”, the tasks will be on the y-axis and models on the x-axis.
aspect_ratiofloat | bool | None | Param | None-
The desired aspect ratio of the x and y scales, affecting the default height. Given an aspect ratio of dx / dy, and assuming that the x and y scales represent equivalent units (say, degrees Celsius or meters), computes a default height such that dx pixels along x represents the same variation as dy pixels along y. Note: when faceting, set the fx and fy scales’ round option to false for an exact aspect ratio.
marginfloat | Param | None-
Shorthand to set the same default for all four margins: margin_top, margin_right, margin_bottom, and margin_left. Otherwise, the default margins depend on the maximum margins of the plot’s marks. While most marks default to zero margins (because they are drawn inside the chart area), Plot’s axis marks have non-zero default margins.
margin_topfloat | Param | None-
The top margin; the distance in pixels between the top edges of the inner and outer plot area. Defaults to the maximum top margin of the plot’s marks.
margin_rightfloat | Param | None-
The right margin; the distance in pixels between the right edges of the inner and outer plot area. Defaults to the maximum right margin of the plot’s marks.
margin_bottomfloat | Param | None-
The bottom margin; the distance in pixels between the bottom edges of the inner and outer plot area. Defaults to the maximum bottom margin of the plot’s marks.
margin_leftfloat | Param | None-
The left margin; the distance in pixels between the left edges of the inner and outer plot area. Defaults to the maximum left margin of the plot’s marks.
marginsdict[str, float | Param] | None-
A shorthand object notation for setting multiple margin values. The object keys are margin names (top, right, etc).
insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
stylestr | dict[str, str] | None | Param-
Custom styles to override Plot’s defaults. Styles may be specified either as a string of inline styles (e.g.,
"color: red;", in the same fashion as assigning element.style) or an object of properties (e.g.,{color: "red"}, in the same fashion as assigning element.style properties). Note that unitless numbers (quirky lengths) such as{padding: 20}may not supported by some browsers; you should instead specify a string with units such as{padding: "20px"}. By default, the returned plot has a max-width of 100%, and the system-ui font. Plot’s marks and axes default to currentColor, meaning that they will inherit the surrounding content’s color. alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
axisLiteral['top', 'right', 'bottom', 'left', 'both'] | bool | None | Param-
The side of the frame on which to place the implicit axis: top or bottom for x or fx, or left or right for y or fy. The default depends on the scale:
- x - bottom
- y - left
- fx - top if there is a bottom x axis, and otherwise bottom
- fy - right if there is a left y axis, and otherwise right
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x or fx, or left and right for y or fy). If null, the implicit axis is suppressed.
For position axes only.
gridbool | str | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color.
aria_labelstr | None-
The aria-label attribute on the SVG root.
aria_descriptionstr | None-
The aria-description attribute on the SVG root.
clipLiteral['frame', 'sphere'] | bool | None | Param-
The default clip for all marks.
x_scalePositionScale | None | Param | None-
The x scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal. However, the radius scale defaults to sqrt, and the length and opacity scales default to linear; these scales are intended for quantitative data. The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
x_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
x_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
x_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
x_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
x_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
x_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
x_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
x_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
x_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
x_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
x_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
x_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
x_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for x. Defaults to bottom for an x scale.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for x). If null, the implicit axis is suppressed.
x_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
x_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
x_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
x_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by x_tick_size and x_tick_rotate.
x_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
x_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
x_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
x_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
x_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
x_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
x_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
x_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
x_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
x_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
x_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
x_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
x_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
x_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
x_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
x_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
y_scalePositionScale | None | Param | None-
The y scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, The plot’s marks may also impose a scale type; for example, the barY mark requires that x is a band scale.
y_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero.
y_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
y_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
y_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
y_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
y_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
y_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
y_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
y_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
y_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
y_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
y_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
y_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for y. Defaults to left for a y scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for y). If null, the implicit axis is suppressed.
y_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
y_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
y_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
y_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by y_tick_size and y_tick_rotate.
y_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
y_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
y_gridbool | str | Interval | list[str | float] | Param-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines.
y_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
y_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
y_label_arrowLabelArrow | Param | None-
Whether to apply a directional arrow such as → or ↑ to the x-axis scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.
y_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
y_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
y_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
y_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
y_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
y_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range. Note that by default, when the y scale is continuous, the max value points to the top of the screen, whereas ordinal values are ranked from top to bottom.
y_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
y_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
y_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
y_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
xy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
Set the x and y scale domains.
facet_marginfloat | Param | None-
Shorthand to set the same default for all four facet margins: margin_top, margin_right, margin_bottom, and margin_left.
facet_margin_topfloat | Param | None-
The top facet margin; the (minimum) distance in pixels between the top edges of the inner and outer plot area.
facet_margin_bottomfloat | Param | None-
The right facet margin; the (minimum) distance in pixels between the right edges of the inner and outer plot area.
facet_margin_leftfloat | Param | None-
The bottom facet margin; the (minimum) distance in pixels between the bottom edges of the inner and outer plot area.
facet_margin_rightfloat | Param | None-
The left facet margin; the (minimum) distance in pixels between the left edges of the inner and outer plot area.
facet_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Default axis grid for fx and fy scales; typically set to true to enable.
facet_labelstr | None | Param | None-
Default axis label for fx and fy scales; typically set to null to disable.
fx_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fx_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fx_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fx_inset_rightfloat | Param | None-
Insets the right edge by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
fx_inset_leftfloat | Param | None-
Insets the left edge by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
fx_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fx_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fx_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fx_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fx_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fx_axisLiteral['top', 'bottom', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: top or bottom for fx. Defaults to top if there is a bottom x axis, and otherwise bottom.
If both, an implicit axis will be rendered on both sides of the plot (top and bottom for fx). If null, the implicit axis is suppressed.
fx_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fx_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fx_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fx_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fx_tick_size and fx_tick_rotate.
fx_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fx_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fx_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fx_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fx_label_anchorLiteral['right', 'left', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fx_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fx_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fx_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fx_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fx_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
fy_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
fy_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and the plot’s dimensions. For ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale.
fy_insetfloat | Param | None-
Shorthand to set the same default for all four insets: inset_top, inset_right, inset_bottom, and inset_left. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.
fy_inset_topfloat | Param | None-
Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
fy_inset_bottomfloat | Param | None-
Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
fy_roundbool | Param | None-
If true, round the output value to the nearest integer (pixel); useful for crisp edges when rendering.
For position scales only.
fy_alignfloat | Param | None-
How to distribute unused space in the range for point and band scales. A number in [0, 1], such as:
- 0 - use the start of the range, putting unused space at the end
- 0.5 (default) - use the middle, distributing unused space evenly
- 1 use the end, putting unused space at the start
For ordinal position scales only.
fy_paddingfloat | Param | None-
For band scales, how much of the range to reserve to separate adjacent bands; defaults to 0.1 (10%). For point scales, the amount of inset for the first and last value as a proportion of the bandwidth; defaults to 0.5 (50%).
For ordinal position scales only.
fy_padding_innerfloat | Param | None-
For a band scale, how much of the range to reserve to separate adjacent bands.
fy_padding_outerfloat | Param | None-
For a band scale, how much of the range to reserve to inset first and last bands.
fy_axisLiteral['left', 'right', 'both'] | bool | None | Param | None-
The side of the frame on which to place the implicit axis: left or right for fy. Defaults to left for an fy scale.
If both, an implicit axis will be rendered on both sides of the plot (left and right for fy). If null, the implicit axis is suppressed.
fy_ticksfloat | Interval | Sequence[str | float | bool] | Param | None-
The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.
fy_tick_sizefloat | Param | None-
The length of axis tick marks in pixels; negative values extend in the opposite direction. Defaults to 6 for x and y axes and color and opacity ramp legends, and 0 for fx and fy axes.
fy_tick_spacingfloat | Param | None-
The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.
fy_tick_paddingfloat | Param | None-
The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by fy_tick_size and fy_tick_rotate.
fy_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
fy_tick_rotatefloat | Param | None-
The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
fy_gridbool | str | Interval | Sequence[str | float | bool] | Param | None-
Whether to show a grid aligned with the scale’s ticks. If true, show a grid with the currentColor stroke; if a string, show a grid with the specified stroke color; if an approximate number of ticks, an interval, or an array of tick values, show corresponding grid lines. See also the grid mark.
For axes only.
fy_linebool | Param | None-
If true, draw a line along the axis; if false (default), do not.
fy_label_anchorLiteral['top', 'bottom', 'center'] | Param | None-
Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.
fy_label_offsetfloat | Param | None-
The axis label position offset (in pixels); default depends on margins and orientation.
fy_font_variantstr | Param | None-
The font-variant attribute for axis ticks; defaults to tabular-nums for quantitative axes.
fy_aria_labelstr | Param | None-
A short label representing the axis in the accessibility tree.
fy_aria_descriptionstr | Param | None-
A textual description for the axis in the accessibility tree.
fy_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_scaleColorScale | None | Param | None-
The color scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled.
For quantitative data (numbers), defaults to linear; for temporal data (dates), defaults to utc; for ordinal data (strings or booleans), defaults to point for position scales, categorical for color scales, and otherwise ordinal.
color_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
color_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain. For other ordinal data, it is an array (or iterable) of output values in the same order as the domain.
color_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
color_nfloat | Param | None-
For a quantile scale, the number of quantiles (creates n - 1 thresholds); for a quantize scale, the approximate number of thresholds; defaults to 5.
color_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
color_schemeColorScheme | Param | None-
If specified, shorthand for setting the color_range or color_interpolate option of a color scale.
color_interpolateInterpolate | Param | None-
How to interpolate color range values. For quantitative scales only. This attribute can be used to specify a color space for interpolating colors specified in the color_range.
color_pivotAny | Param | None-
For a diverging color scale, the input value (abstract value) that divides the domain into two parts; defaults to 0 for diverging scales, dividing the domain into negative and positive parts; defaults to 1 for diverging-log scales. By default, diverging scales are symmetric around the pivot; see the symmetric option.
color_symmetricbool | Param | None-
For a diverging color scale, if true (the default), extend the domain to ensure that the lower part of the domain (below the pivot) is commensurate with the upper part of the domain (above the pivot).
A symmetric diverging color scale may not use all of its output range; this reduces contrast but ensures that deviations both below and above the pivot are represented proportionally. Otherwise if false, the full output range will be used; this increases contrast but values on opposite sides of the pivot may not be meaningfully compared.
color_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
color_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
color_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
color_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
color_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
color_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow and diverging-pow scales only.
color_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log and diverging-log scales only.
color_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog and diverging-symlog scales only.
opacity_scaleContinuousScale | None | Param | None-
The opacity scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The opacity scale defaults to linear; this scales is intended for quantitative data.
opacity_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Opacity scales have a default domain from 0 to the maximum value of associated channels.
opacity_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values).
Opacity scales have a default range of [0, 1].
opacity_clampbool | Param | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
opacity_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
opacity_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
For axes and legends only.
opacity_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
opacity_reversebool | Param | None-
Whether to reverse the scale’s encoding; equivalent to reversing either the domain or range.
opacity_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
opacity_tick_formatstr | None | Param | None-
How to format inputs (abstract values) for axis tick labels; one of:
- a d3-format string for numeric scales
- a d3-time-format string for temporal scales
opacity_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
opacity_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
opacity_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
symbol_scaleLiteral['ordinal', 'categorical', 'threshold', 'quantile', 'quantize'] | None | Param-
The symbol scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. Defaults to an ordinal scale type.
symbol_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. As symbol scales are discrete, the domain is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
symbol_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Symbol scales have a default range of categorical symbols; the choice of symbols depends on whether the associated dot mark is filled or stroked.
r_scaleContinuousScale | None | Param | None-
The r (radius) scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The radius scale defaults to sqrt; this scale is intended for quantitative data.
r_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Radius scales have a default domain from 0 to the median first quartile of associated channels.
r_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Radius scales have a default range of [0, 3].
r_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
r_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
r_labelstr | None | Param | None-
A textual label to show on the axis or legend; if null, show no label. By default the scale label is inferred from channel definitions, possibly with an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
r_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
r_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
r_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
r_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
r_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
length_scaleContinuousScale | None | Param | None-
The length scale type, affecting how the scale encodes abstract data, say by applying a mathematical transformation. If null, the scale is disabled. The length scale defaults to linear, as this scale is intended for quantitative data.
length_domainLiteral['fixed'] | Sequence[str | float | bool] | Param | None-
The extent of the scale’s inputs (abstract values). By default inferred from channel values. For continuous data (numbers and dates), it is typically [min, max]; it can be [max, min] to reverse the scale. For ordinal data (strings or booleans), it is an array (or iterable) of values is the desired order, defaulting to natural ascending order.
Linear scales have a default domain of [0, 1]. Log scales have a default domain of [1, 10] and cannot include zero. Radius scales have a default domain from 0 to the median first quartile of associated channels. Length have a default domain from 0 to the median median of associated channels. Opacity scales have a default domain from 0 to the maximum value of associated channels.
length_rangeSequence[str | float | bool] | Param | None-
The extent of the scale’s outputs (visual values). By default inferred from the scale’s type and domain, and for position scales, the plot’s dimensions. For continuous data (numbers and dates), and for ordinal position scales (point and band), it is typically [min, max]; it can be [max, min] to reverse the scale. For other ordinal data, such as for a color scale, it is an array (or iterable) of output values in the same order as the domain.
Length scales have a default range of [0, 12].
length_clampAny | None-
If true, values below the domain minimum are treated as the domain minimum, and values above the domain maximum are treated as the domain maximum.
Clamping is useful for focusing on a subset of the data while ensuring that extreme values remain visible, but use caution: clamped values may need an annotation to avoid misinterpretation. Clamping typically requires setting an explicit domain since if the domain is inferred, no values will be outside the domain.
For continuous scales only.
length_nicebool | float | Interval | Param | None-
If true, or a tick count or interval, extend the domain to nice round values. Defaults to 1, 2 or 5 times a power of 10 for linear scales, and nice time intervals for utc and time scales. Pass an interval such as minute, wednesday or month to specify what constitutes a nice interval.
For continuous scales only.
length_percentbool | Param | None-
If true, shorthand for a transform suitable for percentages, mapping proportions in [0, 1] to [0, 100].
length_zerobool | Param | None-
Whether the domain must include zero. If the domain minimum is positive, it will be set to zero; otherwise if the domain maximum is negative, it will be set to zero.
For quantitative scales only.
length_exponentfloat | Param | None-
A power scale’s exponent (e.g., 0.5 for sqrt); defaults to 1 for a linear scale. For pow scales only.
length_basefloat | Param | None-
A log scale’s base; defaults to 10. Does not affect the scale’s encoding, but rather the default ticks. For log scales only.
length_constantfloat | Param | None-
A symlog scale’s constant, expressing the magnitude of the linear region around the origin; defaults to 1. For symlog scales only.
projection_typeProjection | None | Param | None-
The desired projection; one of:
- a named built-in projection such as albers-usa
- null, for no projection
Named projections are scaled and translated to fit the domain to the plot’s frame (minus insets).
projection_domainobject | Param | None-
A GeoJSON object to fit to the plot’s frame (minus insets); defaults to a Sphere for spherical projections (outline of the the whole globe).
projection_rotateSequence[float | Param] | Param | None-
A rotation of the sphere before projection; defaults to [0, 0, 0]. Specified as Euler angles λ (yaw, or reference longitude), φ (pitch, or reference latitude), and optionally γ (roll), in degrees.
projection_parallelsSequence[float | Param] | Param | None-
The standard parallels. For conic projections only.
projection_precisionfloat | Param | None-
The projection’s sampling threshold.
projection_clipbool | float | Literal['frame'] | None | Param | None-
The projection’s clipping method; one of:
- frame or true (default) - clip to the plot’s frame (including margins but not insets)
- a number - clip to a circle of the given radius in degrees centered around the origin
- null or false - do not clip
Some projections (such as armadillo and berghaus) require spherical clipping: in that case set the marks’ clip option to sphere.
projection_insetfloat | Param | None-
Shorthand to set the same default for all four projection insets. All insets typically default to zero, though not always. A positive inset reduces effective area, while a negative inset increases it.
projection_inset_topfloat | Param | None-
Insets the top edge of the projection by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).
projection_inset_rightfloat | Param | None-
Insets the right edge of the projection by the specified number of pixels. A positive value insets towards the left edge (reducing effective area), while a negative value insets away from the left edge (increasing it).
projection_inset_bottomfloat | Param | None-
Insets the bottom edge of the projection by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).
projection_inset_leftfloat | Param | None-
Insets the left edge of the projection by the specified number of pixels. A positive value insets towards the right edge (reducing effective area), while a negative value insets away from the right edge (increasing it).
Types
CellOptions
Cell options for the heatmap.
class CellOptions(TypedDict, total=False)