genome_spy.LayerChart

class genome_spy.LayerChart(layer=Undefined, *, assembly=Undefined, axes=Undefined, background=Undefined, baseUrl=Undefined, config=Undefined, cursor=Undefined, data=Undefined, datasets=Undefined, description=Undefined, domainInert=Undefined, encoding=Undefined, genome=Undefined, genomes=Undefined, height=Undefined, legends=Undefined, name=Undefined, opacity=Undefined, overhang=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, scales=Undefined, templates=Undefined, theme=Undefined, title=Undefined, transform=Undefined, view=Undefined, viewportHeight=Undefined, viewportWidth=Undefined, visible=Undefined, width=Undefined, zindex=Undefined, schema_url=None)View on GitHub

Bases: LayerPropertiesMixin, _CompositionSpec, LayerSpec

A layered GenomeSpy specification.

Methods

add_params(*params)	Return a chart with parameter declarations appended.
axes(value)	Return a copy with axes updated.
baseUrl(value)	Return a copy with baseUrl updated.
config([value, arrow, axis, axisBottom, ...])	Return a copy with a GenomeSpyConfig config.
configure([value, arrow, axis, axisBottom, ...])	Return a chart with merged top-level config.
configure_arrow([value, buildIndex, clip, ...])	Return a chart with arrow config updated.
configure_axis([value, chromGrid, ...])	Return a chart with axis config updated.
configure_axis_bottom([value, chromGrid, ...])	Return a chart with axisBottom config updated.
configure_axis_index([value, chromGrid, ...])	Return a chart with axisIndex config updated.
configure_axis_left([value, chromGrid, ...])	Return a chart with axisLeft config updated.
configure_axis_locus([value, chromGrid, ...])	Return a chart with axisLocus config updated.
configure_axis_nominal([value, chromGrid, ...])	Return a chart with axisNominal config updated.
configure_axis_ordinal([value, chromGrid, ...])	Return a chart with axisOrdinal config updated.
configure_axis_quantitative([value, ...])	Return a chart with axisQuantitative config updated.
configure_axis_right([value, chromGrid, ...])	Return a chart with axisRight config updated.
configure_axis_top([value, chromGrid, ...])	Return a chart with axisTop config updated.
configure_axis_x([value, chromGrid, ...])	Return a chart with axisX config updated.
configure_axis_y([value, chromGrid, ...])	Return a chart with axisY config updated.
configure_legend([value, backgroundFill, ...])	Return a chart with legend config updated.
configure_legend_track([value, ...])	Return a chart with legendTrack config updated.
configure_link([value, arcFadingDistance, ...])	Return a chart with link config updated.
configure_mark([value, buildIndex, clip, ...])	Return a chart with mark config updated.
configure_point([value, angle, buildIndex, ...])	Return a chart with point config updated.
configure_range([value, angle, diverging, ...])	Return a chart with range config updated.
configure_rect([value, buildIndex, clip, ...])	Return a chart with rect config updated.
configure_rule([value, buildIndex, clip, ...])	Return a chart with rule config updated.
configure_scale([value, align, assembly, ...])	Return a chart with scale config updated.
configure_style(value)	Return a chart with style config updated.
configure_text([value, align, angle, ...])	Return a chart with text config updated.
configure_tick([value, buildIndex, clip, ...])	Return a chart with tick config updated.
configure_title([value, align, anchor, ...])	Return a chart with title config updated.
configure_view([value, continuousHeight, ...])	Return a chart with view config updated.
copy(*[, deep, assembly, axes, background, ...])	Return a copy with updated top-level properties.
cursor([value, expr])	Return a copy with a ExprRef cursor.
data(value)	Return a copy with data updated.
datasets(value)	Return a copy with datasets updated.
description(value)	Return a copy with description updated.
display(*[, bundle_url, embed_options, ...])	Display this chart once with temporary rendering options.
domainInert(value)	Return a copy with domainInert updated.
encode(*args[, angle, color, direction, dx, ...])	Return a new specification with merged channel encodings.
encoding([value, angle, color, direction, ...])	Return a copy with a Encoding encoding.
from_dict(spec, *[, validate])	Construct a renderable chart from a GenomeSpy specification.
from_json(json_string, *[, validate])	Construct a renderable chart from a JSON specification.
height([value, grow, maxPx, minPx, px])	Return a copy with a SizeDef height.
layer(value)	Return a copy with layer updated.
legends(value)	Return a copy with legends updated.
name(value)	Return a copy with name updated.
opacity(value)	Return a copy with opacity updated.
overhang([value, bottom, left, right, top])	Return a copy with a OverhangConfig overhang.
padding(value)	Return a copy with padding updated.
params(value)	Return a copy with params updated.
properties(*[, assembly, axes, background, ...])	Return a new specification with updated top-level properties.
resolve(value)	Return a copy with resolve updated.
resolve_axis(*[, angle, color, default, ...])	Return a copy with merged axis resolutions.
resolve_legend(*[, angle, color, default, ...])	Return a copy with merged legend resolutions.
resolve_references()	Return this class schema with referenced properties merged in.
resolve_scale(*[, angle, color, default, ...])	Return a copy with merged scale resolutions.
save(path, *[, format, bundle_url, ...])	Save the chart as JSON or HTML.
scales(value)	Return a copy with scales updated.
templates(value)	Return a copy with templates updated.
title([value, align, anchor, angle, ...])	Return a copy with a Title title.
to_dict(*[, include_schema, validate])	Serialize the spec to a JSON-compatible dictionary.
to_html(*[, bundle_url, embed_options, ...])	Render the chart as an HTML snippet.
to_json(*[, include_schema, validate])	Serialize the spec to formatted JSON.
transform(*transforms)	Add one or more arbitrary GenomeSpy transforms.
transform_aggregate(*[, as_, description, ...])	Add a aggregate transform.
transform_alignment_mismatches(*[, cigar, ...])	Add a alignmentMismatches transform.
transform_axis_label_layout(*, channel, ...)	Add a axisLabelLayout transform.
transform_calculate([as_, calculate])	Add one or more formula transforms.
transform_collect(*[, description, groupby, ...])	Add a collect transform.
transform_coordinate_lookup(*, from_, key[, ...])	Add a coordinateLookup transform.
transform_coverage(*, end, start[, as_, ...])	Add a coverage transform.
transform_cross(*, from_[, description])	Add a cross transform.
transform_displace1d(*, length, pos[, as_, ...])	Add a displace1d transform.
transform_filter([expression, description, ...])	Add a filter transform.
transform_filter_scored_labels(*, pos, ...)	Add a filterScoredLabels transform.
transform_flatten([fields, as_, ...])	Add a flatten transform.
transform_flatten_cigar(*[, cigar, ...])	Add a flattenCigar transform.
transform_flatten_compressed_exons(*[, as_, ...])	Add a flattenCompressedExons transform.
transform_flatten_delimited(*, field, separator)	Add a flattenDelimited transform.
transform_flatten_sequence(*[, as_, ...])	Add a flattenSequence transform.
transform_formula(*, as_, expr[, description])	Add a formula transform.
transform_identifier(*[, as_, description])	Add a identifier transform.
transform_linearize_genomic_coordinate(*, ...)	Add a linearizeGenomicCoordinate transform.
transform_lookup(*, from_, key[, as_, ...])	Add a lookup transform.
transform_measure_text(*, as_, field, fontSize)	Add a measureText transform.
transform_merge_facets(*[, description])	Add a mergeFacets transform.
transform_pack_legend_labels(*, labelWidth)	Add a packLegendLabels transform.
transform_pileup(*, end, start[, as_, ...])	Add a pileup transform.
transform_project(*, fields[, as_, description])	Add a project transform.
transform_regex_extract(*, as_, field, regex)	Add a regexExtract transform.
transform_regex_fold(*, asValue, columnRegex)	Add a regexFold transform.
transform_sample([size, description])	Add a sample transform.
transform_set_intersection(*, element, set)	Add a setIntersection transform.
transform_stack(*, groupby[, as_, ...])	Add a stack transform.
transform_truncate_text(*, field, fontSize)	Add a truncateText transform.
transform_window(*, ops[, as_, description, ...])	Add a window transform.
validate(instance)	Validate an instance against this wrapper's schema.
view([value, fill, fillOpacity, shadowBlur, ...])	Return a copy with a ViewBackground view.
viewportHeight([value, grow, maxPx, minPx, px])	Return a copy with a SizeDef viewportHeight.
viewportWidth([value, grow, maxPx, minPx, px])	Return a copy with a SizeDef viewportWidth.
visible(value)	Return a copy with visible updated.
widget(*[, bundle_url, embed_options, ...])	Create a notebook widget for the spec.
width([value, grow, maxPx, minPx, px])	Return a copy with a SizeDef width.
with_config([value, arrow, axis, ...])	Return a copy with merged top-level config.
with_scales([value, angle, color, ...])	Return a copy with merged top-level scales.
with_view([value, fill, fillOpacity, ...])	Return a copy with merged top-level view.
zindex(value)	Return a copy with zindex updated.

Attributes

spec	Return the rendered GenomeSpy specification with JSON display.

add_params(*params)View on GitHub

Return a chart with parameter declarations appended.

Parameter handles are unwrapped only when the chart is serialized, so the same handle can also be reused in expressions, conditions, and filters.

Parameters:

*params – Parameter handles or generated parameter definitions.

Returns:

A new chart with the declarations appended in argument order.

Raises:

• TypeError – If an argument is not a parameter declaration.

• ValueError – If an explicit parameter name is declared twice.

Example

>>> import genome_spy as gs
>>> cutoff = gs.param("cutoff", value=0.5)
>>> gs.Chart().add_params(cutoff).to_dict(validate=False)["params"]
[{'name': 'cutoff', 'value': 0.5}]

axes(value)View on GitHub

Return a copy with axes updated.

baseUrl(value)View on GitHub

Return a copy with baseUrl updated.

config(value=Undefined, /, *, arrow=Undefined, axis=Undefined, axisBottom=Undefined, axisIndex=Undefined, axisLeft=Undefined, axisLocus=Undefined, axisNominal=Undefined, axisOrdinal=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTop=Undefined, axisX=Undefined, axisY=Undefined, legend=Undefined, legendTrack=Undefined, link=Undefined, mark=Undefined, point=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, style=Undefined, text=Undefined, tick=Undefined, title=Undefined, view=Undefined)View on GitHub

Return a copy with a GenomeSpyConfig config.

Parameters:

• arrow (ArrowConfig | dict[str, Any]) – Defaults for arrow marks.

• axis (AxisConfig | AxisConfigKwds) – Defaults shared by all axes.

• axisBottom (AxisConfig | AxisConfigKwds) – Defaults for bottom-oriented axes.

