Skip to main content

Interface: RefLineOptions<R>

Defined in: packages/sdvplot/src/plot/lines.ts:11

Plot's rule options sdvplot does not own pass through to both rules: fx, fy, tip, title, className, ariaLabel, ariaDescription, dx, dy, clip, and the rest. sdvplot owns the rule positions (x, y, x1, x2, y1, y2): the reducer computes them per facet, top-level or mark-level.

Extends​

Type Parameters​

R​

R

Properties​

ariaDescription?​

optional ariaDescription?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:257

The aria-description; a constant textual description.

Inherited from​

RuleLinePassThrough.ariaDescription

ariaHidden?​

optional ariaHidden?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:265

The aria-hidden state; a constant indicating whether the element is exposed to an accessibility API.

Inherited from​

RuleLinePassThrough.ariaHidden

ariaLabel?​

optional ariaLabel?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:273

The aria-label; a channel specifying short textual labels representing the value in the accessibility tree.

Inherited from​

RuleLinePassThrough.ariaLabel

channels?​

optional channels?: Record<string, ChannelValue | Channel>

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:473

An object defining additional custom channels. This meta option may be used by an initializer to declare extra channels.

Inherited from​

RuleLinePassThrough.channels

className?​

optional className?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:250

The class attribute; a constant string.

Inherited from​

RuleLinePassThrough.className

clip?​

optional clip?: boolean | "frame" | "sphere" | GeoPermissibleObjects | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:305

How to clip the mark; one of:

  • frame or true - clip to the plot’s frame (inner area)
  • sphere - clip to the projected sphere (e.g., front hemisphere)
  • geojson - a GeoJSON object, typically with polygonal geometry
  • null or false - do not clip

The sphere clip option requires a geographic projection.

Inherited from​

RuleLinePassThrough.clip

dx?​

optional dx?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:311

The horizontal offset in pixels; a constant option. On low-density screens, an additional 0.5px offset may be applied for crisp edges.

Inherited from​

RuleLinePassThrough.dx

dy?​

optional dy?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:317

The vertical offset in pixels; a constant option. On low-density screens, an additional 0.5px offset may be applied for crisp edges.

Inherited from​

RuleLinePassThrough.dy

facet?​

optional facet?: boolean | "auto" | "include" | "exclude" | "super" | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:185

Whether to enable or disable faceting; one of:

  • auto (default) - automatically determine if this mark should be faceted
  • include (or true) - draw the subset of the mark’s data in the current facet
  • exclude - draw the subset of the mark’s data not in the current facet
  • super - draw this mark in a single frame that covers all facets
  • null (or false) - repeat this mark’s data across all facets (i.e., no faceting)

When a mark uses super faceting, it is not allowed to use position scales (x, y, fx, or fy); super faceting is intended for decorations, such as labels and legends.

When top-level faceting is used, the default auto setting is equivalent to include when the mark data is strictly equal to the top-level facet data; otherwise it is equivalent to null. When the include or exclude facet mode is chosen, the mark data must be parallel to the top-level facet data: the data must have the same length and order. If the data are not parallel, then the wrong data may be shown in each facet. The default auto therefore requires strict equality (===) for safety, and using the facet data as mark data is recommended when using the exclude facet mode. (To construct parallel data safely, consider using array.map on the facet data.)

When mark-level faceting is used, the default auto setting is equivalent to include: the mark will be faceted if either the fx or fy channel option (or both) is specified. The null or false option will disable faceting, while exclude draws the subset of the mark’s data not in the current facet.

Inherited from​

RuleLinePassThrough.facet

facetAnchor?​

optional facetAnchor?: "bottom" | "top" | "left" | "right" | "top-left" | "top-right" | "bottom-right" | "bottom-left" | "top-empty" | "right-empty" | "bottom-empty" | "left-empty" | "empty" | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:198

How to place the mark with respect to facets; one of:

  • null (default for most marks) - display the mark in each non-empty facet
  • top, right, bottom, or left - display the mark only in facets on the given side
  • top-empty, right-empty, bottom-empty, or left-empty (default for axis marks) - display the mark only in facets that have empty space on the given side: either the margin, or an empty facet
  • empty - display the mark in empty facets only

