genome_spy.GenomeSpyConfig¶
- class genome_spy.GenomeSpyConfig(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, header=Undefined, headerColumn=Undefined, headerRow=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, **kwds)View on GitHub¶
Bases:
GenomeSpySchemaGenerated wrapper for
GenomeSpyConfig.Methods
arrow([value, buildIndex, clamp, clip, ...])Return a copy with a
ArrowConfigarrow.axis([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxis.axisBottom([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisBottom.axisIndex([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisIndex.axisLeft([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisLeft.axisLocus([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisLocus.axisNominal([value, chromGrid, ...])Return a copy with a
AxisConfigaxisNominal.axisOrdinal([value, chromGrid, ...])Return a copy with a
AxisConfigaxisOrdinal.axisQuantitative([value, chromGrid, ...])Return a copy with a
AxisConfigaxisQuantitative.axisRight([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisRight.axisTop([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisTop.axisX([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisX.axisY([value, chromGrid, chromGridCap, ...])Return a copy with a
AxisConfigaxisY.copy(*[, deep])Return a copy with optional keyword updates.
header([value, align, anchor, angle, ...])Return a copy with a
FacetHeaderheader.headerColumn([value, align, anchor, angle, ...])Return a copy with a
FacetHeaderheaderColumn.headerRow([value, align, anchor, angle, ...])Return a copy with a
FacetHeaderheaderRow.legend([value, backgroundFill, ...])Return a copy with a
LegendConfiglegend.legendTrack([value, backgroundFill, ...])Return a copy with a
LegendConfiglegendTrack.link([value, arcFadingDistance, ...])Return a copy with a
LinkConfiglink.mark([value, buildIndex, clamp, clip, ...])Return a copy with a
MarkConfigmark.point([value, angle, buildIndex, clamp, ...])Return a copy with a
PointConfigpoint.range([value, angle, diverging, heatmap, ...])Return a copy with a
RangeConfigrange.rect([value, buildIndex, clamp, clip, ...])Return a copy with a
RectConfigrect.Return this class schema with referenced properties merged in.
rule([value, buildIndex, clamp, clip, ...])Return a copy with a
RuleConfigrule.scale([value, align, assembly, base, bins, ...])Return a copy with a
ScaleConfigscale.style(value)Return a copy with
styleupdated.text([value, align, angle, baseline, ...])Return a copy with a
TextConfigtext.tick([value, buildIndex, clamp, clip, ...])Return a copy with a
TickConfigtick.title([value, align, anchor, angle, ...])Return a copy with a
TitleConfigtitle.to_dict(*[, validate])Serialize this schema wrapper to a JSON-compatible dictionary.
to_json(*[, validate])Serialize this schema wrapper to formatted JSON.
validate(instance)Validate an instance against this wrapper's schema.
view([value, continuousHeight, ...])Return a copy with a
ViewConfigview.- arrow(value=Undefined, /, *, buildIndex=Undefined, clamp=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 copy with a
ArrowConfigarrow.- 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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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 (ArrowDirection_T | 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)."both"places equivalent heads at both endpoints and suppressesheadSpacingandstartNotchfor that arrow. For data-driven direction, use thedirectionencoding channel. __Default value:__"forward"fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between
0and1.filled (bool) – Whether the
colorrepresents thefillcolor (true) or thestrokecolor (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:__45headNotchAngle (float | ExprRef | dict[str, Any]) – Angle in degrees between the arrow axis and the arrowhead notch edge.
90places the notch point at the tip, producing a triangular head whenheadAngleis less than90. Applies to"triangle"heads."open"heads useheadAnglefor the notch edge as well. Values are clamped to[1, 90]. __Default value:__90headPlacement (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 resolvedsize, even whenstemisfalse. __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. Ifnull, arrowheads are not repeated. Repetition is suppressed whendirectionresolves to"both". __Default value:__nullheadWidth (float | ExprRef | dict[str, Any]) – Width of the arrowhead as a multiplier of resolved
size. Values above1make the arrowhead wider than the stem. __Default value:__3minSize (float | ExprRef | dict[str, Any]) – Minimum resolved arrow stem thickness in pixels. Applies to numeric, band-relative, and encoded
sizevalues. __Default value:__1minStemLength (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 whenstartNotchistrueand is measured from the start notch to the head start. Has no effect whenstemisfalse. __Default value:__0opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.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. Usechannelto explicitly select the reference channel. Band-relative size is not supported for diagonal arrows. __Default value:__8startNotch (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. It is suppressed when
directionresolves to"both"because a bidirectional arrow has no unique start. __Default value:__falsestem (bool | ExprRef | dict[str, Any]) – Whether to draw the arrow stem. When
false, the resolvedsizestill controls open-head thickness.minStemLengthhas no effect when the stem is hidden. __Default value:__truestrokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between
0and1.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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (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
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- 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, labelSqueeze=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 copy with a
AxisConfigaxis.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisBottom(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, labelSqueeze=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 copy with a
AxisConfigaxisBottom.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisIndex(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, labelSqueeze=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 copy with a
AxisConfigaxisIndex.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisLeft(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, labelSqueeze=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 copy with a
AxisConfigaxisLeft.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisLocus(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, labelSqueeze=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 copy with a
AxisConfigaxisLocus.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisNominal(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, labelSqueeze=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 copy with a
AxisConfigaxisNominal.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisOrdinal(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, labelSqueeze=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 copy with a
AxisConfigaxisOrdinal.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisQuantitative(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, labelSqueeze=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 copy with a
AxisConfigaxisQuantitative.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisRight(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, labelSqueeze=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 copy with a
AxisConfigaxisRight.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisTop(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, labelSqueeze=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 copy with a
AxisConfigaxisTop.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisX(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, labelSqueeze=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 copy with a
AxisConfigaxisX.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- axisY(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, labelSqueeze=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 copy with a
AxisConfigaxisY.- Parameters:
chromGrid (bool) – A boolean flag indicating if chromosome grid lines should be included as part of the axis. __Default value:__
falsechromGridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraychromGridDash (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 | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridFillOdd (str | ExprRef | dict[str, Any]) – Fill color of odd chromosomes. __Default value:__ (none)
chromGridOpacity (float) – The opacity of the chromosome grid lines. __Default value:__
1chromGridWidth (float) – Width of the chromosome grid lines. __Default value:__
1chromLabelAlign (Align_T) – Horizontal text alignment of chromosome name labels. __Default value:__
"left"chromLabelColor (str | ExprRef | dict[str, Any]) – 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:__
13chromLabelFontStyle (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:__
7chromLabels (bool) – A boolean flag indicating if chromosome name labels should be included as part of the genome axis. __Default value:__
truechromTickColor (str | ExprRef | dict[str, Any]) – 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:__
1chromTickSize (float) – The size in pixels of chromosome boundary ticks. __Default value:__
18chromTickWidth (float) – The width, in pixels, of chromosome boundary ticks. __Default value:__
1chromTicks (bool) – A boolean flag indicating if chromosome boundary ticks should be included as part of the genome axis. __Default value:__
truedomain (bool) – A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis. __Default value:__
truedomainCap (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 | ExprRef | dict[str, Any]) – 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:__
1extraValues (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
valuesis 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:__
falsegridCap (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 | ExprRef | dict[str, Any]) – Color of grid lines. __Default value:__
lightgraygridDash (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:__
1gridWidth (float) – Width of the grid lines. __Default value:__
1labelAlign (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:__
-90for nominal and ordinal fields;0otherwise.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 | ExprRef | dict[str, Any]) – 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.
trueuses 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:__
0labelFont (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:__
180labelOverlap (bool | Literal['parity'] | Literal['greedy']) – The strategy for removing overlapping axis labels.
trueuses 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.falsedisables 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:__
2labelSeparation (float) – The minimum separation, in pixels, between retained axis labels. __Default value:__
2labelSqueeze (bool) – Shrink each tick label uniformly to fit its band, accounting for label rotation. Supported only for band scales. Enables ranged text fitting and bypasses
labelOverlap, including an explicitly configured strategy. Labels stay aligned with their bands at viewport edges. Very small labels fade out using the text mark’s normal fitting behavior. __Default value:__falselabels (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:__
30for y-axis;undefinedfor 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 tonullto 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 | ExprRef | dict[str, Any]) – 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 useaxisLengthfor 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 onaxisLengthtickDash (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
1indicates that ticks should not be less than 1 unit apart. IftickMinStepis specified, thetickCountvalue will be adjusted, if necessary, to enforce the minimum step value.tickSize (float) – The size in pixels of axis ticks. __Default value:__
5tickWidth (float) – The width, in pixels, of ticks. __Default value:__
1ticks (bool) – Boolean value that determines whether the axis should include ticks. __Default value:__
truetitle (str | None) – A title for the axis. By default, the title is derived from the encoding title, field, or expression. Set to
nullto remove it.titleColor (str | ExprRef | dict[str, Any]) – 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, …,900where"normal"=400and"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
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__0, or10when the view content is clipped or scrollable.
- header(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, format=Undefined, frame=Undefined, labels=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, zindex=Undefined)View on GitHub¶
Return a copy with a
FacetHeaderheader.- 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, …,900where"normal"=400and"bold"=700).format (str) – D3 number format for numeric category labels, for example
".1f"or",.0f". String and boolean categories retain their original labels.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"labels (bool) – Whether category labels are shown. Hidden labels reserve no space. __Default value:__
trueoffset (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
falselets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__truestyle (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.zindex (float) – Z-order of the title relative to the view content. Values greater than
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__1
- headerColumn(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, format=Undefined, frame=Undefined, labels=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, zindex=Undefined)View on GitHub¶
Return a copy with a
FacetHeaderheaderColumn.- 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, …,900where"normal"=400and"bold"=700).format (str) – D3 number format for numeric category labels, for example
".1f"or",.0f". String and boolean categories retain their original labels.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"labels (bool) – Whether category labels are shown. Hidden labels reserve no space. __Default value:__
trueoffset (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
falselets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__truestyle (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.zindex (float) – Z-order of the title relative to the view content. Values greater than
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__1
- headerRow(value=Undefined, /, *, align=Undefined, anchor=Undefined, angle=Undefined, baseline=Undefined, color=Undefined, dx=Undefined, dy=Undefined, font=Undefined, fontSize=Undefined, fontStyle=Undefined, fontWeight=Undefined, format=Undefined, frame=Undefined, labels=Undefined, offset=Undefined, orient=Undefined, reserve=Undefined, style=Undefined, zindex=Undefined)View on GitHub¶
Return a copy with a
FacetHeaderheaderRow.- 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, …,900where"normal"=400and"bold"=700).format (str) – D3 number format for numeric category labels, for example
".1f"or",.0f". String and boolean categories retain their original labels.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"labels (bool) – Whether category labels are shown. Hidden labels reserve no space. __Default value:__
trueoffset (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
falselets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__truestyle (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.zindex (float) – Z-order of the title relative to the view content. Values greater than
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__1
- 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, selectionLabel=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 copy with a
LegendConfiglegend.- Parameters:
backgroundFill (str | ExprRef | dict[str, Any]) – Fill color of the legend background.
backgroundFillOpacity (float) – Opacity of the legend background fill.
backgroundStroke (str | ExprRef | dict[str, Any]) – 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: nullon an encoding channel to remove that channel’s legend. __Default value:__falsegradientLength (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:__
1gradientStrokeColor (str | ExprRef | dict[str, Any]) – Stroke color of the gradient ramp border.
gradientStrokeWidth (float) – Stroke width of the gradient ramp border in pixels. __Default value:__
0gradientThickness (float) – Thickness of the gradient ramp in pixels. __Default value:__
12labelAlign (Align_T) – Horizontal alignment of legend labels.
labelBaseline (Baseline_T) – Baseline alignment of legend labels.
labelColor (str | ExprRef | dict[str, Any]) – 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.
selectionLabel (bool) – Show the selected numeric range below a bound gradient legend. Set to
falseto hide the readout and remove its reserved space. Does not affect gradient ticks or the brush. __Default value:__truespacing (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 tonullto reset inherited legend styles.symbolBaseFillColor (str | ExprRef | dict[str, Any]) – Base fill color for legend symbols when the legend does not encode fill.
symbolBaseStrokeColor (str | ExprRef | dict[str, Any]) – Base stroke color for legend symbols when the legend does not encode stroke.
symbolFillColor (str | ExprRef | dict[str, Any]) – 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 | ExprRef | dict[str, Any]) – 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 | ExprRef | dict[str, Any]) – 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
valuestake precedence over this property. __Default value:__5title (str | None) – Title text for the legend. If
null, the title is removed.titleColor (str | ExprRef | dict[str, Any]) – 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.
- legendTrack(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, selectionLabel=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 copy with a
LegendConfiglegendTrack.- Parameters:
backgroundFill (str | ExprRef | dict[str, Any]) – Fill color of the legend background.
backgroundFillOpacity (float) – Opacity of the legend background fill.
backgroundStroke (str | ExprRef | dict[str, Any]) – 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: nullon an encoding channel to remove that channel’s legend. __Default value:__falsegradientLength (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:__
1gradientStrokeColor (str | ExprRef | dict[str, Any]) – Stroke color of the gradient ramp border.
gradientStrokeWidth (float) – Stroke width of the gradient ramp border in pixels. __Default value:__
0gradientThickness (float) – Thickness of the gradient ramp in pixels. __Default value:__
12labelAlign (Align_T) – Horizontal alignment of legend labels.
labelBaseline (Baseline_T) – Baseline alignment of legend labels.
labelColor (str | ExprRef | dict[str, Any]) – 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.
selectionLabel (bool) – Show the selected numeric range below a bound gradient legend. Set to
falseto hide the readout and remove its reserved space. Does not affect gradient ticks or the brush. __Default value:__truespacing (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 tonullto reset inherited legend styles.symbolBaseFillColor (str | ExprRef | dict[str, Any]) – Base fill color for legend symbols when the legend does not encode fill.
symbolBaseStrokeColor (str | ExprRef | dict[str, Any]) – Base stroke color for legend symbols when the legend does not encode stroke.
symbolFillColor (str | ExprRef | dict[str, Any]) – 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 | ExprRef | dict[str, Any]) – 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 | ExprRef | dict[str, Any]) – 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
valuestake precedence over this property. __Default value:__5title (str | None) – Title text for the legend. If
null, the title is removed.titleColor (str | ExprRef | dict[str, Any]) – 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.
- link(value=Undefined, /, *, arcFadingDistance=Undefined, arcHeightFactor=Undefined, buildIndex=Undefined, clamp=Undefined, clampApex=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, linkShape=Undefined, maxChordLength=Undefined, minArcHeight=Undefined, minPickingSize=Undefined, noFadingOnPointSelection=Undefined, noFadingOnSecondPass=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 copy with a
LinkConfiglink.- 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. Bothfalseand[0, 0]disable fading. Default value:falsearcHeightFactor (float | ExprRef | dict[str, Any]) – Scaling factor for the
"arc” shape’s height. The default value1.0produces roughly circular arcs. Default value:1.0buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclampApex (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:falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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'] | Literal['orthogonal'] | 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"orthogonal"shape draws two straight legs joined at a right angle, with butt caps and a miter join. Coincident endpoints draw nothing. 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:50000minArcHeight (float | ExprRef | dict[str, Any]) – The minimum height of an
"arc"shape. Makes very short links more clearly visible. Default value:1.5minPickingSize (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.0for"link"and2.0for"point"noFadingOnPointSelection (bool | ExprRef | dict[str, Any]) – Alias for
noFadingOnSecondPass, used only when that property is unspecified. Requires active conditional ordering; selections in color or size encodings alone no longer suppress fading.noFadingOnSecondPass (bool | ExprRef | dict[str, Any]) – Shows foreground arcs in full by disabling distance fading during the second visual pass of an active conditional
orderencoding. Configure selected links with the higher order value to draw them unfaded above other links. Reversing the order values instead exempts the unselected links. Has no effect without active conditional ordering, including when all selections are empty. Picking always uses normal fading. __Default value:__falseopacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.orient (Literal['vertical'] | Literal['horizontal'] | ExprRef | dict[str, Any]) – The orientation of the link path. Either
"vertical"or"horizontal". Applies to dome, diagonal, and orthogonal links. Orthogonal links place the elbow at the source position along the orientation axis: horizontal uses(x, y2); vertical uses(x2, y). With parent-to-child tree edges, the turn stays at the parent’s merge height. 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:
101size (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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (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
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- mark(value=Undefined, /, *, buildIndex=Undefined, clamp=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 copy with a
MarkConfigmark.- 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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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
fillOpacityorstrokeOpacity, depending on thefilledproperty.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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (float | ExprRef | dict[str, Any]) – Position on the y axis.
y2Offset (float | ExprRef | dict[str, Any]) – Offset of the
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- point(value=Undefined, /, *, angle=Undefined, buildIndex=Undefined, clamp=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 copy with a
PointConfigpoint.- Parameters:
angle (float | ExprRef | dict[str, Any]) – The rotation angle in degrees. Default value:
0buildIndex (bool) – Whether the x channel should build an index for efficient subset rendering. If omitted, GenomeSpy enables indexing automatically for positional x encodings.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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:
0dy (float | ExprRef | dict[str, Any]) – Vertical offset in pixels. Default value:
0fillGradientStrength (float | ExprRef | dict[str, Any]) – Gradient strength controls the amount of the gradient eye-candy effect in the fill color. Valid values are between
0and1. Default value:0fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between
0and1.filled (bool) – Whether the
colorrepresents thefillcolor (true) or thestrokecolor (false).geometricZoomBound (float) – Enables geometric zooming. The value is the base two logarithmic zoom level where the maximum point size is reached. Default value:
0inwardStroke (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:
falseminPickingSize (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.0for"link"and2.0for"point"opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.sampleFacetPadding (float) – Additional padding used by sample facets. Default value:
0.1semanticScore (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:
0semanticZoomFraction (float | ExprRef | dict[str, Any]) – TODO Default value:
0.02shape (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 usestrokeWidthfor 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.strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between
0and1.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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (float | ExprRef | dict[str, Any]) – Position on the y axis.
y2Offset (float | ExprRef | dict[str, Any]) – Offset of the
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- range(value=Undefined, /, *, angle=Undefined, diverging=Undefined, heatmap=Undefined, ramp=Undefined, shape=Undefined, size=Undefined)View on GitHub¶
Return a copy with a
RangeConfigrange.- Parameters:
angle (Sequence[float]) – Named range for
anglechannels.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
shapechannels.size (Sequence[float]) – Named range for
sizechannels.
- rect(value=Undefined, /, *, buildIndex=Undefined, clamp=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 copy with a
RectConfigrect.- 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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.cornerRadius (float | ExprRef | dict[str, Any]) – Radius of the rounded corners. Default value:
0cornerRadiusBottomLeft (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
fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between
0and1.filled (bool) – Whether the
colorrepresents thefillcolor (true) or thestrokecolor (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:
0minOpacity (float | ExprRef | dict[str, Any]) – Clamps the minimum size-dependent opacity. The property does not affect the
opacitychannel. Valid values are between0and1. When a rectangle would be smaller than what is specified inminHeightandminWidth, it is faded out proportionally. Example: a rectangle would be rendered as one pixel wide, butminWidthclamps 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:0minWidth (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:
1opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.shadowBlur (float | ExprRef | dict[str, Any]) – The blur radius of the drop shadow in pixels. Higher values produce a more diffuse shadow. Default value:
0shadowColor (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:
0shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value:
0shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between
0(fully transparent) and1(fully opaque). Default value:0(disabled)strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between
0and1.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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (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
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- rule(value=Undefined, /, *, buildIndex=Undefined, clamp=Undefined, clip=Undefined, color=Undefined, cullByVisibleRange=Undefined, cursor=Undefined, fill=Undefined, fillOpacity=Undefined, filled=Undefined, minLength=Undefined, opacity=Undefined, size=Undefined, stroke=Undefined, strokeAlign=Undefined, strokeCap=Undefined, strokeDash=Undefined, strokeDashOffset=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 copy with a
RuleConfigrule.- 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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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
fillOpacity (float | ExprRef | dict[str, Any]) – The fill opacity. Value between
0and1.filled (bool) – Whether the
colorrepresents thefillcolor (true) or thestrokecolor (false).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:
0opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.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.strokeAlign (StrokeAlign_T | ExprRef | dict[str, Any]) – Position of the full-width stroke band relative to the nominal body. Inside strokes extend inward by
strokeWidth, centered strokes extend half inward and half outward, and outside strokes extend entirely outward. The nominal body is unchanged. Canvas uses an outside-style approximation for all alignments. __Default value:__"outside"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
nullfor solid strokes. Default value:nullstrokeDashOffset (float) – An offset for the stroke dash pattern. Default value:
0strokeOpacity (float | ExprRef | dict[str, Any]) – The stroke opacity. Value between
0and1.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
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (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
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- 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, gapPositions=Undefined, gapWidth=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, viewport=Undefined, zero=Undefined, zoom=Undefined)View on GitHub¶
Return a copy with a
ScaleConfigscale.- Parameters:
align (float) – The alignment of the steps within the scale range. This value must lie in the range
[0,1]. A value of0.5indicates that the steps should be centered within the range. A value of0or1may be used to shift the bands to one side, say to position them adjacent to an axis. __Default value:__0.5assembly (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
contigsorurl. If undefined, the default genome from the genome store is used.base (float) – The logarithm base of the
logscale (default10).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’sclamp(trueby default).constant (float) – A constant determining the slope of the symlog function around zero. Only used for
symlogscales. __Default value:__1domain (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,
domaincan take the form of a two-element array with minimum and maximum values. Vega-Lite piecewise scales can be created by providing adomainwith more than two entries. For ordinal and nominal fields,domaincan 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
domainproperty. 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
falseto apply domain updates immediately. The default istrue, except for domains that includeExprRef``s, which default to ``falseunless overridden. __Default value:__true, exceptfalseforExprRef-driven domains.exponent (float) – The exponent of the
powscale.gapPositions (Sequence[str | float | bool] | Literal['chromosomes'] | ExprRef | dict[str, Any] | None) – Boundaries before which to insert grouping gaps on positional band, point, index, or locus scales. For band/point scales, list domain category values; numeric categories are values, not ranks. Missing or first categories add no gap. Index/locus cuts use numeric coordinates: 10 separates bands 9 and 10.
"chromosomes"inserts gaps between the assembly’s chromosomes. Positions are deduplicated in domain order. An expression may return an array or null. Constant null or an empty array completely disables grouping gaps. __Default value:__ null.gapWidth (float | ExprRef | dict[str, Any] | None) – Grouping gap width in CSS pixels, independent of zoom and device pixel ratio. An expression may return a nonnegative number or null. Constant zero or null completely disables grouping gaps. With step-based sizing, gaps add to plot size while the base step stays fixed. Band/point gaps do not support
round: true. Nested categorical offsets under a gapped band require an explicit offset range. On a step-sized axis, gap expressions must be independent of the resulting plot width or height. __Default value:__ 6 when gapPositions is supplied, otherwise 0.index (dict[str, Any]) – Defaults for GenomeSpy’s
indexscales.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,cubehelixandcubehelix-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:__hcllocus (dict[str, Any]) – Defaults for GenomeSpy’s
locusscales.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,
nicecan be either a boolean flag or a number. Ifniceis 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:__truefor unbinned quantitative fields;falseotherwise.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:__
0ordinalColorScheme (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, anddomainMaxproperties. For Vega-Lite band scales, shortcut for settingpaddingInnerandpaddingOuterto the same value. For Vega-Lite point scales, alias forpaddingOuter. __Default value:__ For continuous scales, derived from the Vega-Lite scale config’scontinuousPadding. For band and point scales, seepaddingInnerandpaddingOuter. 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
bandPaddingOuterfor band scales andpointPaddingfor 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 colorschemeinstead ofrange. 2) Any directly specifiedrangeforxandychannels will be ignored. Range can be customized via the view’s corresponding Vega-Lite size (widthandheight).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.viewport (Sequence[float] | None) – Initial and reset scale viewport for positional band or point scales, expressed as a half-open rank interval. Fractional endpoints allow smooth navigation. Intervals narrower than one category expand around their midpoint to span one category. The categorical domain retains its membership and order. Categorical zoom uses boolean
zoomand is bounded by the full domain. This scale viewport differs from a layout viewport, which scrolls already-laid-out content usingviewportWidthorviewportHeight. __Default value:__null, fitting all categories.zero (bool) – If
true, ensures that a zero baseline value is included in the scale domain. __Default value:__truefor x and y channels if the quantitative field is not binned and no customdomainis provided;falseotherwise. __Note:__ Log scales do not supportzero.zoom (bool | ZoomParams | ZoomParamsKwds) – Enable interactive zooming and panning on a positional scale. Band and point scales accept a boolean and navigate their scale viewport while retaining the full categorical domain. Continuous scales also accept zoom extent options. __Default value:__
truefor index and locus scales;falseotherwise.
- style(value)View on GitHub¶
Return a copy with
styleupdated.
- text(value=Undefined, /, *, align=Undefined, angle=Undefined, baseline=Undefined, buildIndex=Undefined, clamp=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 copy with a
TextConfigtext.- 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:
0baseline (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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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
squeezeproperty). 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:falseflushX (bool | ExprRef | dict[str, Any]) – If true, the text is kept inside the viewport when the range of
xandx2intersect the viewport.flushY (bool | ExprRef | dict[str, Any]) – If true, the text is kept inside the viewport when the range of
yandy2intersect 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
fillOpacityorstrokeOpacity, depending on thefilledproperty.paddingX (float | ExprRef | dict[str, Any]) – The horizontal padding, in pixels, when the
x2channel is used for ranged text. Default value:0paddingY (float | ExprRef | dict[str, Any]) – The vertical padding, in pixels, when the
y2channel is used for ranged text. Default value:0size (float | ExprRef | dict[str, Any]) – The font size in pixels. Default value:
11squeeze (bool | ExprRef | dict[str, Any]) – If the
squeezeproperty is true and secondary positional channels (x2and/ory2) are used, the text is scaled to fit mark’s width and/or height. Default value:truestyle (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
formatproperty. Default value:""tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. If string, specifies the tooltip handler to use.viewportEdgeFadeDistanceBottom (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeDistanceBottomproperty.viewportEdgeFadeDistanceLeft (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeDistanceLeftproperty.viewportEdgeFadeDistanceRight (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeDistanceRightproperty.viewportEdgeFadeDistanceTop (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeDistanceTopproperty.viewportEdgeFadeWidthBottom (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeWidthBottomproperty.viewportEdgeFadeWidthLeft (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeWidthLeftproperty.viewportEdgeFadeWidthRight (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeWidthRightproperty.viewportEdgeFadeWidthTop (float | ExprRef | dict[str, Any]) – Schema-defined
viewportEdgeFadeWidthTopproperty.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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (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
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- tick(value=Undefined, /, *, buildIndex=Undefined, clamp=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 copy with a
TickConfigtick.- 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.
clamp (bool | Literal['x'] | Literal['y']) – Clamps projected anchors or range endpoints to the view before constructing mark geometry.
trueclamps both axes;"x"or"y"selects one axis. Position offsets are included. For rectangles, clamping keeps outlines around the visible part of a group during zooming. Withclip: false, full strokes remain visible at the boundary; symbols, arrowheads, and text glyphs can extend beyond it. Rectangles and explicit text ranges collapsed on a clamped axis are hidden. Rules and ticks intersect the selected bounds without changing direction; excluded or collapsed segments are hidden. Zero-length rules are hidden even whenclampis false. Links and arrows with coincident endpoints are hidden. Shared scales and their inversion are unchanged. __Default value:__falseclip (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:__truewhen either positional scale is zoomable; otherwisefalsecolor (str | ExprRef | dict[str, Any]) – Color of the mark. Affects either
fillorstroke, depending on thefilledproperty.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:
0opacity (float | ExprRef | dict[str, Any]) – Opacity of the mark. Affects
fillOpacityorstrokeOpacity, depending on thefilledproperty.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
orientexplicitly when bothxandyuse band-like scales. Default value: inferredstrokeCap (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
nullfor solid strokes. Default value:nullstrokeDashOffset (float) – An offset for the stroke dash pattern. Default value:
0style (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
sizeof the underlying rule mark. Default value:1tooltip (HandledTooltip | HandledTooltipKwds | None | Literal[False]) – Tooltip handler. If
false, no tooltip is shown but the mark remains available for renderer picking and mark interactions. Ifnull, no tooltip is shown and the mark is excluded from picking unless its view declares a point selection; a point selection overrides this picking opt-out. 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
x2coordinate in logical pixels. Whenx2is implicit, it inheritsxOffsetunless this property is specified. Default value: inherited fromxOffsetfor an implicitx2, otherwise0xOffset (float | ExprRef | dict[str, Any]) – Offset of the
xcoordinate in logical pixels. Default value:0y (float | ExprRef | dict[str, Any]) – Position on the y axis.
y2Offset (float | ExprRef | dict[str, Any]) – Offset of the
y2coordinate in logical pixels. Wheny2is implicit, it inheritsyOffsetunless this property is specified. Default value: inherited fromyOffsetfor an implicity2, otherwise0yOffset (float | ExprRef | dict[str, Any]) – Offset of the
ycoordinate in logical pixels. Default value:0
- 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 copy with a
TitleConfigtitle.- 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, …,900where"normal"=400and"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
falselets the title render without affecting layout, enabling wilder layouts where titles may overlap nearby content. __Default value:__truestyle (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, …,900where"normal"=400and"bold"=700).subtitlePadding (float) – Padding in pixels between title and subtitle text. __Default value:__
3zindex (float) – Z-order of the title relative to the view content. Values greater than
0render after the view marks. Values less than or equal to0render before the marks. __Default value:__1
- 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 copy with a
ViewConfigview.- 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 | ExprRef | dict[str, Any]) – 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:
0shadowColor (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:
0shadowOffsetY (float | ExprRef | dict[str, Any]) – The vertical offset of the drop shadow in pixels. Positive values move the shadow downward. Default value:
0shadowOpacity (float | ExprRef | dict[str, Any]) – The opacity of the drop shadow. Value between
0(fully transparent) and1(fully opaque). Default value:0(disabled)step (float | ExprRef | dict[str, Any]) – Default step size for discrete view sizes. __Default value:__ none
stroke (str | ExprRef | dict[str, Any]) – 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
0render the stroke after the view marks. Values less than or equal to0render before the marks. The default value depends on the element type.zindex (float) – Z-order relative to the view content. Values greater than
0render after the view marks. Values less than or equal to0render before the marks. The default value depends on the element type.
- copy(*, deep=True, **kwds)View on GitHub¶
Return a copy with optional keyword updates.
- classmethod resolve_references()View on GitHub¶
Return this class schema with referenced properties merged in.
- to_dict(*, validate=True)View on GitHub¶
Serialize this schema wrapper to a JSON-compatible dictionary.
- to_json(*, validate=True)View on GitHub¶
Serialize this schema wrapper to formatted JSON.
- classmethod validate(instance)View on GitHub¶
Validate an instance against this wrapper’s schema.