Where the rule starts in x: a number or a column. Default: the left of the frame's visible domain.
x1channel
Where the rule ends in x: a number or a column. By default the rule spans the frame as it pans and zooms. Default: the right of the frame's visible domain.
dashboolean | number | [number, number]
Dash the rule: true (4 px dashes and gaps), a dash length (gaps as long), or [dash, gap], measured along the drawn rule. In px.
datatable
A table for this mark alone: a mark with data displays on its own, in a Plot of its own.
Position
ychannel
Where the rule stands: a number, a time or a category draws one rule, a column one per row, and "@pointer_y" follows the pointer.
Appearance
colorcolor
The rule's color. Default: "#8a949e".Default: the theme's rule gray.
widthnumber
The rule's width. Default: 1 px.Default: 1.
opacitynumber
The rule's opacity, 0 to 1. Default: 1.
Display
labelstring
The mark's name in the legend and the settings pane.
legendboolean
Whether the mark has a legend entry. Default: False.
How the mark mixes with what is drawn under it; any mode but normal draws it transparent, and SVG and PDF exports draw additive and subtractive as an image. Default: "normal".
glownumber
How much the mark glows: its own color times glow blooms around it in the plot's presentation (0 does not glow); the Plot's bloom effect sets the bloom's strength and radius. SVG and PDF exports draw the whole plot as an image. Default: 0.
shadeShadeSpec
A plugin's shade (registerPlugin): { kind, ...parameters }, as { kind: "hatch", spacing: 6 } (Python hm.shade("hatch", spacing=6)), recolors each fragment the mark draws; picking, tooltips, domains and legends are unchanged. SVG and PDF exports draw a shaded mark as an image.
namestring
The rule's name in the settings pane.
Interaction
identityidentity
Whose rows these are for selections: an identity() shared by tables that show the same things. Default: its data's.
selectboolean | selection
Click a rule to select its row: true uses its data's selection, or give a selection().
hoverboolean | selection
Mark the rule under the pointer as @hovered, without fading the others: true uses its data's hover, or give a selection().
This mark's own z transform, instead of its frame's. Default: its frame's.
z_invertbooleansetting
Reverse this mark's z direction. Default: False.
zbounds[number, number]setting
The z extent this mark maps, instead of its frame's domain (an image's or a grid's extent). Default: its frame's.
zrange[number, number]setting
Where this mark's z extent lands, in its frame's world units. Default: its frame's.
Shading
transparentbooleansetting
Draw the mark in the transparent pass, blended in depth order with other transparent marks. Default: False.
Advanced renderer options
max_instancesnumber | null
The most rows drawn; past it the rows are sampled (null draws them all), though SVG and PDF exports draw every row. Default: None.
Usage
RuleY draws a horizontal rule at y across the frame: a threshold, one rule per row of a column, or the pointer (y="@pointer_y"). By default it spans the frame’s visible domain in x; x0 and x1 give other ends, so x1="@pointer_x" draws a leader from the axis to the pointer.
The rule follows the frame’s coordinates: a circle in a polar frame (an arc between x0 and x1), a parallel on a map or a globe. Rules never widen automatic domains.
RuleY is a built-in template, built from transforms and simpler marks: import it from hmplot/charts.
For Plotly users, this is the add_hline pattern. For a shaded interval, use BandY (the corresponding add_hrect pattern).