Inherited from​

RuleLinePassThrough.facetAnchor

fill?​

optional fill?: ChannelValueSpec

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:327

The fill; a constant CSS color string, or a channel typically bound to the color scale. If all channel values are valid CSS colors, by default the channel will not be bound to the color scale, interpreting the colors literally.

Inherited from​

RuleLinePassThrough.fill

fillOpacity?​

optional fillOpacity?: ChannelValueSpec

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:337

The fill-opacity; a constant number between 0 and 1, or a channel typically bound to the opacity scale. If all channel values are numbers in [0, 1], by default the channel will not be bound to the opacity scale, interpreting the opacities literally.

Inherited from​

RuleLinePassThrough.fillOpacity

filter?​

optional filter?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:86

Applies a transform to filter the mark’s index according to the given channel values; only truthy values are retained. For example, to show only data whose body mass is greater than 3,000g:

filter: (d) => d.body_mass_g > 3000

Note that filtering only affects the rendered mark index, not the associated channel values, and thus has no effect on imputed scale domains.

Inherited from​

RuleLinePassThrough.filter

fx?​

optional fx?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:145

The horizontal facet position channel, for mark-level faceting, bound to the fx scale.

Inherited from​

RuleLinePassThrough.fx

fy?​

optional fy?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:151

The vertical facet position channel, for mark-level faceting, bound to the fy scale.

Inherited from​

RuleLinePassThrough.fy

href?​

optional href?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:458

The href; a channel specifying URLs for clickable links. May be used in conjunction with the target option to open links in another window.

Inherited from​

RuleLinePassThrough.href

imageFilter?​

optional imageFilter?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:433

A CSS filter; a constant string used to adjust the rendering of images, such as blur(5px).

Inherited from​

RuleLinePassThrough.imageFilter

initializer?​

optional initializer?: InitializerFunction

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:136

A custom mark initializer.

Inherited from​

RuleLinePassThrough.initializer

inset?​

optional inset?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/inset.d.ts:9

Shorthand to set the same default for all four insets: insetTop, insetRight, insetBottom, and insetLeft. All insets typically default to zero, though not always (say when using bin transform). A positive inset reduces effective area, while a negative inset increases it.

Inherited from​

RuleLinePassThrough.inset

insetBottom?​

optional insetBottom?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/inset.d.ts:30

Insets the bottom edge by the specified number of pixels. A positive value insets towards the top edge (reducing effective area), while a negative value insets away from the top edge (increasing it).

Inherited from​

RuleLinePassThrough.insetBottom

insetTop?​

optional insetTop?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/inset.d.ts:16

Insets the top edge by the specified number of pixels. A positive value insets towards the bottom edge (reducing effective area), while a negative value insets away from the bottom edge (increasing it).

Inherited from​

RuleLinePassThrough.insetTop

interval?​

optional interval?: Interval

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/marks/rule.d.ts:25

How to convert a continuous value (y for ruleX, or x for ruleY) into an interval (y1 and y2 for ruleX, or x1 and x2 for ruleY); one of:

  • an object that implements floor, offset, and range methods
  • a named time interval such as day (for date intervals)
  • a number (for number intervals), defining intervals at integer multiples of n

For example, to bin Apple’s daily stock price by month, plotting a sequence of barcodes showing monthly distributions:

Plot.ruleY(aapl, {x: "Date", y: "Close", interval: "month"})

Inherited from​

RuleLinePassThrough.interval

margin?​

optional margin?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:219

Shorthand to set the same default for all four mark margins: marginTop, marginRight, marginBottom, and marginLeft; typically defaults to 0, except for axis marks.

Inherited from​

RuleLinePassThrough.margin

marginBottom?​

optional marginBottom?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:237

The mark’s bottom margin; the minimum distance in pixels between the bottom edges of the inner and outer plot area.

Inherited from​

