Skip to main content

YAxis

Auto-generated from the config schema in the source. See the config guide for concepts. Built into JBrowse core. View source.

A YChannel's axis, the guide it draws: whether it draws at all, its title and grid.

Example usage

{
  type: 'LinearAlignmentsDisplay',
  coverage: { encoding: { y: { axis: { title: 'depth', grid: true } } } },
}

Config slots

A setting written to it names members one by one: a member left out stays as it is, and null resets one. Slot types (fileLocation, frozen, ...) are explained in the config slot types reference. Slots a base configuration contributes are listed here too, so this table is the whole surface.

Slot Description
show
boolean = true		 Draw the axis, Vega-Lite's axis: null when off: its ticks and labels, the [min, max] caption a short band takes instead, its title and its grid. The scale's rules still draw.
title
maybeString		 The caption beside the axis, drawn once however many bands the scale rules. Unset, "" or null draws none.
grid
boolean = false		 Rule the plot across at every tick, Vega-Lite's axis.grid. The axis panel's "Grid lines" toggles it.