• axisIndex (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy index scales.

• axisLeft (AxisConfig | AxisConfigKwds) – Defaults for left-oriented axes.

• axisLocus (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy locus scales.

• axisNominal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize nominal data.

• axisOrdinal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize ordinal data.

• axisQuantitative (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize quantitative data.

• axisRight (AxisConfig | AxisConfigKwds) – Defaults for right-oriented axes.

• axisTop (AxisConfig | AxisConfigKwds) – Defaults for top-oriented axes.

• axisX (AxisConfig | AxisConfigKwds) – Defaults for x axes.

• axisY (AxisConfig | AxisConfigKwds) – Defaults for y axes.

• legend (LegendConfig | LegendConfigKwds) – Defaults shared by all legends. Set disable to true to suppress automatic legend creation by default.

• legendTrack (LegendConfig | LegendConfigKwds) – Defaults for legends of track-like views that use index or locus scales on the x channel. __Default value:__ { "style": "track-bottom-legend" }

• link (LinkConfig | LinkConfigKwds) – Defaults for link marks.

• mark (MarkConfig | MarkConfigKwds) – Defaults shared by all mark types.

• point (PointConfig | PointConfigKwds) – Defaults for point marks.

• range (RangeConfig | RangeConfigKwds) – Named reusable ranges for channels such as shape, size, and color.

• rect (RectConfig | RectConfigKwds) – Defaults for rect marks.

• rule (RuleConfig | RuleConfigKwds) – Defaults for rule marks.

• scale (ScaleConfig | ScaleConfigKwds) – Defaults for scale behavior and scale-type-specific buckets.

• style (dict[str, Any]) – Named reusable style buckets that marks, axes, legends, titles, and views can reference through their style properties.

• text (TextConfig | TextConfigKwds) – Defaults for text marks.

• tick (TickConfig | dict[str, Any]) – Defaults for tick marks.

• title (TitleConfig | TitleConfigKwds) – Defaults for view titles.

• view (ViewConfig | ViewConfigKwds) – Defaults for view background styling, including fill, stroke, shadow, and z-order properties.

configure(value=Undefined, /, *, arrow=Undefined, axis=Undefined, axisBottom=Undefined, axisIndex=Undefined, axisLeft=Undefined, axisLocus=Undefined, axisNominal=Undefined, axisOrdinal=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTop=Undefined, axisX=Undefined, axisY=Undefined, legend=Undefined, legendTrack=Undefined, link=Undefined, mark=Undefined, point=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, style=Undefined, text=Undefined, tick=Undefined, title=Undefined, view=Undefined)View on GitHub

Return a chart with merged top-level config.

Parameters:

• arrow (ArrowConfig | dict[str, Any]) – Defaults for arrow marks.

• axis (AxisConfig | AxisConfigKwds) – Defaults shared by all axes.

• axisBottom (AxisConfig | AxisConfigKwds) – Defaults for bottom-oriented axes.

• axisIndex (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy index scales.

• axisLeft (AxisConfig | AxisConfigKwds) – Defaults for left-oriented axes.

• axisLocus (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy locus scales.

• axisNominal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize nominal data.

• axisOrdinal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize ordinal data.

• axisQuantitative (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize quantitative data.

• axisRight (AxisConfig | AxisConfigKwds) – Defaults for right-oriented axes.

• axisTop (AxisConfig | AxisConfigKwds) – Defaults for top-oriented axes.

• axisX (AxisConfig | AxisConfigKwds) – Defaults for x axes.

• axisY (AxisConfig | AxisConfigKwds) – Defaults for y axes.

• legend (LegendConfig | LegendConfigKwds) – Defaults shared by all legends. Set disable to true to suppress automatic legend creation by default.

• legendTrack (LegendConfig | LegendConfigKwds) – Defaults for legends of track-like views that use index or locus scales on the x channel. __Default value:__ { "style": "track-bottom-legend" }

• link (LinkConfig | LinkConfigKwds) – Defaults for link marks.

• mark (MarkConfig | MarkConfigKwds) – Defaults shared by all mark types.

• point (PointConfig | PointConfigKwds) – Defaults for point marks.

• range (RangeConfig | RangeConfigKwds) – Named reusable ranges for channels such as shape, size, and color.

• rect (RectConfig | RectConfigKwds) – Defaults for rect marks.

• rule (RuleConfig | RuleConfigKwds) – Defaults for rule marks.

• scale (ScaleConfig | ScaleConfigKwds) – Defaults for scale behavior and scale-type-specific buckets.

• style (dict[str, Any]) – Named reusable style buckets that marks, axes, legends, titles, and views can reference through their style properties.

• text (TextConfig | TextConfigKwds) – Defaults for text marks.

• tick (TickConfig | dict[str, Any]) – Defaults for tick marks.

• title (TitleConfig | TitleConfigKwds) – Defaults for view titles.

• view (ViewConfig | ViewConfigKwds) – Defaults for view background styling, including fill, stroke, shadow, and z-order properties.

configure_arrow(value=Undefined, /, *, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, direction=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, headAngle=Undefined, headNotchAngle=Undefined, headPlacement=Undefined, headShape=Undefined, headSpacing=Undefined, headWidth=Undefined, minSize=Undefined, minStemLength=Undefined, opacity=Undefined, size=Undefined, startNotch=Undefined, stem=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with arrow config updated.

Parameters:

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• direction (Literal['forward'] | Literal['reverse'] | ExprRef | dict[str, Any]) – Direction of the arrowhead. "forward" places the arrowhead at the secondary endpoint (x2, y2). "reverse" places it at the primary endpoint (x, y). For data-driven direction, use the direction encoding channel. __Default value:__ "forward"

• fill (str | ExprRef | dict[str, Any]) – The fill color.

• fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between 0 and 1.

• filled (bool) – Whether the color represents the fill color (true) or the stroke color (false).

• headAngle (float | ExprRef | dict[str, Any]) – Angle in degrees between the arrow axis and an outer edge of the arrowhead. Smaller values produce longer, narrower heads. Larger values produce shorter, blunter heads. Values are clamped to [1, 90]. __Default value:__ 45

• headNotchAngle (float | ExprRef | dict[str, Any]) – Angle in degrees between the arrow axis and the arrowhead notch edge. 90 places the notch point at the tip, producing a triangular head when headAngle is less than 90. Applies to "triangle" heads. "open" heads use headAngle for the notch edge as well. Values are clamped to [1, 90]. __Default value:__ 90

• headPlacement (Literal['inside'] | Literal['outside'] | ExprRef | dict[str, Any]) – Placement of the arrowhead relative to the encoded segment. "inside" keeps the whole arrowhead within the encoded segment. "outside" places the arrowhead beyond the encoded segment so that the head starts at the segment endpoint. __Default value:__ "inside"

• headShape (Literal['triangle'] | Literal['open'] | ExprRef | dict[str, Any]) – Shape of the arrowhead. "triangle" draws a filled head. "open" draws an open head whose thickness matches the resolved size, even when stem is false. __Default value:__ "triangle"

• headSpacing (float | None | ExprRef | dict[str, Any]) – Spacing between repeated arrowheads as a multiplier of resolved size. The effective spacing is at least the rendered arrowhead footprint, including stroke. If null, arrowheads are not repeated. __Default value:__ null

• headWidth (float | ExprRef | dict[str, Any]) – Width of the arrowhead as a multiplier of resolved size. Values above 1 make the arrowhead wider than the stem. __Default value:__ 3

• minSize (float | ExprRef | dict[str, Any]) – Minimum resolved arrow stem thickness in pixels. Applies to numeric, band-relative, and encoded size values. __Default value:__ 1

• minStemLength (float | ExprRef | dict[str, Any]) – Minimum visible length of the arrow stem in pixels. When a non-repeated arrow is too short for the configured shape and minimum stem length, the affected notch or head angle is made blunter toward 90 degrees. For "inside" placement, this applies to "triangle" heads and is measured from the start of the stem to where the stem meets the head notch edge. For "outside" placement, this applies when startNotch is true and is measured from the start notch to the head start. Has no effect when stem is false. __Default value:__ 0

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• size (float | ArrowRelativeSize | dict[str, Any] | ExprRef) – Arrow stem thickness in pixels, or as a fraction of the perpendicular band or view span for axis-aligned arrows. Numeric values are pixels. { "band": 0.8 } resolves to 80% of the perpendicular band width, or 80% of the perpendicular view span when no band scale is available. Use channel to explicitly select the reference channel. Band-relative size is not supported for diagonal arrows. __Default value:__ 8

• startNotch (bool | ExprRef | dict[str, Any]) – Whether to draw a notch at the start of the arrow. The start notch uses the same slope as the arrowhead edge. __Default value:__ false

• stem (bool | ExprRef | dict[str, Any]) – Whether to draw the arrow stem. When false, the resolved size still controls open-head thickness. minStemLength has no effect when the stem is hidden. __Default value:__ true

• stroke (str | ExprRef | dict[str, Any]) – The stroke color

• strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between 0 and 1.

• strokeWidth (float | ExprRef | dict[str, Any]) – The stroke width in pixels.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2 (float | ExprRef | dict[str, Any]) – The secondary position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2 (float | ExprRef | dict[str, Any]) – The secondary position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_axis(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axis config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_bottom(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisBottom config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_index(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisIndex config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_left(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisLeft config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_locus(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisLocus config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_nominal(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisNominal config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_ordinal(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisOrdinal config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_quantitative(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisQuantitative config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_right(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisRight config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_top(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisTop config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_x(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisX config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_axis_y(value=Undefined, /, *, chromGrid=Undefined, chromGridCap=Undefined, chromGridColor=Undefined, chromGridDash=Undefined, chromGridDashOffset=Undefined, chromGridFillEven=Undefined, chromGridFillOdd=Undefined, chromGridOpacity=Undefined, chromGridWidth=Undefined, chromLabelAlign=Undefined, chromLabelColor=Undefined, chromLabelFont=Undefined, chromLabelFontSize=Undefined, chromLabelFontStyle=Undefined, chromLabelFontWeight=Undefined, chromLabelPadding=Undefined, chromLabels=Undefined, chromTickColor=Undefined, chromTickDash=Undefined, chromTickDashOffset=Undefined, chromTickSize=Undefined, chromTickWidth=Undefined, chromTicks=Undefined, domain=Undefined, domainCap=Undefined, domainColor=Undefined, domainDash=Undefined, domainDashOffset=Undefined, domainWidth=Undefined, extraValues=Undefined, format=Undefined, grid=Undefined, gridCap=Undefined, gridColor=Undefined, gridDash=Undefined, gridDashOffset=Undefined, gridOpacity=Undefined, gridWidth=Undefined, labelAlign=Undefined, labelAngle=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFlush=Undefined, labelFlushOffset=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOverlap=Undefined, labelPadding=Undefined, labelSeparation=Undefined, labels=Undefined, maxExtent=Undefined, minExtent=Undefined, offset=Undefined, orient=Undefined, placement=Undefined, style=Undefined, tickCap=Undefined, tickColor=Undefined, tickCount=Undefined, tickDash=Undefined, tickDashOffset=Undefined, tickMinStep=Undefined, tickSize=Undefined, tickWidth=Undefined, ticks=Undefined, title=Undefined, titleColor=Undefined, titleFit=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleOpacity=Undefined, titlePadding=Undefined, values=Undefined, zindex=Undefined)View on GitHub

Return a chart with axisY config updated.

Parameters:

• chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__ false

• chromGridCap (Literal['butt', 'round', 'square']) – The stroke cap for the chromosome grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• chromGridColor (str) – Color of grid lines. __Default value:__ lightgray

• chromGridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome grid mark lines.

• chromGridDashOffset (float) – The pixel offset at which to start drawing with the chromosome grid mark dash array.

• chromGridFillEven (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridFillOdd (str) – Fill color of odd chromosomes. __Default value:__ (none)

• chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__ 1

• chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__ 1

• chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__ "left"

• chromLabelColor (str) – Text color of chromosome name labels. __Default value:__ "black"

• chromLabelFont (str) – The font of chromosome name labels.

• chromLabelFontSize (float) – Font size of chromosome name labels, in pixels. __Default value:__ 13

• chromLabelFontStyle (FontStyle_T) – Font style of chromosome name labels. __Default value:__ "normal"

• chromLabelFontWeight (FontWeight_T) – Font weight of chromosome name labels. __Default value:__ "normal"

• chromLabelPadding (float) – The padding, in pixels, between chromosome boundary ticks and chromosome name labels. __Default value:__ 7

• chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__ true

• chromTickColor (str) – The color of chromosome boundary ticks. __Default value:__ "#989898"

• chromTickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed chromosome boundary ticks. __Default value:__ [4, 2]

• chromTickDashOffset (float) – The pixel offset at which to start drawing with the chromosome tick dash array. __Default value:__ 1

• chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__ 18

• chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__ 1

• chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__ true

• domain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__ true

• domainCap (Literal['butt', 'round', 'square']) – The stroke cap for the domain line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• domainColor (str) – Color of axis domain line. __Default value:__ "gray".

• domainDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed domain lines.

• domainDashOffset (float) – The pixel offset at which to start drawing with the domain dash array.

• domainWidth (float) – Stroke width of axis domain line __Default value:__ 1

• extraValues (Sequence[float]) – Additional tick and label values to include alongside automatically generated ticks on continuous scales. Values outside the visible scale range are omitted and duplicates are removed. During automatic overlap removal, these labels are reduced against other explicitly specified labels but take precedence over automatically generated labels. This property is ignored on discrete scales and when values is set.

• format (str) – The format specifier pattern for axis labels. Must be a legal d3-format specifier.

• grid (bool) – A boolean flag indicating if grid lines should be included as part of the axis. __Default value:__ false

• gridCap (Literal['butt', 'round', 'square']) – The stroke cap for the grid line’s ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• gridColor (str) – Color of grid lines. __Default value:__ lightgray

• gridDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed grid mark lines.

• gridDashOffset (float) – The pixel offset at which to start drawing with the grid mark dash array.

• gridOpacity (float) – The opacity of the grid lines. __Default value:__ 1

• gridWidth (float) – Width of the grid lines. __Default value:__ 1

• labelAlign (Align_T) – Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

• labelAngle (float) – The rotation angle of the axis labels. __Default value:__ -90 for nominal and ordinal fields; 0 otherwise.

• labelBaseline (Baseline_T) – Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of "alphabetic" (default), "top", "middle", "bottom".

• labelColor (str) – The color of the tick label, can be in hex color code or regular color name.

• labelFlush (bool | float) – Indicates whether labels near the beginning or end of the axis should be aligned flush with the scale range. A number specifies the endpoint distance threshold in pixels. true uses a threshold of one pixel. Flushing is supported for quantitative, index, and locus axes. By default, it is enabled for non-zoomable x axes of these types. On a zoomable x axis with a configured bounded zoom extent, ticks matching the extent boundaries are flushed while they remain visible. Other zoomable ticks and y-axis ticks are not flushed by default. Flushing supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelFlushOffset (float) – The number of pixels by which to move flush-adjusted labels outward from the axis range. __Default value:__ 0

• labelFont (str) – The font of the tick label.

• labelFontSize (float) – The font size of the label, in pixels.

• labelFontStyle (FontStyle_T) – Font style of the title.

• labelFontWeight (FontWeight_T) – Font weight of axis tick labels.

• labelLimit (float) – Maximum allowed pixel width of axis tick labels. __Default value:__ 180

• labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels. true uses the "parity" strategy. "parity" removes every other label until the remaining labels no longer overlap. "greedy" keeps each label that does not overlap the previously retained label. false disables overlap removal. By default, overlap removal uses "parity" for linear-like continuous scales and "greedy" for logarithmic and symlog scales. It is disabled for discrete scales. Overlap removal supports label angles that are multiples of 90 degrees. The automatic behavior is disabled at other angles.

• labelPadding (float) – The padding, in pixels, between axis and text labels. __Default value:__ 2

• labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__ 2

• labels (bool) – A boolean flag indicating if labels should be included as part of the axis. __Default value:__ true.

• maxExtent (float) – The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles. __Default value:__ undefined.

• minExtent (float) – The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles. __Default value:__ 30 for y-axis; undefined for x-axis.

• offset (float) – The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

• orient (AxisOrient_T) – The orientation of the axis. One of "top", "bottom", "left" or "right". The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart). __Default value:__ "bottom" for x-axes and "left" for y-axes.

• placement (AxisPlacement_T) – Placement of the axis relative to the plotting area. Outside axes reserve layout space outside the plot. Inside axes are mirrored into the plot and do not reserve external layout space. __Default value:__ "outside".

• style (str | Sequence[str] | None) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited axis styles.

• tickCap (Literal['butt', 'round', 'square']) – The stroke cap for the tick lines’ ending style. One of "butt", "round" or "square". __Default value:__ "butt"

• tickColor (str) – The color of the axis’s tick. __Default value:__ "gray"

• tickCount (float | ExprRef | dict[str, Any]) – A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. An expression reference can use axisLength for the current length of the axis in pixels. For example, { "expr": "ceil(axisLength / 40)" } requests one tick per 40 pixels. __Default value:__ an expression based on axisLength

• tickDash (Sequence[float]) – An array of alternating [stroke, space] lengths for dashed tick mark lines.

• tickDashOffset (float) – The pixel offset at which to start drawing with the tick mark dash array.

• tickMinStep (float) – The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value.

• tickSize (float) – The size in pixels of axis ticks. __Default value:__ 5

• tickWidth (float) – The width, in pixels, of ticks. __Default value:__ 1

• ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__ true

• title (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to null to remove it.

• titleColor (str) – Color of the title, can be in hex color code or regular color name.

• titleFit (Literal['point', 'range']) – Fitting mode for the axis title. "point" anchors the title at the center of the axis without constraining its length. "range" constrains the title to the axis span using ranged text, allowing it to be squeezed to fit and kept visible inside scrollable viewports. __Default value:__ "point"

• titleFont (str) – Font of the title. (e.g., "Helvetica Neue").

• titleFontSize (float) – Font size of the title.

• titleFontStyle (FontStyle_T) – Font style of the title.

• titleFontWeight (FontWeight_T) – Font weight of the title. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• titleOpacity (float) – Opacity of the axis title.

• titlePadding (float) – The padding, in pixels, between title and axis.

• values (Sequence[Any]) – Explicitly set the visible axis tick and label values. During automatic overlap removal, these labels are reduced against each other but take precedence over automatically generated labels.

• zindex (float) – Z-order of the axis relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

configure_legend(value=Undefined, /, *, backgroundFill=Undefined, backgroundFillOpacity=Undefined, backgroundStroke=Undefined, backgroundStrokeOpacity=Undefined, backgroundStrokeWidth=Undefined, columnPadding=Undefined, columns=Undefined, direction=Undefined, disable=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, layout=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, spacing=Undefined, style=Undefined, symbolBaseFillColor=Undefined, symbolBaseStrokeColor=Undefined, symbolFillColor=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, tickCount=Undefined, title=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, values=Undefined)View on GitHub

Return a chart with legend config updated.

Parameters:

• backgroundFill (str) – Fill color of the legend background.

• backgroundFillOpacity (float) – Opacity of the legend background fill.

• backgroundStroke (str) – Stroke color of the legend background.

• backgroundStrokeOpacity (float) – Opacity of the legend background stroke.

• backgroundStrokeWidth (float) – Stroke width of the legend background border.

• columnPadding (float) – Padding between legend columns in pixels.

• columns (float) – The number of columns in which to arrange symbol legend entries.

• direction (LegendDirection_T) – The direction in which legend entries are laid out. This is independent of orient, which selects the legend region. __Default value:__ "vertical"

• disable (bool | ExprRef | dict[str, Any]) – Disable automatic legend creation. Use legend: null on an encoding channel to remove that channel’s legend. __Default value:__ false

• gradientLength (float) – Fixed length of the gradient ramp in pixels. This is the width of a horizontal ramp and the height of a vertical ramp. When omitted, the ramp fills available space when its direction is parallel to its legend region. Otherwise its natural length is 200 pixels.

• gradientOpacity (float) – Opacity of the gradient ramp. __Default value:__ 1

• gradientStrokeColor (str) – Stroke color of the gradient ramp border.

• gradientStrokeWidth (float) – Stroke width of the gradient ramp border in pixels. __Default value:__ 0

• gradientThickness (float) – Thickness of the gradient ramp in pixels. __Default value:__ 12

• labelAlign (Align_T) – Horizontal alignment of legend labels.

• labelBaseline (Baseline_T) – Baseline alignment of legend labels.

• labelColor (str) – Legend label color.

• labelFont (str) – Legend label font.

• labelFontSize (float) – Legend label font size in pixels.

• labelFontStyle (FontStyle_T) – Legend label font style.

• labelFontWeight (FontWeight_T) – Legend label font weight.

• labelLimit (float) – Maximum label text width in pixels.

• labelOffset (float) – Offset between legend symbols and labels in pixels.

• layout (LegendLayout | dict[str, Any]) – Layout of complete legends within each orientation region. A general direction or anchor applies to every region unless the orientation has its own override.

• offset (float) – External gap in pixels between the legend and the plot edge.

• orient (LegendOrient_T | ExprRef | dict[str, Any]) – The plot side or inside corner where the legend is placed. Side legends are placed outside the plot area. Corner legends are placed inside the plot area.

• padding (float) – Internal padding in pixels around the legend content and background.

• rowPadding (float) – Padding between legend rows in pixels.

• spacing (float) – Spacing in pixels between legends collected into the same legend region.

• style (str | Sequence[str] | None) – Named style reference or references resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited legend styles.

• symbolBaseFillColor (str) – Base fill color for legend symbols when the legend does not encode fill.

• symbolBaseStrokeColor (str) – Base stroke color for legend symbols when the legend does not encode stroke.

• symbolFillColor (str) – Symbol fill color. Overrides inherited fill styling, except when the legend encodes fill or uses fill to encode color.

• symbolOffset (float) – Offset applied to legend symbols in pixels.

• symbolOpacity (float) – Symbol opacity. Overrides inherited mark and encoding opacity, except when the legend encodes opacity. Set to 1 to keep a category key opaque while selections dim the data marks.

• symbolSize (float) – Symbol size in pixels squared. Overrides inherited styling, except when the legend encodes size.

• symbolStrokeColor (str) – Symbol stroke color. Overrides inherited stroke styling, except when the legend encodes stroke or uses stroke to encode color.

• symbolStrokeWidth (float) – Symbol stroke width in pixels. Overrides inherited styling, except when the legend encodes stroke width.

• symbolType (str) – Symbol shape. Overrides inherited styling, except when the legend encodes shape.

• tickCount (float) – Desired number of ticks for a quantitative gradient legend. Explicit values take precedence over this property. __Default value:__ 5

• title (str | None) – Title text for the legend. If null, the title is removed.

• titleColor (str) – Legend title color.

• titleFont (str) – Legend title font.

• titleFontSize (float) – Legend title font size in pixels.

• titleFontStyle (FontStyle_T) – Legend title font style.

• titleFontWeight (FontWeight_T) – Legend title font weight.

• titleLimit (float) – Maximum title text width in pixels.

• titleOrient (LegendTitleOrient_T) – The side of the legend on which to place the title.

• titlePadding (float) – Padding in pixels between the legend title and the legend body.

• values (Sequence[str | float | bool]) – Explicit values to show in the legend. For discrete symbol legends, the values define an ordered subset of entries. For quantitative symbol and gradient legends, the values define the shown representative values or ticks.

configure_legend_track(value=Undefined, /, *, backgroundFill=Undefined, backgroundFillOpacity=Undefined, backgroundStroke=Undefined, backgroundStrokeOpacity=Undefined, backgroundStrokeWidth=Undefined, columnPadding=Undefined, columns=Undefined, direction=Undefined, disable=Undefined, gradientLength=Undefined, gradientOpacity=Undefined, gradientStrokeColor=Undefined, gradientStrokeWidth=Undefined, gradientThickness=Undefined, labelAlign=Undefined, labelBaseline=Undefined, labelColor=Undefined, labelFont=Undefined, labelFontSize=Undefined, labelFontStyle=Undefined, labelFontWeight=Undefined, labelLimit=Undefined, labelOffset=Undefined, layout=Undefined, offset=Undefined, orient=Undefined, padding=Undefined, rowPadding=Undefined, spacing=Undefined, style=Undefined, symbolBaseFillColor=Undefined, symbolBaseStrokeColor=Undefined, symbolFillColor=Undefined, symbolOffset=Undefined, symbolOpacity=Undefined, symbolSize=Undefined, symbolStrokeColor=Undefined, symbolStrokeWidth=Undefined, symbolType=Undefined, tickCount=Undefined, title=Undefined, titleColor=Undefined, titleFont=Undefined, titleFontSize=Undefined, titleFontStyle=Undefined, titleFontWeight=Undefined, titleLimit=Undefined, titleOrient=Undefined, titlePadding=Undefined, values=Undefined)View on GitHub

Return a chart with legendTrack config updated.

Parameters:

• backgroundFill (str) – Fill color of the legend background.

• backgroundFillOpacity (float) – Opacity of the legend background fill.

• backgroundStroke (str) – Stroke color of the legend background.

• backgroundStrokeOpacity (float) – Opacity of the legend background stroke.

• backgroundStrokeWidth (float) – Stroke width of the legend background border.

• columnPadding (float) – Padding between legend columns in pixels.

• columns (float) – The number of columns in which to arrange symbol legend entries.

• direction (LegendDirection_T) – The direction in which legend entries are laid out. This is independent of orient, which selects the legend region. __Default value:__ "vertical"

• disable (bool | ExprRef | dict[str, Any]) – Disable automatic legend creation. Use legend: null on an encoding channel to remove that channel’s legend. __Default value:__ false

• gradientLength (float) – Fixed length of the gradient ramp in pixels. This is the width of a horizontal ramp and the height of a vertical ramp. When omitted, the ramp fills available space when its direction is parallel to its legend region. Otherwise its natural length is 200 pixels.

• gradientOpacity (float) – Opacity of the gradient ramp. __Default value:__ 1

• gradientStrokeColor (str) – Stroke color of the gradient ramp border.

• gradientStrokeWidth (float) – Stroke width of the gradient ramp border in pixels. __Default value:__ 0

• gradientThickness (float) – Thickness of the gradient ramp in pixels. __Default value:__ 12

• labelAlign (Align_T) – Horizontal alignment of legend labels.

• labelBaseline (Baseline_T) – Baseline alignment of legend labels.

• labelColor (str) – Legend label color.

• labelFont (str) – Legend label font.

• labelFontSize (float) – Legend label font size in pixels.

• labelFontStyle (FontStyle_T) – Legend label font style.

• labelFontWeight (FontWeight_T) – Legend label font weight.

• labelLimit (float) – Maximum label text width in pixels.

• labelOffset (float) – Offset between legend symbols and labels in pixels.

• layout (LegendLayout | dict[str, Any]) – Layout of complete legends within each orientation region. A general direction or anchor applies to every region unless the orientation has its own override.

• offset (float) – External gap in pixels between the legend and the plot edge.

• orient (LegendOrient_T | ExprRef | dict[str, Any]) – The plot side or inside corner where the legend is placed. Side legends are placed outside the plot area. Corner legends are placed inside the plot area.

• padding (float) – Internal padding in pixels around the legend content and background.

• rowPadding (float) – Padding between legend rows in pixels.

• spacing (float) – Spacing in pixels between legends collected into the same legend region.

• style (str | Sequence[str] | None) – Named style reference or references resolved from config.style. If an array is provided, later styles override earlier ones. Set to null to reset inherited legend styles.

• symbolBaseFillColor (str) – Base fill color for legend symbols when the legend does not encode fill.

• symbolBaseStrokeColor (str) – Base stroke color for legend symbols when the legend does not encode stroke.

• symbolFillColor (str) – Symbol fill color. Overrides inherited fill styling, except when the legend encodes fill or uses fill to encode color.

• symbolOffset (float) – Offset applied to legend symbols in pixels.

• symbolOpacity (float) – Symbol opacity. Overrides inherited mark and encoding opacity, except when the legend encodes opacity. Set to 1 to keep a category key opaque while selections dim the data marks.

• symbolSize (float) – Symbol size in pixels squared. Overrides inherited styling, except when the legend encodes size.

• symbolStrokeColor (str) – Symbol stroke color. Overrides inherited stroke styling, except when the legend encodes stroke or uses stroke to encode color.

• symbolStrokeWidth (float) – Symbol stroke width in pixels. Overrides inherited styling, except when the legend encodes stroke width.

• symbolType (str) – Symbol shape. Overrides inherited styling, except when the legend encodes shape.

• tickCount (float) – Desired number of ticks for a quantitative gradient legend. Explicit values take precedence over this property. __Default value:__ 5

• title (str | None) – Title text for the legend. If null, the title is removed.

• titleColor (str) – Legend title color.

• titleFont (str) – Legend title font.

• titleFontSize (float) – Legend title font size in pixels.

• titleFontStyle (FontStyle_T) – Legend title font style.

• titleFontWeight (FontWeight_T) – Legend title font weight.

• titleLimit (float) – Maximum title text width in pixels.

• titleOrient (LegendTitleOrient_T) – The side of the legend on which to place the title.

• titlePadding (float) – Padding in pixels between the legend title and the legend body.

• values (Sequence[str | float | bool]) – Explicit values to show in the legend. For discrete symbol legends, the values define an ordered subset of entries. For quantitative symbol and gradient legends, the values define the shown representative values or ticks.

configure_link(value=Undefined, /, *, arcFadingDistance=Undefined, arcHeightFactor=Undefined, buildIndex=Undefined, clampApex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, linkShape=Undefined, maxChordLength=Undefined, minArcHeight=Undefined, minPickingSize=Undefined, noFadingOnPointSelection=Undefined, opacity=Undefined, orient=Undefined, segments=Undefined, size=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with link config updated.

Parameters:

• arcFadingDistance (Sequence[float] | Literal[False] | ExprRef | dict[str, Any]) – The fading distance range for "arc" and "dome" shapes, in logical screen pixels. Opacity fades smoothly from one to zero between these perpendicular distances from the line joining the rendered endpoints. For domes, this is the baseline rather than the apex position, regardless of orientation, direction, or the scale used for height. Both false and [0, 0] disable fading. Default value: false

• arcHeightFactor (float | ExprRef | dict[str, Any]) – Scaling factor for the "arc” shape’s height. The default value 1.0 produces roughly circular arcs. Default value: 1.0

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clampApex (bool | ExprRef | dict[str, Any]) – Whether the apex of the "dome" shape is clamped to the viewport edge. When over a half of the dome is located outside the viewport, clamping allows for more accurate reading of the value encoded by the apex’ position. Default value: false

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• linkShape (Literal['arc'] | Literal['diagonal'] | Literal['line'] | Literal['dome'] | ExprRef | dict[str, Any]) – The shape of the link path. The "arc" shape draws a circular arc between the two points. The apex of the arc resides on the left side of the line that connects the two points. The "dome" shape draws a vertical or horizontal arc with a specific height. The primary positional channel determines the apex of the arc and the secondary determines the endpoint placement. The "diagonal" shape draws an “S”-shaped curve between the two points. The "line" shape draws a straight line between the two points. See an example of the different shapes below. Default value: "arc"

• maxChordLength (float | ExprRef | dict[str, Any]) – The maximum length of "arc" shape’s chord in pixels. The chord is the line segment between the two points that define the arc. Limiting the chord length serves two purposes when zooming in close enough: 1) it prevents the arc from becoming a straight line and 2) it mitigates the limited precision of floating point numbers in arc rendering. Default value: 50000

• minArcHeight (float | ExprRef | dict[str, Any]) – The minimum height of an "arc" shape. Makes very short links more clearly visible. Default value: 1.5

• minPickingSize (float | ExprRef | dict[str, Any]) – The minimum picking size invisibly increases the stroke width or point diameter of marks when pointing them with the mouse cursor, making it easier to select them. The valus is the minimum size in pixels. Default value: 3.0 for "link" and 2.0 for "point"

• noFadingOnPointSelection (bool | ExprRef | dict[str, Any]) – Disables fading for selected links. Tests selections referenced by conditional encodings, excluding empty selections. Despite the property name, interval selections also bypass fading when either link endpoint is inside each selected interval. Only marks that participate in picking use this bypass. Default value: true

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• orient (Literal['vertical'] | Literal['horizontal'] | ExprRef | dict[str, Any]) – The orientation of the link path. Either "vertical" or "horizontal". Only applies to diagonal links. Default value: "vertical"

• segments (float | ExprRef | dict[str, Any]) – The number of segments in the bézier curve. Affects the rendering quality and performance. Use a higher value for a smoother curve. Default value: 101

• size (float | ExprRef | dict[str, Any]) – Stroke width of "link" and "rule" marks in pixels, the area of the bounding square of "point" mark, or the font size of "text" mark.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2 (float | ExprRef | dict[str, Any]) – The secondary position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2 (float | ExprRef | dict[str, Any]) – The secondary position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_mark(value=Undefined, /, *, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, opacity=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with mark config updated.

Parameters:

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_point(value=Undefined, /, *, angle=Undefined, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, dx=Undefined, dy=Undefined, fill=Undefined, fillGradientStrength=Undefined, fillOpacity=Undefined, filled=Undefined, geometricZoomBound=Undefined, inwardStroke=Undefined, minPickingSize=Undefined, opacity=Undefined, sampleFacetPadding=Undefined, semanticScore=Undefined, semanticZoomFraction=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with point config updated.

Parameters:

• angle (float | ExprRef | dict[str, Any]) – The rotation angle in degrees. Default value: 0

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• dx (float | ExprRef | dict[str, Any]) – Horizontal offset in pixels. Default value: 0

• dy (float | ExprRef | dict[str, Any]) – Vertical offset in pixels. Default value: 0

• fill (str | ExprRef | dict[str, Any]) – The fill color.

• fillGradientStrength (float | ExprRef | dict[str, Any]) – Gradient strength controls the amount of the gradient eye-candy effect in the fill color. Valid values are between 0 and 1. Default value: 0

• fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between 0 and 1.

• filled (bool) – Whether the color represents the fill color (true) or the stroke color (false).

• geometricZoomBound (float) – Enables geometric zooming. The value is the base two logarithmic zoom level where the maximum point size is reached. Default value: 0

• inwardStroke (bool | ExprRef | dict[str, Any]) – Should the stroke only grow inwards, e.g, the diameter/outline is not affected by the stroke width. Thus, a point that has a zero size has no visible stroke. This allows strokes to be used with geometric zoom, etc. Default value: false

• minPickingSize (float | ExprRef | dict[str, Any]) – The minimum picking size invisibly increases the stroke width or point diameter of marks when pointing them with the mouse cursor, making it easier to select them. The valus is the minimum size in pixels. Default value: 3.0 for "link" and 2.0 for "point"

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• sampleFacetPadding (float) – Additional padding used by sample facets. Default value: 0.1

• semanticScore (float | ExprRef | dict[str, Any]) – The semantic score used by semantic zooming in the point mark. This is primarily intended for internal use. Default value: 0

• semanticZoomFraction (float | ExprRef | dict[str, Any]) – TODO Default value: 0.02

• shape (str | ExprRef | dict[str, Any]) – One of "circle", "square", "cross", "x", "+", "diamond", "triangle-up", "triangle-down", "triangle-right", "triangle-left", "tick-up", "tick-down", "tick-right", or "tick-left". The "x" and "+" shapes are stroke-only and use strokeWidth for their line thickness. Default value: "circle"

• size (float | ExprRef | dict[str, Any]) – Stroke width of "link" and "rule" marks in pixels, the area of the bounding square of "point" mark, or the font size of "text" mark.

• stroke (str | ExprRef | dict[str, Any]) – The stroke color

• strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between 0 and 1.

• strokeWidth (float | ExprRef | dict[str, Any]) – The stroke width in pixels.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_range(value=Undefined, /, *, angle=Undefined, diverging=Undefined, heatmap=Undefined, ramp=Undefined, shape=Undefined, size=Undefined)View on GitHub

Return a chart with range config updated.

Parameters:

• angle (Sequence[float]) – Named range for angle channels.

• diverging (str | SchemeParams | SchemeParamsKwds) – Named range for diverging color encodings.

• heatmap (str | SchemeParams | SchemeParamsKwds) – Named range for quantitative rect-like color encodings such as heatmaps.

• ramp (str | SchemeParams | SchemeParamsKwds) – Named range for quantitative ramp color encodings.

• shape (Sequence[str]) – Named range for shape channels.

• size (Sequence[float]) – Named range for size channels.

configure_rect(value=Undefined, /, *, buildIndex=Undefined, clip=Undefined, color=Undefined, cornerRadius=Undefined, cornerRadiusBottomLeft=Undefined, cornerRadiusBottomRight=Undefined, cornerRadiusTopLeft=Undefined, cornerRadiusTopRight=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, hatch=Undefined, minHeight=Undefined, minOpacity=Undefined, minWidth=Undefined, opacity=Undefined, shadowBlur=Undefined, shadowColor=Undefined, shadowOffsetX=Undefined, shadowOffsetY=Undefined, shadowOpacity=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with rect config updated.

Parameters:

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cornerRadius (float | ExprRef | dict[str, Any]) – Radius of the rounded corners. Default value: 0

• cornerRadiusBottomLeft (float | ExprRef | dict[str, Any]) – Radius of the bottom left rounded corner. Has higher precedence than cornerRadius. Default value: (None)

• cornerRadiusBottomRight (float | ExprRef | dict[str, Any]) – Radius of the bottom right rounded corner. Has higher precedence than cornerRadius. Default value: (None)

• cornerRadiusTopLeft (float | ExprRef | dict[str, Any]) – Radius of the top left rounded corner. Has higher precedence than cornerRadius. Default value: (None)

• cornerRadiusTopRight (float | ExprRef | dict[str, Any]) – Radius of the top right rounded corner. Has higher precedence than cornerRadius. Default value: (None)

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• fill (str | ExprRef | dict[str, Any]) – The fill color.

• fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between 0 and 1.

• filled (bool) – Whether the color represents the fill color (true) or the stroke color (false).

• hatch (Literal['none'] | Literal['diagonal'] | Literal['antiDiagonal'] | Literal['cross'] | Literal['vertical'] | Literal['horizontal'] | Literal['grid'] | Literal['dots'] | Literal['rings'] | Literal['ringsLarge'] | ExprRef | dict[str, Any]) – A hatch pattern drawn inside the mark using the stroke width, color, and opacity. The pattern is aligned in screen space and scaled by the stroke width. Default value: "none"

• minHeight (float | ExprRef | dict[str, Any]) – The minimum height of a rectangle in pixels. The property clamps rectangles’ heights. Default value: 0

• minOpacity (float | ExprRef | dict[str, Any]) – Clamps the minimum size-dependent opacity. The property does not affect the opacity channel. Valid values are between 0 and 1. When a rectangle would be smaller than what is specified in minHeight and minWidth, it is faded out proportionally. Example: a rectangle would be rendered as one pixel wide, but minWidth clamps it to five pixels. The rectangle is actually rendered as five pixels wide, but its opacity is multiplied by 0.2. With this setting, you can limit the factor to, for example, 0.5 to keep the rectangles more clearly visible. Default value: 0

• minWidth (float | ExprRef | dict[str, Any]) – The minimum width of a rectangle in pixels. The property clamps rectangles’ widths when the viewport is zoomed out. This property also reduces flickering of very narrow rectangles when zooming. The value should generally be at least one. Default value: 1

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value: 0

• shadowColor (str | ExprRef | dict[str, Any]) – The color of the drop shadow. Any valid CSS color string is allowed. Default value: "black"

• shadowOffsetX (float | ExprRef | dict[str, Any]) – The horizontal offset of the drop shadow in pixels. Positive values move the shadow to the right. Default value: 0

• shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value: 0

• shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between 0 (fully transparent) and 1 (fully opaque). Default value: 0 (disabled)

• stroke (str | ExprRef | dict[str, Any]) – The stroke color

• strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between 0 and 1.

• strokeWidth (float | ExprRef | dict[str, Any]) – The stroke width in pixels.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2 (float | ExprRef | dict[str, Any]) – The secondary position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2 (float | ExprRef | dict[str, Any]) – The secondary position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_rule(value=Undefined, /, *, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, minLength=Undefined, opacity=Undefined, size=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, style=Undefined, tooltip=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with rule config updated.

Parameters:

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• minLength (float | ExprRef | dict[str, Any]) – The minimum stroke length in pixels. Use this property to ensure that very short strokes remain visible even when the user zooms out. Default value: 0

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• size (float | ExprRef | dict[str, Any]) – Stroke width of "link" and "rule" marks in pixels, the area of the bounding square of "point" mark, or the font size of "text" mark.

• strokeCap (Literal['butt'] | Literal['square'] | Literal['round'] | ExprRef | dict[str, Any]) – The style of stroke ends. Available choices: "butt", "round”, and "square". Default value: "butt"

• strokeDash (Sequence[float]) – An array of of alternating stroke and gap lengths or null for solid strokes. Default value: null

• strokeDashOffset (float) – An offset for the stroke dash pattern. Default value: 0

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2 (float | ExprRef | dict[str, Any]) – The secondary position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2 (float | ExprRef | dict[str, Any]) – The secondary position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_scale(value=Undefined, /, *, align=Undefined, assembly=Undefined, base=Undefined, bins=Undefined, clamp=Undefined, constant=Undefined, domain=Undefined, domainMax=Undefined, domainMid=Undefined, domainMin=Undefined, domainTransition=Undefined, exponent=Undefined, index=Undefined, interpolate=Undefined, locus=Undefined, name=Undefined, nice=Undefined, nominal=Undefined, nominalColorScheme=Undefined, numberingOffset=Undefined, ordinal=Undefined, ordinalColorScheme=Undefined, padding=Undefined, paddingInner=Undefined, paddingOuter=Undefined, quantitative=Undefined, quantitativeColorScheme=Undefined, range=Undefined, reverse=Undefined, round=Undefined, scheme=Undefined, type=Undefined, zero=Undefined, zoom=Undefined)View on GitHub

Return a chart with scale config updated.

Parameters:

• align (float) – The alignment of the steps within the scale range. This value must lie in the range [0,1]. A value of 0.5 indicates that the steps should be centered within the range. A value of 0 or 1 may be used to shift the bands to one side, say to position them adjacent to an axis. __Default value:__ 0.5

• assembly (str | UrlGenomeDefinition | dict[str, Any] | InlineGenomeDefinition) – Genome assembly definition for locus scales. This can be: - A string reference to a named assembly (built-in or root-configured). - An inline anonymous assembly that defines either contigs or url. If undefined, the default genome from the genome store is used.

• base (float) – The logarithm base of the log scale (default 10).

• bins (Sequence[float]) – An array of bin boundaries over the scale domain. If provided, axes and legends will use the bin boundaries to inform the choice of tick marks and text labels.

• clamp (bool) – If true, values that exceed the data domain are clamped to either the minimum or maximum range value __Default value:__ derived from the Vega-Lite scale config’s clamp (true by default).

• constant (float) – A constant determining the slope of the symlog function around zero. Only used for symlog scales. __Default value:__ 1

• domain (ScalarDomain_T | Sequence[ChromosomalLocus | dict[str, Any]] | SelectionDomainRef | dict[str, Any] | ViewportDomainRef | ExprRef | Sequence[float | str | bool | ExprRef | dict[str, Any]]) – Customized domain values. For quantitative fields, domain can take the form of a two-element array with minimum and maximum values. Vega-Lite piecewise scales can be created by providing a domain with more than two entries. For ordinal and nominal fields, domain can be an array that lists valid input values. The domain can also be defined by an expression reference that evaluates to the domain array. Array elements may also be expression references. All parameter names referenced by a scale, including selection-domain parameters, resolve from the view that owns the scale resolution. For a shared scale, declare controlling parameters on that owning composed view or an ancestor.

• domainMax (float) – Sets the maximum value in the scale domain, overriding the domain property. This property is only intended for use with scales having continuous domains.

• domainMid (float) – Inserts a single mid-point value into a two-element domain. The mid-point value must lie between the domain minimum and maximum values. This property can be useful for setting a midpoint for Vega-Lite diverging color scales. The domainMid property is only intended for use with scales supporting continuous, piecewise domains.

• domainMin (float) – Sets the minimum value in the scale domain, overriding the domain property. This property is only intended for use with scales having continuous domains.

• domainTransition (bool) – Controls whether domain updates are applied immediately or with a smooth transition. Set this to false to apply domain updates immediately. The default is true, except for domains that include ExprRef``s, which default to ``false unless overridden. __Default value:__ true, except false for ExprRef-driven domains.

• exponent (float) – The exponent of the pow scale.

• index (dict[str, Any]) – Defaults for GenomeSpy’s index scales.

• interpolate (ScaleInterpolate_T | ScaleInterpolateParams | ScaleInterpolateParamsKwds) – The interpolation method for range values. By default, a general interpolator for numbers, dates, strings and colors (in HCL space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long (‘-long’ variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation. __Default value:__ hcl

• locus (dict[str, Any]) – Defaults for GenomeSpy’s locus scales.

• name (str) – The name of the scale. Names are optional but allow the scales to be referenced and found with the API.

• nice (bool | float | dict[str, Any]) – Extending the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0]. For quantitative scales such as linear, nice can be either a boolean flag or a number. If nice is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain. __Default value:__ true for unbinned quantitative fields; false otherwise.

• nominal (dict[str, Any]) – Defaults for nominal scales.

• nominalColorScheme (str | SchemeParams | SchemeParamsKwds) – Default color scheme for nominal color scales.

• numberingOffset (float) – The offset added to data values when formatting tick labels on index and locus scales. This property does not transform data values. __Default value:__ 0

• ordinal (dict[str, Any]) – Defaults for ordinal scales.

• ordinalColorScheme (str | SchemeParams | SchemeParamsKwds) – Default color scheme for ordinal color scales.

• padding (float) – For Vega-Lite continuous scales, expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties. For Vega-Lite band scales, shortcut for setting paddingInner and paddingOuter to the same value. For Vega-Lite point scales, alias for paddingOuter. __Default value:__ For continuous scales, derived from the Vega-Lite scale config’s continuousPadding. For band and point scales, see paddingInner and paddingOuter. By default, Vega-Lite sets padding such that width/height = number of unique values * step.

• paddingInner (float) – The inner padding (spacing) within each band step of band scales, as a fraction of the step size. This value must lie in the range [0,1]. For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands). __Default value:__ derived from the Vega-Lite scale config’s bandPaddingInner.

• paddingOuter (float) – The outer padding (spacing) at the ends of the range of band and point scales, as a fraction of the step size. This value must lie in the range [0,1]. __Default value:__ derived from the Vega-Lite scale config’s bandPaddingOuter for band scales and pointPadding for point scales. By default, Vega-Lite sets outer padding such that width/height = number of unique values * step.

• quantitative (dict[str, Any]) – Defaults for quantitative scales.

• quantitativeColorScheme (str | SchemeParams | SchemeParamsKwds) – Default color scheme for quantitative color scales when no named range such as "heatmap" or "ramp" applies.

• range (Sequence[float | str | ExprRef | dict[str, Any]] | str) – The range of the scale. One of: - A string indicating a pre-defined named scale range from Vega-Lite (e.g., example, "symbol", or "diverging"). - For Vega-Lite continuous scales, two-element array indicating minimum and maximum values, or an array with more than two entries for specifying a Vega-Lite piecewise scale. Array elements may also be expression references, which use the parameter scope of the view that owns the scale resolution. - For Vega-Lite discrete and Vega-Lite discretizing scales, an array of desired output values. Array elements may also be expression references, which use the parameter scope of the view that owns the scale resolution. __Notes:__ 1) For color scales you can also specify a color scheme instead of range. 2) Any directly specified range for x and y channels will be ignored. Range can be customized via the view’s corresponding Vega-Lite size (width and height).

• reverse (bool) – If true, reverses the order of the scale range. __Default value:__ false.

• round (bool) – If true, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid. __Default value:__ false.

• scheme (str | SchemeParams | SchemeParamsKwds) – A string indicating a color Vega-Lite scheme name (e.g., "category10" or "blues") or a Vega-Lite scheme parameter object. Discrete color schemes may be used with Vega-Lite discrete or Vega-Lite discretizing scales. Continuous color schemes are intended for use with color scales. For the full list of supported schemes, please refer to the Vega Scheme reference.

• type (ScaleType_T) – The type of scale. GenomeSpy follows the Vega-Lite scale model; the links below refer to the Vega-Lite documentation: 1) Continuous Scales – mapping continuous domains to continuous output ranges ("linear", "pow", "sqrt", "symlog", "log", "time", "utc"). 2) Discrete Scales – mapping discrete domains to discrete ("ordinal") or continuous ("band" and "point") output ranges. 3) Discretizing Scales – mapping continuous domains to discrete output ranges "bin-ordinal", "quantile", "quantize" and "threshold". GenomeSpy also provides index and locus scales for sequence and genomic coordinates. __Default value:__ please see the Vega-Lite scale type table.

• zero (bool) – If true, ensures that a zero baseline value is included in the scale domain. __Default value:__ true for x and y channels if the quantitative field is not binned and no custom domain is provided; false otherwise. __Note:__ Log scales do not support zero.

• zoom (bool | ZoomParams | ZoomParamsKwds) – If true and the scale is used on a positional channel, it can bee zoomed and translated interactively.

configure_style(value)View on GitHub

Return a chart with style config updated.

configure_text(value=Undefined, /, *, align=Undefined, angle=Undefined, baseline=Undefined, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, dx=Undefined, dy=Undefined, fitToBand=Undefined, flushX=Undefined, flushY=Undefined, font=Undefined, fontStyle=Undefined, fontWeight=Undefined, logoLetters=Undefined, opacity=Undefined, paddingX=Undefined, paddingY=Undefined, size=Undefined, squeeze=Undefined, style=Undefined, text=Undefined, tooltip=Undefined, viewportEdgeFadeDistanceBottom=Undefined, viewportEdgeFadeDistanceLeft=Undefined, viewportEdgeFadeDistanceRight=Undefined, viewportEdgeFadeDistanceTop=Undefined, viewportEdgeFadeWidthBottom=Undefined, viewportEdgeFadeWidthLeft=Undefined, viewportEdgeFadeWidthRight=Undefined, viewportEdgeFadeWidthTop=Undefined, x=Undefined, x2=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with text config updated.

Parameters:

• align (Align_T) – The horizontal alignment of the text. One of "left", "center", or "right". Default value: "left"

• angle (float | ExprRef | dict[str, Any]) – The rotation angle in degrees. Default value: 0

• baseline (Baseline_T) – The vertical alignment of the text. One of "top", "middle", "bottom". Default value: "bottom"

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• dx (float) – The horizontal offset between the text and its anchor point, in pixels. Applied after the rotation by angle.

• dy (float) – The vertical offset between the text and its anchor point, in pixels. Applied after the rotation by angle.

• fitToBand (bool | ExprRef | dict[str, Any]) – If true, sets the secondary positional channel that allows the text to be squeezed (see the squeeze property). Can be used when: 1) "band", "index", or "locus" scale is being used and 2) only the primary positional channel is specified. Expressions are evaluated when the mark is initialized and cannot change reactively. Default value: false

• flushX (bool | ExprRef | dict[str, Any]) – If true, the text is kept inside the viewport when the range of x and x2 intersect the viewport.

• flushY (bool | ExprRef | dict[str, Any]) – If true, the text is kept inside the viewport when the range of y and y2 intersect the viewport.

• font (str) – The font typeface. GenomeSpy uses SDF versions of Google Fonts. Check their availability at the A-Frame Fonts repository. System fonts are not supported. Default value: "Lato"

• fontStyle (FontStyle_T) – The font style. Valid values: "normal" and "italic". Default value: "normal"

• fontWeight (FontWeight_T) – The font weight. The following strings and numbers are valid values: "thin" (100), "light" (300), "regular" (400), "normal" (400), "medium" (500), "bold" (700), "black" (900) Default value: "regular"

• logoLetters (bool | ExprRef | dict[str, Any]) – Stretch letters so that they can be used with sequence logos, etc…

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• paddingX (float | ExprRef | dict[str, Any]) – The horizontal padding, in pixels, when the x2 channel is used for ranged text. Default value: 0

• paddingY (float | ExprRef | dict[str, Any]) – The vertical padding, in pixels, when the y2 channel is used for ranged text. Default value: 0

• size (float | ExprRef | dict[str, Any]) – The font size in pixels. Default value: 11

• squeeze (bool | ExprRef | dict[str, Any]) – If the squeeze property is true and secondary positional channels (x2 and/or y2) are used, the text is scaled to fit mark’s width and/or height. Default value: true

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• text (Scalar_T | ExprRef | dict[str, Any]) – The text to display. The format of numeric data can be customized by setting a format specifier to channel definition’s format property. Default value: ""

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• viewportEdgeFadeDistanceBottom (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeDistanceBottom property.

• viewportEdgeFadeDistanceLeft (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeDistanceLeft property.

• viewportEdgeFadeDistanceRight (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeDistanceRight property.

• viewportEdgeFadeDistanceTop (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeDistanceTop property.

• viewportEdgeFadeWidthBottom (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeWidthBottom property.

• viewportEdgeFadeWidthLeft (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeWidthLeft property.

• viewportEdgeFadeWidthRight (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeWidthRight property.

• viewportEdgeFadeWidthTop (float | ExprRef | dict[str, Any]) – Schema-defined viewportEdgeFadeWidthTop property.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2 (float | ExprRef | dict[str, Any]) – The secondary position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2 (float | ExprRef | dict[str, Any]) – The secondary position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_tick(value=Undefined, /, *, buildIndex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, minLength=Undefined, opacity=Undefined, orient=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=Undefined, style=Undefined, thickness=Undefined, tooltip=Undefined, x=Undefined, x2Offset=Undefined, xOffset=Undefined, y=Undefined, y2Offset=Undefined, yOffset=Undefined)View on GitHub

Return a chart with tick config updated.

Parameters:

• buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.

• clip (bool | Literal['x'] | Literal['y'] | Literal['never']) – Controls whether the mark is clipped to the UnitView’s rectangle. The values "x" and "y" clip only in the corresponding screen-space direction. Inherited clipping from parent containers still applies unless "never" is used. __Default value:__ true when either positional scale is zoomable; otherwise false

• color (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either fill or stroke, depending on the filled property.

• cullByVisibleRange (bool | Literal['x'] | Literal['y']) – Hide point-like mark instances whose anchor falls outside the inherited visible range in the given screen-space direction.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is over the mark. Mark cursor takes precedence over enclosing view cursors. __Default value:__ browser default

• minLength (float | ExprRef | dict[str, Any]) – The minimum stroke length in pixels. Use this property to ensure that very short strokes remain visible even when the user zooms out. Default value: 0

• opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects fillOpacity or strokeOpacity, depending on the filled property.

• orient (Literal['vertical', 'horizontal']) – The orientation of the tick mark. If omitted, GenomeSpy infers the orientation when one positional channel uses a band-like scale and the other does not, or when the orthogonal channel is omitted. Specify orient explicitly when both x and y use band-like scales. Default value: inferred

• strokeCap (Literal['butt'] | Literal['square'] | Literal['round'] | ExprRef | dict[str, Any]) – The style of stroke ends. Available choices: "butt", "round”, and "square". Default value: "butt"

• strokeDash (Sequence[float]) – An array of of alternating stroke and gap lengths or null for solid strokes. Default value: null

• strokeDashOffset (float) – An offset for the stroke dash pattern. Default value: 0

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones.

• thickness (float) – The thickness of the tick mark in pixels. Equivalent to the size of the underlying rule mark. Default value: 1

• tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If null, no tooltip is shown. If string, specifies the tooltip handler to use.

• x (float | ExprRef | dict[str, Any]) – Position on the x axis.

• x2Offset (float | ExprRef | dict[str, Any]) – Offset of the x2 coordinate in logical pixels. When x2 is implicit, it inherits xOffset unless this property is specified. Default value: inherited from xOffset for an implicit x2, otherwise 0

• xOffset (float | ExprRef | dict[str, Any]) – Offset of the x coordinate in logical pixels. Default value: 0

• y (float | ExprRef | dict[str, Any]) – Position on the y axis.

• y2Offset (float | ExprRef | dict[str, Any]) – Offset of the y2 coordinate in logical pixels. When y2 is implicit, it inherits yOffset unless this property is specified. Default value: inherited from yOffset for an implicit y2, otherwise 0

• yOffset (float | ExprRef | dict[str, Any]) – Offset of the y coordinate in logical pixels. Default value: 0

configure_title(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, subtitle=Undefined, subtitleColor=Undefined, subtitleFont=Undefined, subtitleFontSize=Undefined, subtitleFontStyle=Undefined, subtitleFontWeight=Undefined, subtitlePadding=Undefined, zindex=Undefined)View on GitHub

Return a chart with title config updated.

Parameters:

• align (Align_T) – Horizontal text alignment for title text. One of "left", "center", or "right".

• anchor (TitleAnchor_T) – The anchor position for placing the title and subtitle text. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

• angle (float | ExprRef | dict[str, Any]) – Angle in degrees of title and subtitle text.

• baseline (Baseline_T) – Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", or "bottom".

• color (str | ExprRef | dict[str, Any]) – Text color for title text.

• dx (float) – Delta offset for title and subtitle text x-coordinate.

• dy (float) – Delta offset for title and subtitle text y-coordinate.

• font (str) – Font name for title text.

• fontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for title text.

• fontStyle (FontStyle_T) – Font style for title text.

• fontWeight (FontWeight_T) – Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• frame (TitleFrame_T) – The reference frame for the title anchor. "group" anchors the title along the plot area. "bounds" anchors the title along the full bounds, including axes, legends, and other reserved space. __Default value:__ "group"

• offset (float) – The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.

• orient (TitleOrient_T) – Default title orientation ("none", "top", "bottom", "left", or "right")

• reserve (bool) – Whether the title reserves layout space outside the plot area. Reserved titles are placed outside axes, legends, and other guide space on the same side. Setting this to false lets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__ true

• style (str | Sequence[str]) – A mark style property to apply to the title text mark. If not specified, a default style of "group-title" is applied.

• subtitle (str | ExprRef | dict[str, Any]) – The subtitle text.

• subtitleColor (str | ExprRef | dict[str, Any]) – Text color for subtitle text.

• subtitleFont (str) – Font name for subtitle text.

• subtitleFontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for subtitle text.

• subtitleFontStyle (FontStyle_T) – Font style for subtitle text.

• subtitleFontWeight (FontWeight_T) – Font weight for subtitle text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• subtitlePadding (float) – Padding in pixels between title and subtitle text. __Default value:__ 3

• zindex (float) – Z-order of the title relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 1

configure_view(value=Undefined, /, *, continuousHeight=Undefined, continuousWidth=Undefined, discreteHeight=Undefined, discreteWidth=Undefined, fill=Undefined, fillOpacity=Undefined, shadowBlur=Undefined, shadowColor=Undefined, shadowOffsetX=Undefined, shadowOffsetY=Undefined, shadowOpacity=Undefined, step=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, strokeZindex=Undefined, zindex=Undefined)View on GitHub

Return a chart with view config updated.

Parameters:

• continuousHeight (float) – The default height when the view has a continuous y scale. __Default value:__ "container"

• continuousWidth (float) – The default width when the view has a continuous x scale. __Default value:__ "container"

• discreteHeight (float | Step | StepKwds) – The default height when the view has a discrete y scale or no y scale. This may be a fixed height or a step size for each discrete domain value. __Default value:__ "container"

• discreteWidth (float | Step | StepKwds) – The default width when the view has a discrete x scale or no x scale. This may be a fixed width or a step size for each discrete domain value. __Default value:__ "container"

• fill (str) – Fill color of the view background.

• fillOpacity (float) – Opacity of the view background fill.

• shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value: 0

• shadowColor (str | ExprRef | dict[str, Any]) – The color of the drop shadow. Any valid CSS color string is allowed. Default value: "black"

• shadowOffsetX (float | ExprRef | dict[str, Any]) – The horizontal offset of the drop shadow in pixels. Positive values move the shadow to the right. Default value: 0

• shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value: 0

• shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between 0 (fully transparent) and 1 (fully opaque). Default value: 0 (disabled)

• step (float | ExprRef | dict[str, Any]) – Default step size for discrete view sizes. __Default value:__ none

• stroke (str) – Stroke color of the view background.

• strokeOpacity (float) – Opacity of the view background stroke.

• strokeWidth (float) – Stroke width of the view background border.

• strokeZindex (float) – Z-order of the stroke relative to the view content. Values greater than 0 render the stroke after the view marks. Values less than or equal to 0 render before the marks. The default value depends on the element type.

• zindex (float) – Z-order relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. The default value depends on the element type.

copy(*, deep=True, assembly=Undefined, axes=Undefined, background=Undefined, baseUrl=Undefined, config=Undefined, cursor=Undefined, data=Undefined, datasets=Undefined, description=Undefined, domainInert=Undefined, encoding=Undefined, genome=Undefined, genomes=Undefined, height=Undefined, layer=Undefined, legends=Undefined, name=Undefined, opacity=Undefined, overhang=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, scales=Undefined, templates=Undefined, theme=Undefined, title=Undefined, transform=Undefined, view=Undefined, viewportHeight=Undefined, viewportWidth=Undefined, visible=Undefined, width=Undefined, zindex=Undefined)View on GitHub

Return a copy with updated top-level properties.

Parameters:

• assembly (str) – Default assembly for locus scales that do not define scale.assembly. Can reference either a key in genomes or a built-in assembly name.

• axes (AxesKwds) – Defines properties for axis resolutions used by this view subtree. Use this when a composed view shares an axis across child views and the axis settings belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error.

• background (str) – Background color of the canvas.

• baseUrl (str) – The base URL for relative URL data sources and URL imports. The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view’s base URL equals to the visualization specification’s base URL.

• config (GenomeSpyConfig | GenomeSpyConfigKwds) – Configures defaults for this view subtree. Properties in child views override properties inherited from ancestors.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is inside the view. The deepest matching cursor wins: mark cursor first, then the pointed view, then ancestor views outward toward the root. __Default value:__ browser default

• data (Any) – Specifies a data source. If omitted, the data source is inherited from the parent view.

• datasets (dict[str, Any]) – Named datasets available to this view and its descendants. A descendant declaration with the same name shadows this declaration. Declare named data here to establish reliable lexical scope and enable scoped runtime updates.

• description (str | Sequence[str]) – A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the GenomeSpy App.

• domainInert (bool) – If true, this view and its descendants do not contribute to scale domains. Child views inherit this flag automatically. Default value: false

• encoding (Encoding | EncodingKwds) – Specifies how data are encoded using the visual channels.

• genome (UrlGenomeConfig | dict[str, Any] | InlineGenomeConfig | GenomeConfigBase) – Schema-defined genome property.

• genomes (dict[str, Any]) – Named genome assembly definitions. Each object key is the assembly name.

• height (SizeDef | SizeDefKwds | float | Step | StepKwds | ExprRef | dict[str, Any] | Literal['container']) – Height of the view. If a number, it is interpreted as pixels. If an expression reference is provided, it must resolve to a number or "container". Check child sizing for details. Default value: "container"

• layer (Sequence[LayerSpec | dict[str, Any] | UnitSpec | MultiscaleSpec | ImportSpec]) – Schema-defined layer property.

• legends (LegendsKwds) – Defines properties for legend resolutions used by this view subtree. Use this when a composed view shares a legend across child views and the legend settings belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error.

• name (str) – An explicit name used to address the view. It is recommended to keep names unique among siblings. In the App (where view state is bookmarkable), the name must be unique within its import scope for views with configurable visibility, etc.

• opacity (float | DynamicOpacity | DynamicOpacityKwds | ExprRef | dict[str, Any]) – Opacity of the view and all its children. This can be: - a fixed number between 0 and 1 - an expression reference (ExprRef) - a DynamicOpacity definition for zoom-dependent opacity Dynamic opacity is useful for semantic zooming where layers are faded in and out as the user zooms. Example: `json "opacity": { "unitsPerPixel": [100000, 40000], "values": [0, 1] } ` In this example, the view fades in while zooming in from 100 000 to 40 000 units per pixel. __Default value:__ 1.0

• overhang (OverhangConfig | dict[str, Any]) – Controls whether external overhang on each edge reserves layout space. Setting an edge to false lets axes, titles, legends, or custom view overhang overlap nearby content while remaining visible. Default value: all edges reserve overhang

• padding (Paddings | PaddingsKwds | float) – Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge. Examples: - padding: 10 - padding: { top: 10, right: 20, bottom: 10, left: 20 } Default value: 0

• params (Sequence[PlainValueParameter | dict[str, Any] | TransitionedValueParameter | ExprParameter | SelectionParameter | RulerParameter]) – Dynamic variables that parameterize a visualization.

• resolve (ResolveKwds) – Specifies how scales, axes, and legends are resolved in the view hierarchy. If legend resolution is not configured explicitly, it follows the corresponding scale resolution.

• scales (ScalesKwds) – Defines properties for scale resolutions used by this view subtree. Use this when a composed view shares a scale across child views and the scale settings, such as the visible domain, belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error. Expression references in these scale properties use this view’s parameter scope and can access parameters declared here or on ancestors.

• templates (dict[str, Any]) – Schema-defined templates property.

• theme (BuiltInThemeName_T | Sequence[BuiltInThemeName_T]) – Selects built-in theme preset(s) for the whole visualization.

• title (str | Title | TitleKwds) – View title.

• transform (Sequence[AlignmentMismatchesParams | dict[str, Any] | AggregateParams | CollectParams | CoverageParams | CoordinateLookupParams | CrossParams | Displace1DParams | FlattenDelimitedParams | FormulaParams | LookupParams | ExprFilterParams | SelectionFilterParams | AxisLabelLayoutParams | FilterScoredLabelsParams | FlattenParams | FlattenCompressedExonsParams | FlattenCigarParams | FlattenSequenceParams | IdentifierParams | LinearizeGenomicCoordinateParams | MeasureTextParams | TruncateTextParams | PackLegendLabelsParams | MergeFacetsParams | PileupParams | ProjectParams | RegexExtractParams | RegexFoldParams | SampleParams | SetIntersectionParams | StackParams | WindowParams]) – An array of transformations applied to the data before visual encoding.

• view (ViewBackground | ViewBackgroundKwds) – Schema-defined view property.

• viewportHeight (SizeDef | SizeDefKwds | float | ExprRef | dict[str, Any] | Literal['container']) – Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping. If an expression reference is provided, it must resolve to a number or "container". Default: null (same as height)

• viewportWidth (SizeDef | SizeDefKwds | float | ExprRef | dict[str, Any] | Literal['container']) – Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping. If an expression reference is provided, it must resolve to a number or "container". Default: null (same as width)

• visible (bool) – The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see toggleable view visibility. Default: true

• width (SizeDef | SizeDefKwds | float | Step | StepKwds | ExprRef | dict[str, Any] | Literal['container']) – Width of the view. If a number, it is interpreted as pixels. If an expression reference is provided, it must resolve to a number or "container". Check child sizing for details. Default: "container"

• zindex (float) – Z-order among sibling views in a composition. Higher values render later. Views with equal values render in declaration order. This does not affect layout order. __Default value:__ 0

cursor(value=Undefined, /, *, expr=Undefined)View on GitHub

Return a copy with a ExprRef cursor.

Parameters:

expr (str) – The expression string.

data(value)View on GitHub

Return a copy with data updated.

datasets(value)View on GitHub

Return a copy with datasets updated.

description(value)View on GitHub

Return a copy with description updated.

display(*, bundle_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/bundle/index.es.js', embed_options=None, controls=Undefined, controls_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/src/controls.js', inspector_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/inspector@0.87.0/dist/index.es.js')View on GitHub

Display this chart once with temporary rendering options.

Description:

This mirrors Altair’s display-time configuration: the supplied options affect this display call without changing chart JSON.

Parameters:

• bundle_url – Browser module containing GenomeSpy’s embed function.

• embed_options – Options passed directly to embed.

• controls – Controls to mount, True for defaults, or False to disable them.

• controls_module_url – Browser module containing Core controls.

• inspector_module_url – Browser module containing the Inspector control.

Returns:

None.

Raises:

• ImportError – If IPython is unavailable.

• TypeError – If the controls value has an invalid type.

• ValueError – If a control name is unknown or duplicated.

Example

>>> chart.display(controls=False)

domainInert(value)View on GitHub

Return a copy with domainInert updated.

encode(*args, angle=Undefined, color=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a new specification with merged channel encodings.

Parameters:

• angle (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Rotation angle of point and text marks.

• color (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Color of the marks – either fill or stroke color based on the filled property of mark definition. Note: 1) For fine-grained control over both fill and stroke colors of the marks, please use the fill and stroke channels. The fill or stroke encodings have higher precedence than color, thus may override the color encoding if conflicting encodings are specified. 2) See the GenomeSpy scale documentation for more information about customizing color schemes.

• direction (DirectionDef | dict[str, Any]) – Direction of arrow marks. Encoded values are mapped with a discrete scale whose range values must be "forward" or "reverse". This channel is supported by arrow marks only and does not create a legend.

• dx (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy horizontal pixel offset for point marks.

• dy (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy vertical pixel offset for point marks. Positive values move in the opposite direction from yOffset.

• facetIndex (FieldDefWithoutScale | dict[str, Any]) – For internal use

• fill (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Fill color of the marks. Note: The fill encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

• fillOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Fill opacity of the marks.

• key (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more data fields that uniquely identify rows for stable point selections and bookmarking across sessions. Unlike uniqueId (an implicit surrogate key), key fields must be stable in the source data. Use a single field definition for simple keys, or an array of field definitions for composite keys. For composite keys, field order is significant.

• opacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Opacity of the marks.

• sample (FieldDefWithoutScale | dict[str, Any]) – Facet identifier for interactive filtering, sorting, and grouping in the App.

• search (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more fields used by the App’s location/search input to match rows in this view. Use a single field definition for simple search, or an array for matching against multiple fields. A row matches when any configured search field matches the entered term.

• semanticScore (dict[str, Any]) – Schema-defined semanticScore property.

• shape (FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefTypeForShape | ValueDefWithConditionStringNullTypeForShape) – Shape of the mark. For point marks the supported values include: - plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left". - stroke-only "x" and "+" shapes, whose line thickness is controlled by strokeWidth - centered directional shape "triangle"

• size (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Size of the mark. - For "point" – the symbol size, or pixel area of the mark. - For "text" – the text’s font size. - For "arrow" – the stem thickness in pixels.

• stroke (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Stroke color of the marks. Note: The stroke encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

• strokeOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke opacity of the marks.

• strokeWidth (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke width of the marks.

• text (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString) – Text of the text mark.

• tooltip (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString | Sequence[StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString] | None) – Fields, expressions, or values shown by the default tooltip handler. If omitted, the default tooltip handler shows the hovered datum’s properties. If null, the default tooltip handler shows no raw datum rows for this mark. Use an array to show multiple rows in a specific order.

• uniqueId (FieldDefWithoutScale | dict[str, Any]) – For internal use

• x (dict[str, Any] | None) – X coordinates of the marks. The value of this channel can be a number between zero and one.

• x2 (Position2Def | dict[str, Any] | None) – X2 coordinates of the marks. The value of this channel can be a number between zero and one.

• xOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Horizontal offset from the encoded x position, in logical pixels.

• y (PositionFieldDef | dict[str, Any] | ChromPosDef | PositionDatumDef | PositionExprDef | ValueDefNumber | None) – Y coordinates of the marks. The value of this channel can be a number between zero and one.

• y2 (Position2Def | dict[str, Any] | None) – Y2 coordinates of the marks. The value of this channel can be a number between zero and one.

• yOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Vertical offset from the encoded y position, in logical pixels.

encoding(value=Undefined, /, *, angle=Undefined, color=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a copy with a Encoding encoding.

Parameters:

• angle (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Rotation angle of point and text marks.

• color (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Color of the marks – either fill or stroke color based on the filled property of mark definition. Note: 1) For fine-grained control over both fill and stroke colors of the marks, please use the fill and stroke channels. The fill or stroke encodings have higher precedence than color, thus may override the color encoding if conflicting encodings are specified. 2) See the GenomeSpy scale documentation for more information about customizing color schemes.

• direction (DirectionDef | dict[str, Any]) – Direction of arrow marks. Encoded values are mapped with a discrete scale whose range values must be "forward" or "reverse". This channel is supported by arrow marks only and does not create a legend.

• dx (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy horizontal pixel offset for point marks.

• dy (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef) – Legacy vertical pixel offset for point marks. Positive values move in the opposite direction from yOffset.

• facetIndex (FieldDefWithoutScale | dict[str, Any]) – For internal use

• fill (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Fill color of the marks. Note: The fill encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

• fillOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Fill opacity of the marks.

• key (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more data fields that uniquely identify rows for stable point selections and bookmarking across sessions. Unlike uniqueId (an implicit surrogate key), key fields must be stable in the source data. Use a single field definition for simple keys, or an array of field definitions for composite keys. For composite keys, field order is significant.

• opacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Opacity of the marks.

• sample (FieldDefWithoutScale | dict[str, Any]) – Facet identifier for interactive filtering, sorting, and grouping in the App.

• search (FieldDefWithoutScale | dict[str, Any] | Sequence[FieldDefWithoutScale | dict[str, Any]]) – One or more fields used by the App’s location/search input to match rows in this view. Use a single field definition for simple search, or an array for matching against multiple fields. A row matches when any configured search field matches the entered term.

• semanticScore (dict[str, Any]) – Schema-defined semanticScore property.

• shape (FieldOrDatumDefWithConditionMarkPropFieldDefTypeForShapeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefTypeForShape | ValueDefWithConditionStringNullTypeForShape) – Shape of the mark. For point marks the supported values include: - plotting shapes: "circle", "square", "cross", "diamond", "triangle-up", "triangle-down", "triangle-right", or "triangle-left". - stroke-only "x" and "+" shapes, whose line thickness is controlled by strokeWidth - centered directional shape "triangle"

• size (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Size of the mark. - For "point" – the symbol size, or pixel area of the mark. - For "text" – the text’s font size. - For "arrow" – the stem thickness in pixels.

• stroke (FieldOrDatumDefWithConditionMarkPropFieldDefTypeStringNull | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefStringNull | MarkPropExprDefType | ValueDefWithConditionStringNullType) – Stroke color of the marks. Note: The stroke encoding has higher precedence than color, thus may override the color encoding if conflicting encodings are specified.

• strokeOpacity (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke opacity of the marks.

• strokeWidth (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType) – Stroke width of the marks.

• text (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString) – Text of the text mark.

• tooltip (StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString | Sequence[StringFieldDef | dict[str, Any] | StringDatumDef | ExprDef | ValueDefString] | None) – Fields, expressions, or values shown by the default tooltip handler. If omitted, the default tooltip handler shows the hovered datum’s properties. If null, the default tooltip handler shows no raw datum rows for this mark. Use an array to show multiple rows in a specific order.

• uniqueId (FieldDefWithoutScale | dict[str, Any]) – For internal use

• x (dict[str, Any] | None) – X coordinates of the marks. The value of this channel can be a number between zero and one.

• x2 (Position2Def | dict[str, Any] | None) – X2 coordinates of the marks. The value of this channel can be a number between zero and one.

• xOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Horizontal offset from the encoded x position, in logical pixels.

• y (PositionFieldDef | dict[str, Any] | ChromPosDef | PositionDatumDef | PositionExprDef | ValueDefNumber | None) – Y coordinates of the marks. The value of this channel can be a number between zero and one.

• y2 (Position2Def | dict[str, Any] | None) – Y2 coordinates of the marks. The value of this channel can be a number between zero and one.

• yOffset (FieldOrDatumDefWithConditionMarkPropFieldDefTypeNumber | dict[str, Any] | FieldOrDatumDefWithConditionScaleDatumDefNumber | MarkPropExprDefType | ValueDefWithConditionNumberType | MarkPropExprDef | None) – Vertical offset from the encoded y position, in logical pixels.

classmethod from_dict(spec, *, validate=True)View on GitHub

Construct a renderable chart from a GenomeSpy specification.

Parameters:

• spec – Complete GenomeSpy specification.

• validate – Validate the input against the generated root schema.

Returns:

A chart matching the specification’s structural root variant.

Raises:

• SchemaValidationError – If validation fails.

• TypeError – If the specification is not a mapping.

• ValueError – If no supported root structure is present.

Example

>>> chart = TopLevelSpec.from_dict({"mark": "point"})

classmethod from_json(json_string, *, validate=True)View on GitHub

Construct a renderable chart from a JSON specification.

Parameters:

• json_string – JSON-encoded GenomeSpy specification.

• validate – Validate the input against the generated root schema.

Returns:

A chart matching the specification’s structural root variant.

Raises:

• json.JSONDecodeError – If json_string is invalid JSON.

• SchemaValidationError – If schema validation fails.

• TypeError – If the decoded value is not a mapping.

• ValueError – If no supported root structure is present.

Example

>>> chart = TopLevelSpec.from_json('{"mark": "point"}')

height(value=Undefined, /, *, grow=Undefined, maxPx=Undefined, minPx=Undefined, px=Undefined)View on GitHub

Return a copy with a SizeDef height.

Parameters:

• grow (float) – Share of the remaining space. See child sizing for details.

• maxPx (float) – Maximum size in pixels.

• minPx (float) – Minimum size in pixels.

• px (float) – Size in pixels

layer(value)View on GitHub

Return a copy with layer updated.

legends(value)View on GitHub

Return a copy with legends updated.

name(value)View on GitHub

Return a copy with name updated.

opacity(value)View on GitHub

Return a copy with opacity updated.

overhang(value=Undefined, /, *, bottom=Undefined, left=Undefined, right=Undefined, top=Undefined)View on GitHub

Return a copy with a OverhangConfig overhang.

Parameters:

• bottom (bool) – Schema-defined bottom property.

• left (bool) – Schema-defined left property.

• right (bool) – Schema-defined right property.

• top (bool) – Schema-defined top property.

padding(value)View on GitHub

Return a copy with padding updated.

params(value)View on GitHub

Return a copy with params updated.

properties(*, assembly=Undefined, axes=Undefined, background=Undefined, baseUrl=Undefined, config=Undefined, cursor=Undefined, data=Undefined, datasets=Undefined, description=Undefined, domainInert=Undefined, encoding=Undefined, genome=Undefined, genomes=Undefined, height=Undefined, layer=Undefined, legends=Undefined, name=Undefined, opacity=Undefined, overhang=Undefined, padding=Undefined, params=Undefined, resolve=Undefined, scales=Undefined, templates=Undefined, theme=Undefined, title=Undefined, transform=Undefined, view=Undefined, viewportHeight=Undefined, viewportWidth=Undefined, visible=Undefined, width=Undefined, zindex=Undefined)View on GitHub

Return a new specification with updated top-level properties.

Parameters:

• assembly (str) – Default assembly for locus scales that do not define scale.assembly. Can reference either a key in genomes or a built-in assembly name.

• axes (AxesKwds) – Defines properties for axis resolutions used by this view subtree. Use this when a composed view shares an axis across child views and the axis settings belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error.

• background (str) – Background color of the canvas.

• baseUrl (str) – The base URL for relative URL data sources and URL imports. The base URLs are inherited in the view hierarchy unless overridden with this property. By default, the top-level view’s base URL equals to the visualization specification’s base URL.

• config (GenomeSpyConfig | GenomeSpyConfigKwds) – Configures defaults for this view subtree. Properties in child views override properties inherited from ancestors.

• cursor (str | ExprRef | dict[str, Any]) – Mouse cursor shown while the pointer is inside the view. The deepest matching cursor wins: mark cursor first, then the pointed view, then ancestor views outward toward the root. __Default value:__ browser default

• data (Any) – Specifies a data source. If omitted, the data source is inherited from the parent view.

• datasets (dict[str, Any]) – Named datasets available to this view and its descendants. A descendant declaration with the same name shadows this declaration. Declare named data here to establish reliable lexical scope and enable scoped runtime updates.

• description (str | Sequence[str]) – A description of the view. Can be used for documentation. The description of the top-level view is shown in the toolbar of the GenomeSpy App.

• domainInert (bool) – If true, this view and its descendants do not contribute to scale domains. Child views inherit this flag automatically. Default value: false

• encoding (Encoding | EncodingKwds) – Specifies how data are encoded using the visual channels.

• genome (UrlGenomeConfig | dict[str, Any] | InlineGenomeConfig | GenomeConfigBase) – Schema-defined genome property.

• genomes (dict[str, Any]) – Named genome assembly definitions. Each object key is the assembly name.

• height (SizeDef | SizeDefKwds | float | Step | StepKwds | ExprRef | dict[str, Any] | Literal['container']) – Height of the view. If a number, it is interpreted as pixels. If an expression reference is provided, it must resolve to a number or "container". Check child sizing for details. Default value: "container"

• layer (Sequence[LayerSpec | dict[str, Any] | UnitSpec | MultiscaleSpec | ImportSpec]) – Schema-defined layer property.

• legends (LegendsKwds) – Defines properties for legend resolutions used by this view subtree. Use this when a composed view shares a legend across child views and the legend settings belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error.

• name (str) – An explicit name used to address the view. It is recommended to keep names unique among siblings. In the App (where view state is bookmarkable), the name must be unique within its import scope for views with configurable visibility, etc.

• opacity (float | DynamicOpacity | DynamicOpacityKwds | ExprRef | dict[str, Any]) – Opacity of the view and all its children. This can be: - a fixed number between 0 and 1 - an expression reference (ExprRef) - a DynamicOpacity definition for zoom-dependent opacity Dynamic opacity is useful for semantic zooming where layers are faded in and out as the user zooms. Example: `json "opacity": { "unitsPerPixel": [100000, 40000], "values": [0, 1] } ` In this example, the view fades in while zooming in from 100 000 to 40 000 units per pixel. __Default value:__ 1.0

• overhang (OverhangConfig | dict[str, Any]) – Controls whether external overhang on each edge reserves layout space. Setting an edge to false lets axes, titles, legends, or custom view overhang overlap nearby content while remaining visible. Default value: all edges reserve overhang

• padding (Paddings | PaddingsKwds | float) – Padding applied to the view. Accepts either a number representing pixels or an object specifying separate paddings for each edge. Examples: - padding: 10 - padding: { top: 10, right: 20, bottom: 10, left: 20 } Default value: 0

• params (Sequence[PlainValueParameter | dict[str, Any] | TransitionedValueParameter | ExprParameter | SelectionParameter | RulerParameter]) – Dynamic variables that parameterize a visualization.

• resolve (ResolveKwds) – Specifies how scales, axes, and legends are resolved in the view hierarchy. If legend resolution is not configured explicitly, it follows the corresponding scale resolution.

• scales (ScalesKwds) – Defines properties for scale resolutions used by this view subtree. Use this when a composed view shares a scale across child views and the scale settings, such as the visible domain, belong to the composed view rather than an individual encoding. An ancestor declaration shadows the whole declaration of a descendant that targets the same resolution. Declarations in separate sibling subtrees are ambiguous and cause an error. Expression references in these scale properties use this view’s parameter scope and can access parameters declared here or on ancestors.

• templates (dict[str, Any]) – Schema-defined templates property.

• theme (BuiltInThemeName_T | Sequence[BuiltInThemeName_T]) – Selects built-in theme preset(s) for the whole visualization.

• title (str | Title | TitleKwds) – View title.

• transform (Sequence[AlignmentMismatchesParams | dict[str, Any] | AggregateParams | CollectParams | CoverageParams | CoordinateLookupParams | CrossParams | Displace1DParams | FlattenDelimitedParams | FormulaParams | LookupParams | ExprFilterParams | SelectionFilterParams | AxisLabelLayoutParams | FilterScoredLabelsParams | FlattenParams | FlattenCompressedExonsParams | FlattenCigarParams | FlattenSequenceParams | IdentifierParams | LinearizeGenomicCoordinateParams | MeasureTextParams | TruncateTextParams | PackLegendLabelsParams | MergeFacetsParams | PileupParams | ProjectParams | RegexExtractParams | RegexFoldParams | SampleParams | SetIntersectionParams | StackParams | WindowParams]) – An array of transformations applied to the data before visual encoding.

• view (ViewBackground | ViewBackgroundKwds) – Schema-defined view property.

• viewportHeight (SizeDef | SizeDefKwds | float | ExprRef | dict[str, Any] | Literal['container']) – Optional viewport height of the view. If the view size exceeds the viewport height, it will be shown with scrollbars. This property implicitly enables clipping. If an expression reference is provided, it must resolve to a number or "container". Default: null (same as height)

• viewportWidth (SizeDef | SizeDefKwds | float | ExprRef | dict[str, Any] | Literal['container']) – Optional viewport width of the view. If the view size exceeds the viewport width, it will be shown with scrollbars. This property implicitly enables clipping. If an expression reference is provided, it must resolve to a number or "container". Default: null (same as width)

• visible (bool) – The default visibility of the view. An invisible view is removed from the layout and not rendered. For context, see toggleable view visibility. Default: true

• width (SizeDef | SizeDefKwds | float | Step | StepKwds | ExprRef | dict[str, Any] | Literal['container']) – Width of the view. If a number, it is interpreted as pixels. If an expression reference is provided, it must resolve to a number or "container". Check child sizing for details. Default: "container"

• zindex (float) – Z-order among sibling views in a composition. Higher values render later. Views with equal values render in declaration order. This does not affect layout order. __Default value:__ 0

resolve(value)View on GitHub

Return a copy with resolve updated.

resolve_axis(*, angle=Undefined, color=Undefined, default=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a copy with merged axis resolutions.

resolve_legend(*, angle=Undefined, color=Undefined, default=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a copy with merged legend resolutions.

classmethod resolve_references()View on GitHub

Return this class schema with referenced properties merged in.

resolve_scale(*, angle=Undefined, color=Undefined, default=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, facetIndex=Undefined, fill=Undefined, fillOpacity=Undefined, key=Undefined, opacity=Undefined, sample=Undefined, search=Undefined, semanticScore=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, text=Undefined, tooltip=Undefined, uniqueId=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a copy with merged scale resolutions.

save(path, *, format=None, bundle_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/bundle/index.es.js', embed_options=None, controls=Undefined, controls_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/src/controls.js', inspector_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/inspector@0.87.0/dist/index.es.js')View on GitHub

Save the chart as JSON or HTML.

Description:

The filename suffix selects the format unless format is given. Rendering controls and embed options apply only to HTML output.

Parameters:

• path – Destination path.

• format – Explicit "json" or "html" format.

• bundle_url – Browser module containing GenomeSpy’s embed function.

• embed_options – Options passed directly to embed for HTML output.

• controls – HTML controls, True for defaults, or False to disable them.

• controls_module_url – Browser module containing Core controls.

• inspector_module_url – Browser module containing the Inspector control.

Returns:

None.

Raises:

ValueError – If the format is unsupported or HTML-only options are supplied for JSON output.

Example

>>> chart.save("chart.html", controls=False)

scales(value)View on GitHub

Return a copy with scales updated.

property specView on GitHub

Return the rendered GenomeSpy specification with JSON display.

templates(value)View on GitHub

Return a copy with templates updated.

title(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, frame=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, subtitle=Undefined, subtitleColor=Undefined, subtitleFont=Undefined, subtitleFontSize=Undefined, subtitleFontStyle=Undefined, subtitleFontWeight=Undefined, subtitlePadding=Undefined, text=Undefined, zindex=Undefined)View on GitHub

Return a copy with a Title title.

Parameters:

• align (Align_T) – Horizontal text alignment for title text. One of "left", "center", or "right".

• anchor (TitleAnchor_T) – The anchor position for placing the title and subtitle text. One of "start", "middle", or "end". For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

• angle (float | ExprRef | dict[str, Any]) – Angle in degrees of title and subtitle text.

• baseline (Baseline_T) – Vertical text baseline for title and subtitle text. One of "alphabetic" (default), "top", "middle", or "bottom".

• color (str | ExprRef | dict[str, Any]) – Text color for title text.

• dx (float) – Delta offset for title and subtitle text x-coordinate.

• dy (float) – Delta offset for title and subtitle text y-coordinate.

• font (str) – Font name for title text.

• fontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for title text.

• fontStyle (FontStyle_T) – Font style for title text.

• fontWeight (FontWeight_T) – Font weight for title text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• frame (TitleFrame_T) – The reference frame for the title anchor. "group" anchors the title along the plot area. "bounds" anchors the title along the full bounds, including axes, legends, and other reserved space. __Default value:__ "group"

• offset (float) – The orthogonal offset in pixels by which to displace the title group from its position along the edge of the chart.

• orient (TitleOrient_T) – Default title orientation ("none", "top", "bottom", "left", or "right")

• reserve (bool) – Whether the title reserves layout space outside the plot area. Reserved titles are placed outside axes, legends, and other guide space on the same side. Setting this to false lets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__ true

• style (str | Sequence[str]) – A mark style property to apply to the title text mark. If not specified, a default style of "group-title" is applied.

• subtitle (str | ExprRef | dict[str, Any]) – The subtitle text.

• subtitleColor (str | ExprRef | dict[str, Any]) – Text color for subtitle text.

• subtitleFont (str) – Font name for subtitle text.

• subtitleFontSize (float | ExprRef | dict[str, Any]) – Font size in pixels for subtitle text.

• subtitleFontStyle (FontStyle_T) – Font style for subtitle text.

• subtitleFontWeight (FontWeight_T) – Font weight for subtitle text. This can be either a string (e.g "bold", "normal") or a number (100, 200, 300, …, 900 where "normal" = 400 and "bold" = 700).

• subtitlePadding (float) – Padding in pixels between title and subtitle text. __Default value:__ 3

• text (str | ExprRef | dict[str, Any]) – The title text.

• zindex (float) – Z-order of the title relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 1

to_dict(*, include_schema=True, validate=True)View on GitHub

Serialize the spec to a JSON-compatible dictionary.

to_html(*, bundle_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/bundle/index.es.js', embed_options=None, controls=Undefined, controls_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/src/controls.js', inspector_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/inspector@0.87.0/dist/index.es.js', container_id=None)View on GitHub

Render the chart as an HTML snippet.

Description:

The snippet loads the pinned GenomeSpy browser modules. Controls affect only this HTML representation and are not serialized into the chart specification.

Parameters:

• bundle_url – Browser module containing GenomeSpy’s embed function.

• embed_options – Options passed directly to embed.

• controls – Controls to mount, True for defaults, or False to disable them.

• controls_module_url – Browser module containing Core controls.

• inspector_module_url – Browser module containing the Inspector control.

• container_id – Optional HTML id for the chart container.

Returns:

An HTML snippet containing the chart specification and embed code.

Raises:

• TypeError – If the controls value has an invalid type.

• ValueError – If a control name is unknown or duplicated.

Example

>>> chart.to_html(controls=["svg", "png"])

to_json(*, include_schema=True, validate=True)View on GitHub

Serialize the spec to formatted JSON.

transform(*transforms)View on GitHub

Add one or more arbitrary GenomeSpy transforms.

Description:

Use this generic method when GenomeSpy supports a transform that does not yet have a dedicated handwritten helper in the Python API. Each transform may be a raw mapping or a generated schema wrapper.

Parameters:

*transforms – One or more transform definitions.

Returns:

A new spec with the transforms appended in order.

Raises:

TypeError – If a transform is not a mapping or schema wrapper.

Example

>>> chart.transform({"type": "collect", "sort": {"field": ["x"]}})

transform_aggregate(*, as_=Undefined, description=Undefined, fields=Undefined, groupby=Undefined, ops=Undefined)View on GitHub

Add a aggregate transform.

Parameters:

• as_ (Sequence[str]) – The names for the output fields corresponding to each aggregated field. If not provided, names will be automatically created using the operation and field names (e.g., sum_field, average_field).

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• fields (Sequence[Field_T]) – The data fields to apply aggregate functions to. This array should correspond with the ops and as arrays. If no fields or operations are specified, a count aggregation will be applied by default.

• groupby (Sequence[Field_T]) – The fields by which to group the data. If these are not defined, all rows will be grouped into a single category.

• ops (Sequence[AggregateOp_T]) – The aggregation operations to be performed on the fields, such as "sum", "q1", "median", "q3", or "count".

transform_alignment_mismatches(*, cigar=Undefined, copyFields=Undefined, description=Undefined, md=Undefined, quality=Undefined, sequence=Undefined, start=Undefined)View on GitHub

Add a alignmentMismatches transform.

Parameters:

• cigar (Field_T) – The CIGAR string. __Default value:__ "cigar"

• copyFields (Sequence[str]) – Top-level input fields copied to the emitted mismatch rows. If omitted, all input fields are copied. This can be used to avoid copying bulky fields such as read sequence or base quality arrays while still allowing the transform to read its input fields.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• md (Field_T) – MD tag field. __Default value:__ "md"

• quality (Field_T) – Base quality field. __Default value:__ "qual"

• sequence (Field_T) – Read sequence field. __Default value:__ "seq"

• start (Field_T) – The read’s reference start coordinate. __Default value:__ "start"

transform_axis_label_layout(*, channel, labelAlign, labelAngle, labelBaseline, labelFlush, labelFlushOffset, labelFlushZoomExtent, labelFontSize, labelOffset, labelOverlap, labelSeparation, labelVisible, labelWidth, chromLabelAlign=Undefined, chromLabelPadding=Undefined, chromLabelSpacing=Undefined, chromLabelWidth=Undefined, description=Undefined)View on GitHub

Add a axisLabelLayout transform.

Parameters:

• channel (PrimaryPositionalChannel_T) – Schema-defined channel property.

• labelAlign (Literal['left', 'center', 'right']) – Schema-defined labelAlign property.

• labelAngle (float) – Schema-defined labelAngle property.

• labelBaseline (Baseline_T) – Schema-defined labelBaseline property.

• labelFlush (Literal[False] | float) – Schema-defined labelFlush property.

• labelFlushOffset (float) – Schema-defined labelFlushOffset property.

• labelFlushZoomExtent (bool) – Schema-defined labelFlushZoomExtent property.

• labelFontSize (float) – Schema-defined labelFontSize property.

• labelOffset (str) – Schema-defined labelOffset property.

• labelOverlap (Literal[False, 'auto', 'parity', 'greedy']) – Schema-defined labelOverlap property.

• labelSeparation (float) – Schema-defined labelSeparation property.

• labelVisible (str) – Schema-defined labelVisible property.

• labelWidth (Field_T) – Schema-defined labelWidth property.

• chromLabelAlign (Literal['left', 'center', 'right']) – Schema-defined chromLabelAlign property.

• chromLabelPadding (float) – Schema-defined chromLabelPadding property.

• chromLabelSpacing (float) – Schema-defined chromLabelSpacing property.

• chromLabelWidth (Field_T) – Schema-defined chromLabelWidth property.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_calculate(as_=Undefined, calculate=Undefined, **kwargs)View on GitHub

Add one or more formula transforms.

Pass both direct arguments for one transform, or use keyword arguments to append one transform per output in insertion order.

Parameters:

• as_ (str) – The (new) field where the computed value is written to

• calculate (str) – An expression string

• **kwargs (str | ExpressionOperand) – Additional output field names mapped to calculate values.

Returns:

A new specification with the transform or transforms appended.

Return type:

Self

Raises:

TypeError – If only one of as_ and calculate is provided.

Example

>>> chart.transform_calculate(doubled="datum.value * 2")

transform_collect(*, description=Undefined, groupby=Undefined, sort=Undefined)View on GitHub

Add a collect transform.

Parameters:

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• groupby (Sequence[Field_T]) – Arranges the data into consecutive batches based on the groups. This is mainly intended for internal use so that faceted data can be handled as batches.

• sort (CompareParams | CompareParamsKwds) – The sort order.

transform_coordinate_lookup(*, from_, key, as_=Undefined, channel=Undefined, default=Undefined, description=Undefined, fields=Undefined, values=Undefined)View on GitHub

Add a coordinateLookup transform.

Parameters:

• from_ (CoordinateLookupInput | dict[str, Any]) – The lazy side input and its optional transforms. Rows outside the loaded side-input domain are not passed through.

• key (Field_T | Sequence[Field_T]) – Coordinate field or [chrom, pos] fields in the lazy side input. The same fields in the primary data determine both the exact match and whether a row is within the loaded side-input interval.

• as_ (Sequence[str]) – Output field names. Defaults to values. Requires an explicit values array.

• channel (PrimaryPositionalChannel_T) – The positional channel shared with the lazy side input. __Default value:__ "x"

• default (Any) – Value written when no side-input row matches. __Default value:__ null

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• fields (Field_T | Sequence[Field_T] | None) – Coordinate field or [chrom, pos] fields in the primary data. Defaults to key.

• values (Sequence[Field_T] | None) – Fields to copy from a matching side-input row. Defaults to all fields except key.

transform_coverage(*, end, start, as_=Undefined, asChrom=Undefined, asEnd=Undefined, asStart=Undefined, chrom=Undefined, description=Undefined, weight=Undefined)View on GitHub

Add a coverage transform.

Parameters:

• end (Field_T) – The field representing the end coordinate of the segment (exclusive).

• start (Field_T) – The field representing the start coordinate of the segment (inclusive).

• as_ (str) – The output field for the computed coverage.

• asChrom (str) – The output field for the chromosome. Default: Same as chrom

• asEnd (str) – The output field for the end coordinate. Default: Same as end

• asStart (str) – The output field for the start coordinate. Default: Same as start

• chrom (Field_T) – An optional chromosome field that is passed through. TODO: groupby

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• weight (Field_T) – A field representing an optional weight for the segment. Can be used with copy ratios, for example.

transform_cross(*, from_, description=Undefined)View on GitHub

Add a cross transform.

Parameters:

• from_ (CrossInput | dict[str, Any]) – The finite eager foreign data and its optional preprocessing transforms.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_displace1d(*, length, pos, as_=Undefined, description=Undefined, extent=Undefined, positionFactor=Undefined)View on GitHub

Add a displace1d transform.

Parameters:

• length (float | Field_T | ExprRef | dict[str, Any]) – The full collision length, including any desired spacing, or a field containing that length. The value uses the same units as the scaled positions and output displacement. An expression provides a reactive scalar length shared by all rows.

• pos (Field_T) – The field containing the original position. Input rows must be ordered by ascending pos * positionFactor.

• as_ (str) – The output field for signed displacement. __Default value:__ "displacement"

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• extent (Sequence[float] | ExprRef | dict[str, Any]) – Preferred outer bounds for the placed collision intervals, expressed in the original pos coordinate system. The bounds are multiplied by positionFactor together with the item positions. When all items cannot fit, they remain non-overlapping and extend beyond the bounds by the minimum necessary amount. An expression can update the bounds reactively.

• positionFactor (float | ExprRef | dict[str, Any]) – A multiplier applied to pos before placement. An expression can convert position units to logical pixels and react to zoom or layout changes. Use an ascending pos sort for a positive factor and a descending sort for a negative factor. Place a collect transform before this transform to buffer input for expression-driven updates. __Default value:__ 1

transform_filter(expression=Undefined, *, description=Undefined, empty=Undefined, expr=Undefined, fields=Undefined, param=Undefined)View on GitHub

Add a filter transform.

Parameters:

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• empty (bool) – If true, the filter retains all rows when the selection is empty. Default: true

• expr (str) – An expression string. The row is removed if the expression evaluates to false.

• fields (dict[str, Any]) – An optional mapping of positional channels to fields. Used to determine which fields are checked against the selection intervals.

• param (str) – A selection parameter. The row is removed if it is not part of the selection.

transform_filter_scored_labels(*, pos, score, width, asMidpoint=Undefined, channel=Undefined, description=Undefined, lane=Undefined, padding=Undefined, pos2=Undefined)View on GitHub

Add a filterScoredLabels transform.

Parameters:

• pos (Field_T) – The field representing element’s start position on the domain.

• score (Field_T) – The field representing the score used for prioritization.

• width (Field_T) – The field representing element’s width in pixels.

• asMidpoint (str) – Outputs the average of pos and pos2 as the midpoint of the element. This is useful for elements that have a width, such as transcripts. The midpoint is clamped to the visible region of the element.

• channel (Literal['x', 'y']) – Default: "x"

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• lane (Field_T) – An optional field representing element’s lane, e.g., if transcripts are shown using a piled up layout. Each line is processed separately.

• padding (float) – Padding (in pixels) around the element. Default: 0

• pos2 (Field_T) – The field representing element’s end position on the domain. If not specified, the pos field is used.

transform_flatten(fields=Undefined, as_=Undefined, *, description=Undefined, index=Undefined)View on GitHub

Add a flatten transform.

Parameters:

• fields (Sequence[Field_T] | Field_T) – The field(s) to flatten. If no field is defined, the input row itself is treated as an array to be flattened.

• as_ (Sequence[str] | str) – The output field name(s) for the flattened field. Default: the input fields.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• index (str) – The output field name for the zero-based index of the array values. If unspecified, an index field is not added.

transform_flatten_cigar(*, cigar=Undefined, copyFields=Undefined, description=Undefined, start=Undefined)View on GitHub

Add a flattenCigar transform.

Parameters:

• cigar (Field_T) – The CIGAR string. __Default value:__ "cigar"

• copyFields (Sequence[str]) – Top-level input fields copied to the emitted CIGAR operation rows. If omitted, all input fields are copied. This can be used to avoid copying bulky fields such as read sequence or base quality arrays while still allowing the transform to read its input fields.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• start (Field_T) – The read’s reference start coordinate. __Default value:__ "start"

transform_flatten_compressed_exons(*, as_=Undefined, description=Undefined, exons=Undefined, start=Undefined)View on GitHub

Add a flattenCompressedExons transform.

Parameters:

• as_ (Sequence[str]) – Field names for the flattened exons. Default: ["exonStart", "exonEnd"]

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• exons (Field_T) – The field containing the exons. Default: "exons"

• start (Field_T) – Start coordinate of the gene body. Default: "start"

transform_flatten_delimited(*, field, separator, as_=Undefined, description=Undefined)View on GitHub

Add a flattenDelimited transform.

Parameters:

• field (Sequence[Field_T] | Field_T) – The field(s) to split and flatten

• separator (Sequence[str] | str) – Separator(s) used on the field(s) TODO: Rename to delimiter

• as_ (Sequence[str] | str) – The output field name(s) for the flattened field. Default: the input fields.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_flatten_sequence(*, as_=Undefined, description=Undefined, field=Undefined)View on GitHub

Add a flattenSequence transform.

Parameters:

• as_ (Sequence[str]) – Name of the fields where the zero-based index number and flattened sequence letter are written to. Default: ["pos", "sequence"]

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• field (Field_T) – The field to flatten. Default: "sequence"

transform_formula(*, as_, expr, description=Undefined)View on GitHub

Add a formula transform.

Parameters:

• as_ (str) – The (new) field where the computed value is written to

• expr (str) – An expression string

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_identifier(*, as_=Undefined, description=Undefined)View on GitHub

Add a identifier transform.

Parameters:

• as_ (str) – The field where the identifier is stored. __Default value:__ "_uniqueId"

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_linearize_genomic_coordinate(*, as_, chrom, pos, channel=Undefined, description=Undefined, offset=Undefined)View on GitHub

Add a linearizeGenomicCoordinate transform.

Parameters:

• as_ (str | Sequence[str]) – The output field or fields for linearized coordinates.

• chrom (Field_T) – The chromosome/contig field

• pos (Field_T | Sequence[Field_T]) – The field or fields that contain intra-chromosomal positions

• channel (Literal['x', 'y']) – Get the genome assembly from the scale of the channel. Default: "x"

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• offset (float | Sequence[float]) – An offset or offsets that allow for adjusting the numbering base. The offset is subtracted from the positions. GenomeSpy uses internally zero-based indexing with half-open intervals. UCSC-based formats (BED, etc.) generally use this scheme. However, for example, VCF files use one-based indexing and must be adjusted by setting the offset to 1. Default: 0

transform_lookup(*, from_, key, as_=Undefined, default=Undefined, description=Undefined, fields=Undefined, values=Undefined)View on GitHub

Add a lookup transform.

Parameters:

• from_ (UrlData | dict[str, Any] | InlineData | NamedData | DynamicCallbackData | LazyData | LookupSelfInput) – The non-lazy data source that provides the lookup table, or the current input data.

• key (Field_T | Sequence[Field_T]) – The key field or fields in the lookup table. When multiple fields are provided, they form a composite key.

• as_ (Sequence[str]) – Output field names. Defaults to values. Requires an explicit values array.

• default (Any) – Value written when no side-input row matches. __Default value:__ null

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• fields (Field_T | Sequence[Field_T] | None) – The fields in the input data to match against the lookup-table key. This array must have the same length and order as key. Defaults to key.

• values (Sequence[Field_T] | None) – Fields to copy from a matching side-input row. Defaults to all fields except key.

transform_measure_text(*, as_, field, fontSize, description=Undefined, font=Undefined, fontStyle=Undefined, fontWeight=Undefined)View on GitHub

Add a measureText transform.

Parameters:

• as_ (str) – The output field where the measured width is written.

• field (Field_T) – The field that contains the text to be measured.

• fontSize (float | ExprRef | dict[str, Any]) – The font size in pixels.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• font (str) – The font typeface. Uses the same asynchronously loaded SDF fonts as the "text" mark. Default: "Lato"

• fontStyle (FontStyle_T) – The font style. Valid values: "normal" and "italic". Default: "normal"

• fontWeight (FontWeight_T) – The font weight. The following strings and numbers are valid values: "thin" (100), "light" (300), "regular" (400), "normal" (400), "medium" (500), "bold" (700), "black" (900) Default: "regular"

transform_merge_facets(*, description=Undefined)View on GitHub

Add a mergeFacets transform.

Parameters:

description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_pack_legend_labels(*, labelWidth, columnPadding=Undefined, columns=Undefined, description=Undefined, direction=Undefined, fontSize=Undefined, labelOffset=Undefined, rowPadding=Undefined, symbolOffset=Undefined, symbolSize=Undefined, symbolStrokeWidth=Undefined, xOffset=Undefined, yExtent=Undefined, yOffset=Undefined)View on GitHub

Add a packLegendLabels transform.

Parameters:

• labelWidth (Field_T) – The field that contains measured label width in pixels.

• columnPadding (float) – Padding between columns in pixels. Default: 0

• columns (float) – The number of columns in which to arrange entries.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• direction (Literal['vertical', 'horizontal']) – The direction in which entries are laid out. Default: "vertical"

• fontSize (float) – Label font size in pixels. Default: 10

• labelOffset (float) – Offset between the symbol and label in pixels. Default: 0

• rowPadding (float) – Padding between rows in pixels. Default: 0

• symbolOffset (float) – Horizontal offset for generated symbol coordinates in pixels. Default: 0

• symbolSize (float | Field_T) – Symbol size in pixels squared, or a field containing per-entry symbol sizes in pixels squared. Default: 100

• symbolStrokeWidth (float | Field_T) – Symbol stroke width in pixels, or a field containing per-entry stroke widths in pixels. Default: 0

• xOffset (float) – Horizontal offset for all generated entry coordinates in pixels. Default: 0

• yExtent (float | ExprRef | dict[str, Any]) – Height of the pixel-space layout area. When provided, the transform also emits inverted y coordinates for GenomeSpy’s unit y range.

• yOffset (float) – Vertical offset for all generated entry coordinates in pixels. Default: 0

transform_pileup(*, end, start, as_=Undefined, description=Undefined, preference=Undefined, preferredOrder=Undefined, spacing=Undefined)View on GitHub

Add a pileup transform.

Parameters:

• end (Field_T) – The field representing the end coordinate of the segment (exclusive).

• start (Field_T) – The field representing the start coordinate of the segment (inclusive).

• as_ (str) – The output field name for the computed lane. Default: "lane".

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• preference (Field_T) – An optional field indicating the preferred lane. Use together with the preferredOrder property.

• preferredOrder (Sequence[str] | Sequence[float] | Sequence[bool]) – The order of the lane preferences. The first element contains the value that should place the segment on the first lane and so forth. If the preferred lane is occupied, the first available lane is taken.

• spacing (float) – The spacing between adjacent segments on the same lane in coordinate units. Default: 1.

transform_project(*, fields, as_=Undefined, description=Undefined)View on GitHub

Add a project transform.

Parameters:

• fields (Sequence[Field_T]) – The fields to be projected.

• as_ (Sequence[str]) – New names for the projected fields. If omitted, the names of the source fields are used.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_regex_extract(*, as_, field, regex, description=Undefined, skipInvalidInput=Undefined)View on GitHub

Add a regexExtract transform.

Parameters:

• as_ (str | Sequence[str]) – The new field or an array of fields where the extracted values are written.

• field (Field_T) – The source field

• regex (str) – A valid JavaScript regular expression with at least one group. For example: "^Sample(\d+)$". Read more at: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• skipInvalidInput (bool) – Do not complain about invalid input. Just skip it and leave the new fields undefined on the affected row. Default: false

transform_regex_fold(*, asValue, columnRegex, asKey=Undefined, description=Undefined, skipRegex=Undefined)View on GitHub

Add a regexFold transform.

Parameters:

• asValue (Sequence[str] | str) – A new column name for the extracted values.

• columnRegex (Sequence[str] | str) – A regular expression that matches to column names. The regex must have one capturing group that is used for extracting the key (e.g., a sample id) from the column name.

• asKey (str) – Default: "sample"

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• skipRegex (str) – An optional regex that matches to fields that should not be included in the new folded rows.

transform_sample(size=Undefined, *, description=Undefined)View on GitHub

Add a sample transform.

Parameters:

• size (float) – The maximum sample size. Default: 500

• description (str) – A description of the transform step. Can be used for documentation and agent context.

transform_set_intersection(*, element, set, description=Undefined, membership=Undefined)View on GitHub

Add a setIntersection transform.

Parameters:

• element (Field_T | Sequence[Field_T]) – Field identifying an element. Multiple fields form a compound identifier.

• set (Field_T) – Field identifying a set.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• membership (Field_T) – Optional field containing a Boolean membership value. The values 0 and 1 are also accepted. When omitted, every input row denotes membership.

transform_stack(*, groupby, as_=Undefined, baseField=Undefined, cardinality=Undefined, description=Undefined, field=Undefined, offset=Undefined, sort=Undefined)View on GitHub

Add a stack transform.

Parameters:

• groupby (Sequence[Field_T]) – The fields to be used for forming groups for different stacks.

• as_ (Sequence[str]) – Fields to write the stacked values. Default: ["y0", "y1"]

• baseField (Field_T) – The field that contains the base or amino acid. Used for information content calculation when the offset is "information". Rows that have null in the baseField are considered gaps and they are taken into account when scaling the the locus’ information content.

• cardinality (float) – Cardinality, e.g., the number if distinct bases or amino acids. Used for information content calculation when the offset is "information". Default: 4

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• field (Field_T) – The field to stack. If no field is defined, a constant value of one is assumed.

• offset (Literal['zero', 'center', 'normalize', 'information']) – How to offset the values in a stack. "zero" (default) starts stacking at 0. "center" centers the values around zero. "normalize" computes intra-stack percentages and normalizes the values to the range of [0, 1]. "information" computes a layout for a sequence logo. The total height of the stack reflects the group’s information content.

• sort (CompareParams | CompareParamsKwds) – The sort order of data in each stack.

transform_truncate_text(*, field, fontSize, as_=Undefined, description=Undefined, ellipsis=Undefined, font=Undefined, fontStyle=Undefined, fontWeight=Undefined, limit=Undefined)View on GitHub

Add a truncateText transform.

Parameters:

• field (Field_T) – The field that contains the text to be truncated.

• fontSize (float) – The font size in pixels.

• as_ (str) – The output field where the truncated text is written. Default: Same as field.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• ellipsis (str) – Text appended after truncation. Default: "...".

• font (str) – The font typeface. Uses the same asynchronously loaded SDF fonts as the "text" mark. Default: "Lato"

• fontStyle (FontStyle_T) – The font style. Valid values: "normal" and "italic". Default: "normal"

• fontWeight (FontWeight_T) – The font weight. Default: "regular"

• limit (float) – Maximum text width in pixels.

transform_window(*, ops, as_=Undefined, description=Undefined, fields=Undefined, frame=Undefined, groupby=Undefined, ignorePeers=Undefined, params=Undefined, sort=Undefined)View on GitHub

Add a window transform.

Parameters:

• ops (Sequence[WindowOp_T]) – Window and aggregate operations to calculate. Entries align with fields, params, and as.

• as_ (Sequence[str | None]) – Output field names. A missing or null entry uses the operation and field name joined with an underscore, such as sum_score. Operations without a field use only the operation name, such as rank.

• description (str) – A description of the transform step. Can be used for documentation and agent context.

• fields (Sequence[Field_T | None]) – Input fields for operations that use a field. Use null for operations such as rank and count that do not use one.

• frame (Sequence[float | None]) – Inclusive offsets from the current sorted row that define the window. null leaves the corresponding side unbounded. __Default value:__ [null, 0]

• groupby (Sequence[Field_T]) – Fields that divide the input into independent window partitions.

• ignorePeers (bool) – Use row offsets without expanding frame boundaries to include sorted rows with equal values. __Default value:__ false

• params (Sequence[float | None]) – Optional operation parameters. lag and lead use an offset, while ntile and nth_value use a positive integer.

• sort (CompareParams | CompareParamsKwds) – Fields used to sort rows before window functions are calculated. Without sorting, rows retain their input order and no rows are peers.

classmethod validate(instance)View on GitHub

Validate an instance against this wrapper’s schema.

view(value=Undefined, /, *, fill=Undefined, fillOpacity=Undefined, shadowBlur=Undefined, shadowColor=Undefined, shadowOffsetX=Undefined, shadowOffsetY=Undefined, shadowOpacity=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, strokeZindex=Undefined, style=Undefined, zindex=Undefined)View on GitHub

Return a copy with a ViewBackground view.

Parameters:

• fill (str) – Fill color of the view background.

• fillOpacity (float) – Opacity of the view background fill.

• shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value: 0

• shadowColor (str | ExprRef | dict[str, Any]) – The color of the drop shadow. Any valid CSS color string is allowed. Default value: "black"

• shadowOffsetX (float | ExprRef | dict[str, Any]) – The horizontal offset of the drop shadow in pixels. Positive values move the shadow to the right. Default value: 0

• shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value: 0

• shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between 0 (fully transparent) and 1 (fully opaque). Default value: 0 (disabled)

• stroke (str) – Stroke color of the view background.

• strokeOpacity (float) – Opacity of the view background stroke.

• strokeWidth (float) – Stroke width of the view background border.

• strokeZindex (float) – Z-order of the background stroke relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. __Default value:__ "cell"

• zindex (float) – Z-order of the background fill relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0

viewportHeight(value=Undefined, /, *, grow=Undefined, maxPx=Undefined, minPx=Undefined, px=Undefined)View on GitHub

Return a copy with a SizeDef viewportHeight.

Parameters:

• grow (float) – Share of the remaining space. See child sizing for details.

• maxPx (float) – Maximum size in pixels.

• minPx (float) – Minimum size in pixels.

• px (float) – Size in pixels

viewportWidth(value=Undefined, /, *, grow=Undefined, maxPx=Undefined, minPx=Undefined, px=Undefined)View on GitHub

Return a copy with a SizeDef viewportWidth.

Parameters:

• grow (float) – Share of the remaining space. See child sizing for details.

• maxPx (float) – Maximum size in pixels.

• minPx (float) – Minimum size in pixels.

• px (float) – Size in pixels

visible(value)View on GitHub

Return a copy with visible updated.

widget(*, bundle_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/bundle/index.es.js', embed_options=None, controls=Undefined, controls_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/core@0.87.0/dist/src/controls.js', inspector_module_url='https://cdn.jsdelivr.net/npm/@genome-spy/inspector@0.87.0/dist/index.es.js', parameter_names=(), parameter_values=None, enable_click_events=False)View on GitHub

Create a notebook widget for the spec.

Parameters:

• bundle_url – GenomeSpy bundle URL used by the widget.

• embed_options – Options passed to GenomeSpy’s embed function.

• controls – Display controls, or False to disable them.

• controls_module_url – Browser module containing Core controls.

• inspector_module_url – Browser module containing the Inspector control.

• parameter_names – Named GenomeSpy parameters synchronized with the widget’s parameter_values trait.

• parameter_values – Initial values for the synchronized parameters.

• enable_click_events – Whether clicked mark data is synchronized to clicked_datum and click_revision.

Returns:

An anywidget-backed JupyterChart.

Raises:

• TypeError – If the controls value has an invalid type.

• ValueError – If a control name is unknown or duplicated.

Example

>>> widget = chart.widget(controls=["png", "inspector"])

width(value=Undefined, /, *, grow=Undefined, maxPx=Undefined, minPx=Undefined, px=Undefined)View on GitHub

Return a copy with a SizeDef width.

Parameters:

• grow (float) – Share of the remaining space. See child sizing for details.

• maxPx (float) – Maximum size in pixels.

• minPx (float) – Minimum size in pixels.

• px (float) – Size in pixels

with_config(value=Undefined, /, *, arrow=Undefined, axis=Undefined, axisBottom=Undefined, axisIndex=Undefined, axisLeft=Undefined, axisLocus=Undefined, axisNominal=Undefined, axisOrdinal=Undefined, axisQuantitative=Undefined, axisRight=Undefined, axisTop=Undefined, axisX=Undefined, axisY=Undefined, legend=Undefined, legendTrack=Undefined, link=Undefined, mark=Undefined, point=Undefined, range=Undefined, rect=Undefined, rule=Undefined, scale=Undefined, style=Undefined, text=Undefined, tick=Undefined, title=Undefined, view=Undefined)View on GitHub

Return a copy with merged top-level config.

Parameters:

• arrow (ArrowConfig | dict[str, Any]) – Defaults for arrow marks.

• axis (AxisConfig | AxisConfigKwds) – Defaults shared by all axes.

• axisBottom (AxisConfig | AxisConfigKwds) – Defaults for bottom-oriented axes.

• axisIndex (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy index scales.

• axisLeft (AxisConfig | AxisConfigKwds) – Defaults for left-oriented axes.

• axisLocus (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize GenomeSpy locus scales.

• axisNominal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize nominal data.

• axisOrdinal (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize ordinal data.

• axisQuantitative (AxisConfig | AxisConfigKwds) – Defaults for axes that visualize quantitative data.

• axisRight (AxisConfig | AxisConfigKwds) – Defaults for right-oriented axes.

• axisTop (AxisConfig | AxisConfigKwds) – Defaults for top-oriented axes.

• axisX (AxisConfig | AxisConfigKwds) – Defaults for x axes.

• axisY (AxisConfig | AxisConfigKwds) – Defaults for y axes.

• legend (LegendConfig | LegendConfigKwds) – Defaults shared by all legends. Set disable to true to suppress automatic legend creation by default.

• legendTrack (LegendConfig | LegendConfigKwds) – Defaults for legends of track-like views that use index or locus scales on the x channel. __Default value:__ { "style": "track-bottom-legend" }

• link (LinkConfig | LinkConfigKwds) – Defaults for link marks.

• mark (MarkConfig | MarkConfigKwds) – Defaults shared by all mark types.

• point (PointConfig | PointConfigKwds) – Defaults for point marks.

• range (RangeConfig | RangeConfigKwds) – Named reusable ranges for channels such as shape, size, and color.

• rect (RectConfig | RectConfigKwds) – Defaults for rect marks.

• rule (RuleConfig | RuleConfigKwds) – Defaults for rule marks.

• scale (ScaleConfig | ScaleConfigKwds) – Defaults for scale behavior and scale-type-specific buckets.

• style (dict[str, Any]) – Named reusable style buckets that marks, axes, legends, titles, and views can reference through their style properties.

• text (TextConfig | TextConfigKwds) – Defaults for text marks.

• tick (TickConfig | dict[str, Any]) – Defaults for tick marks.

• title (TitleConfig | TitleConfigKwds) – Defaults for view titles.

• view (ViewConfig | ViewConfigKwds) – Defaults for view background styling, including fill, stroke, shadow, and z-order properties.

with_scales(value=Undefined, /, *, angle=Undefined, color=Undefined, direction=Undefined, dx=Undefined, dy=Undefined, fill=Undefined, fillOpacity=Undefined, opacity=Undefined, shape=Undefined, size=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, x=Undefined, x2=Undefined, xOffset=Undefined, y=Undefined, y2=Undefined, yOffset=Undefined)View on GitHub

Return a copy with merged top-level scales.

Parameters:

• angle (Scale | ScaleKwds) – Schema-defined angle property.

• color (Scale | ScaleKwds) – Schema-defined color property.

• direction (Scale | ScaleKwds) – Schema-defined direction property.

• dx (Scale | ScaleKwds) – Schema-defined dx property.

• dy (Scale | ScaleKwds) – Schema-defined dy property.

• fill (Scale | ScaleKwds) – Schema-defined fill property.

• fillOpacity (Scale | ScaleKwds) – Schema-defined fillOpacity property.

• opacity (Scale | ScaleKwds) – Schema-defined opacity property.

• shape (Scale | ScaleKwds) – Schema-defined shape property.

• size (Scale | ScaleKwds) – Schema-defined size property.

• stroke (Scale | ScaleKwds) – Schema-defined stroke property.

• strokeOpacity (Scale | ScaleKwds) – Schema-defined strokeOpacity property.

• strokeWidth (Scale | ScaleKwds) – Schema-defined strokeWidth property.

• x (Scale | ScaleKwds) – Schema-defined x property.

• x2 (Scale | ScaleKwds) – Schema-defined x2 property.

• xOffset (Scale | ScaleKwds) – Schema-defined xOffset property.

• y (Scale | ScaleKwds) – Schema-defined y property.

• y2 (Scale | ScaleKwds) – Schema-defined y2 property.

• yOffset (Scale | ScaleKwds) – Schema-defined yOffset property.

with_view(value=Undefined, /, *, fill=Undefined, fillOpacity=Undefined, shadowBlur=Undefined, shadowColor=Undefined, shadowOffsetX=Undefined, shadowOffsetY=Undefined, shadowOpacity=Undefined, stroke=Undefined, strokeOpacity=Undefined, strokeWidth=Undefined, strokeZindex=Undefined, style=Undefined, zindex=Undefined)View on GitHub

Return a copy with merged top-level view.

Parameters:

• fill (str) – Fill color of the view background.

• fillOpacity (float) – Opacity of the view background fill.

• shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value: 0

• shadowColor (str | ExprRef | dict[str, Any]) – The color of the drop shadow. Any valid CSS color string is allowed. Default value: "black"

• shadowOffsetX (float | ExprRef | dict[str, Any]) – The horizontal offset of the drop shadow in pixels. Positive values move the shadow to the right. Default value: 0

• shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value: 0

• shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between 0 (fully transparent) and 1 (fully opaque). Default value: 0 (disabled)

• stroke (str) – Stroke color of the view background.

• strokeOpacity (float) – Opacity of the view background stroke.

• strokeWidth (float) – Stroke width of the view background border.

• strokeZindex (float) – Z-order of the background stroke relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0, or 10 when the view content is clipped or scrollable.

• style (str | Sequence[str]) – Named style reference(s) resolved from config.style. If an array is provided, later styles override earlier ones. __Default value:__ "cell"

• zindex (float) – Z-order of the background fill relative to the view content. Values greater than 0 render after the view marks. Values less than or equal to 0 render before the marks. __Default value:__ 0

zindex(value)View on GitHub

Return a copy with zindex updated.