RuleLinePassThrough.marginBottom

marginLeft?​

optional marginLeft?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:243

The mark’s left margin; the minimum distance in pixels between the left edges of the inner and outer plot area.

Inherited from​

RuleLinePassThrough.marginLeft

marginRight?​

optional marginRight?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:231

The mark’s right margin; the minimum distance in pixels between the right edges of the mark’s inner and outer plot area.

Inherited from​

RuleLinePassThrough.marginRight

marginTop?​

optional marginTop?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:225

The mark’s top margin; the minimum distance in pixels between the top edges of the inner and outer plot area.

Inherited from​

RuleLinePassThrough.marginTop

marker?​

optional marker?: boolean | "none" | Marker | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/marker.d.ts:47

Shorthand to set the same default for markerStart, markerMid, and markerEnd; one of:

  • a marker name such as arrow or circle
  • none (default) - no marker
  • true - alias for circle-fill
  • false or null - alias for none
  • a function - a custom marker function; see below

Custom marker functions are passed the current marker color and a context including the current document; they must return an SVG marker element.

Inherited from​

RuleLinePassThrough.marker

markerEnd?​

optional markerEnd?: boolean | "none" | Marker | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/marker.d.ts:93

The marker for the ending point of a line segment; one of:

  • a marker name such as arrow or circle
  • none (default) - no marker
  • true - alias for circle-fill
  • false or null - alias for none
  • a function - a custom marker function; see below

Custom marker functions are passed the current marker color and a context including the current document; they must return an SVG marker element.

Inherited from​

RuleLinePassThrough.markerEnd

markerMid?​

optional markerMid?: boolean | "none" | Marker | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/marker.d.ts:78

The marker for any middle (interior) points of a line segment. If the line segment only has a start and end point, this option has no effect. One of:

  • a marker name such as arrow or circle
  • none (default) - no marker
  • true - alias for circle-fill
  • false or null - alias for none
  • a function - a custom marker function; see below

Custom marker functions are passed the current marker color and a context including the current document; they must return an SVG marker element.

Inherited from​

RuleLinePassThrough.markerMid

markerStart?​

optional markerStart?: boolean | "none" | Marker | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/marker.d.ts:62

The marker for the starting point of a line segment; one of:

  • a marker name such as arrow or circle
  • none (default) - no marker
  • true - alias for circle-fill
  • false or null - alias for none
  • a function - a custom marker function; see below

Custom marker functions are passed the current marker color and a context including the current document; they must return an SVG marker element.

Inherited from​

RuleLinePassThrough.markerStart

mixBlendMode?​

optional mixBlendMode?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:425

The mix-blend-mode; a constant string specifying how to blend content such as multiply.

Inherited from​

RuleLinePassThrough.mixBlendMode

opacity?​

optional opacity?: ChannelValueSpec

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:417

The opacity; a constant between 0 and 1, or a channel typically bound to the opacity scale. If all channel values are numbers in [0, 1], by default the channel will not be bound to the opacity scale, interpreting the opacities literally. For faster rendering, prefer the strokeOpacity or fillOpacity option.

Inherited from​

RuleLinePassThrough.opacity

paintOrder?​

optional paintOrder?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:443

The paint-order; a constant string specifying the order in which the fill, stroke, and any markers are drawn; defaults to normal, which draws the fill, then stroke, then markers; defaults to stroke for the text mark to create a “halo” around text to improve legibility.

Inherited from​

RuleLinePassThrough.paintOrder

pointerEvents?​

optional pointerEvents?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:280

The pointer-events property; a constant string such as none.

Inherited from​

RuleLinePassThrough.pointerEvents

render?​

optional render?: RenderFunction

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:139

A custom render transform.

Inherited from​

RuleLinePassThrough.render

reverse?​

optional reverse?: boolean

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:92

Applies a transform to reverse the order of the mark’s index, say for reverse input order.

Inherited from​

RuleLinePassThrough.reverse

shapeRendering?​

optional shapeRendering?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:450

The shape-rendering; a constant string such as crispEdges.

Inherited from​

RuleLinePassThrough.shapeRendering

sort?​

optional sort?: SortOrder | ChannelDomainSort

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:130

Either applies a transform to sort the mark’s index by the specified channel values, or imputes ordinal scale domains from this mark’s channels.

When imputing ordinal scale domains from channel values, the sort option is an object whose keys are ordinal scale names such as x or fx, and whose values are channel names such as y, y1, or y2. For example, to impute the y scale’s domain from the associated x channel values in ascending order:

sort: {y: "x"}

For different sort options for different scales, replace the channel name with a value object and per-scale options:

sort: {y: {value: "-x"}}

When sorting the mark’s index, the sort option is instead one of:

  • a function for comparing data, returning a signed number
  • a channel value definition for sorting given values in ascending order
  • a {value, order} object for sorting given values
  • a {channel, order} object for sorting the named channel’s values

For example, to render in order of ascending body mass:

sort: "body_mass_g"

See also the Plot.sort transform.

Inherited from​

RuleLinePassThrough.sort

stroke?​

optional stroke?: string

Defined in: packages/sdvplot/src/plot/lines.ts:15

Default "red".

Overrides​

RuleLinePassThrough.stroke

strokeDasharray?​

optional strokeDasharray?: string

Defined in: packages/sdvplot/src/plot/lines.ts:17

Default "4 4".

Overrides​

RuleLinePassThrough.strokeDasharray

strokeDashoffset?​

optional strokeDashoffset?: string | number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:365

The stroke-dashoffset; a constant indicating the offset in pixels of the first dash along the stroke; defaults to zero.

Inherited from​

RuleLinePassThrough.strokeDashoffset

strokeLinecap?​

optional strokeLinecap?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:373

The stroke-linecap; a constant specifying how to cap stroked paths, such as butt, round, or square.

Inherited from​

RuleLinePassThrough.strokeLinecap

strokeLinejoin?​

optional strokeLinejoin?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:381

The stroke-linejoin; a constant specifying how to join stroked paths, such as bevel, miter, miter-clip, or round.

Inherited from​

RuleLinePassThrough.strokeLinejoin

strokeMiterlimit?​

optional strokeMiterlimit?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:389

The stroke-miterlimit; a constant number specifying how to limit the length of miter joins on stroked paths.

Inherited from​

RuleLinePassThrough.strokeMiterlimit

strokeOpacity?​

optional strokeOpacity?: number

Defined in: packages/sdvplot/src/plot/lines.ts:20

The stroke-opacity; a constant between 0 and 1, or a channel typically bound to the opacity scale. If all channel values are numbers in [0, 1], by default the channel will not be bound to the opacity scale, interpreting the opacities literally.

Overrides​

RuleLinePassThrough.strokeOpacity

strokeWidth?​

optional strokeWidth?: number

Defined in: packages/sdvplot/src/plot/lines.ts:19

Default 1.

Overrides​

RuleLinePassThrough.strokeWidth

target?​

optional target?: string

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:467

The target; a constant string specifying the target window (e.g., _blank) for clickable links; used in conjunction with the href option.

Inherited from​

RuleLinePassThrough.target

tip?​

optional tip?: boolean | TipPointer | TipOptions & PointerOptions & object

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:293

Whether to generate a tooltip for this mark, and any tip options.

Inherited from​

RuleLinePassThrough.tip

title?​

optional title?: ChannelValue

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:290

The title; a channel specifying accessible, short textual descriptions as strings (possibly with newlines). If the tip option is specified, the title will be displayed with an interactive tooltip instead of using the SVG title element.

Inherited from​

RuleLinePassThrough.title

transform?​

optional transform?: TransformFunction

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/mark.d.ts:133

A custom mark transform.

Inherited from​

RuleLinePassThrough.transform

x?​

optional x?: Channel<R>

Defined in: packages/sdvplot/src/plot/lines.ts:12

y?​

optional y?: Channel<R>

Defined in: packages/sdvplot/src/plot/lines.ts:13