Skip to main content

Interface: AxisLogosOptions

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

Options for axisLogos. Each drawn image is named by the tick it replaces ("KC logo", "KC wordmark"), so assistive technology reads the category the text showed. The images are sized by height (a fraction of the frame); a caller margin on the anchored side smaller than the computed one can clip them.

Extends​

Properties​

anchor?​

optional anchor?: "bottom" | "top" | "left" | "right"

Defined in: packages/sdvplot/src/plot/axis.ts:28

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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.clip

color?​

optional color?: ChannelValueSpec

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

A shorthand for setting both fill and stroke; affects the stroke of tick vectors and grid rules, and the fill of tick texts and axis label texts; defaults to currentColor.

Inherited from​

AxisPassThrough.color

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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.filter

fontFamily?​

optional fontFamily?: string

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

The font-family; a constant; defaults to the plot’s font family, which is typically system-ui.

Inherited from​

AxisPassThrough.fontFamily

fontSize?​

optional fontSize?: ChannelValue

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

The font size in pixels; either a constant or a channel; defaults to the plot’s font size, which is typically 10. When a number, it is interpreted as a constant; otherwise it is interpreted as a channel.

Inherited from​

AxisPassThrough.fontSize

fontStyle?​

optional fontStyle?: string

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

The font style; a constant; defaults to the plot’s font style, which is typically normal.

Inherited from​

AxisPassThrough.fontStyle

fontVariant?​

optional fontVariant?: string

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

The font variant; a constant; if the text channel contains numbers or dates, defaults to tabular-nums to facilitate comparing numbers; otherwise defaults to the plot’s font style, which is typically normal.

Inherited from​

AxisPassThrough.fontVariant

fontWeight?​

optional fontWeight?: string | number

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

The font weight; a constant; defaults to the plot’s font weight, which is typically normal.

Inherited from​

AxisPassThrough.fontWeight

frameAnchor?​

optional frameAnchor?: FrameAnchor

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

The frame anchor specifies defaults for x and y, along with textAnchor and lineAnchor, based on the plot’s frame; it may be one of the four sides (top, right, bottom, left), one of the four corners (top-left, top-right, bottom-right, bottom-left), or the middle of the frame.

Inherited from​

AxisPassThrough.frameAnchor

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​

AxisPassThrough.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​

AxisPassThrough.fy

height?​

optional height?: number

Defined in: packages/sdvplot/src/plot/axis.ts:24

Fraction of the frame height in (0, 1]; default 0.1.

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​

AxisPassThrough.href

idSystem?​

optional idSystem?: IdSystem

Defined in: packages/sdvplot/src/plot/axis.ts:27

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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.insetTop

interval?​

optional interval?: RangeInterval

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

Enforces uniformity for data at regular intervals, such as integer values or daily samples. The interval may be 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

This option sets the default transform to the given interval’s interval.floor function. In addition, the default domain will align with interval boundaries.

Inherited from​

AxisPassThrough.interval

label?​

optional label?: string | null

Defined in: packages/sdvplot/src/plot/axis.ts:30

labelAnchor?​

optional labelAnchor?: "center" | "bottom" | "top" | "left" | "right"

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:623

Where to place the axis label relative to the plot’s frame. For vertical position scales (y and fy), may be top, bottom, or center; for horizontal position scales (x and fx), may be left, right, or center. Defaults to center for ordinal scales (including fx and fy), and otherwise top for y, and right for x.

For position axes only.

Inherited from​

AxisPassThrough.labelAnchor

labelArrow?​

optional labelArrow?: boolean | "auto" | "left" | "right" | "none" | "up" | "down" | null

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:342

Whether to apply a directional arrow such as → or ↑ to the scale label. If auto (the default), the presence of the arrow depends on whether the scale is ordinal.

For axes only.

Inherited from​

AxisPassThrough.labelArrow

labelOffset?​

optional labelOffset?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:629

The axis label position offset (in pixels); default depends on margins and orientation.

Inherited from​

AxisPassThrough.labelOffset

league​

league: "aaf" | "ahl" | "cfb" | "cricket" | "echl" | "mbb" | "milb" | "mlb" | "nba" | "nbagl" | "ncaa_baseball" | "ncaa_mhockey" | "ncaa_softball" | "ncaa_whockey" | "nfl" | "nhl" | "ohl" | "phf" | "pwhl" | "qmjhl" | "soccer" | "ufl" | "usfl" | "ushl" | "wbb" | "whl" | "wnba" | "xfl"

Defined in: packages/sdvplot/src/plot/axis.ts:21

lineAnchor?​

optional lineAnchor?: "bottom" | "top" | "middle"

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

The line anchor controls how text is aligned (typically vertically) relative to its anchor point; it is one of top, bottom, or middle. If the frame anchor is top, top-left, or top-right, the default line anchor is top; if the frame anchor is bottom, bottom-right, or bottom-left, the default is bottom; otherwise it is middle.

Inherited from​

AxisPassThrough.lineAnchor

lineHeight?​

optional lineHeight?: number

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

The line height in ems; defaults to 1. The line height affects the (typically vertical) separation between adjacent baselines of text, as well as the separation between the text and its anchor point.

Inherited from​

AxisPassThrough.lineHeight

lineWidth?​

optional lineWidth?: number

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

The line width in ems (e.g., 10 for about 20 characters); defaults to infinity, disabling wrapping and clipping.

If textOverflow is null, lines will be wrapped at the specified length. If a line is split at a soft hyphen (\xad), a hyphen (-) will be displayed at the end of the line. If textOverflow is not null, lines will be clipped according to the given strategy.

Inherited from​

AxisPassThrough.lineWidth

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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.markerStart

markType?​

optional markType?: MarkType

Defined in: packages/sdvplot/src/plot/axis.ts:26

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​

AxisPassThrough.mixBlendMode

monospace?​

optional monospace?: boolean

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

If true, changes the default fontFamily to monospace, and uses simplified monospaced text metrics calculations.

Inherited from​

AxisPassThrough.monospace

opacity?​

optional opacity?: ChannelValueSpec

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

A shorthand for setting both fillOpacity and strokeOpacity; affects the stroke opacity of tick vectors and grid rules, and the fill opacity of tick texts and axis label texts; defaults to 1 for axes and 0.1 for grids.

Inherited from​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.reverse

rotate?​

optional rotate?: ChannelValue

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

The rotation angle in degrees clockwise; a constant or a channel; defaults to 0°. When a number, it is interpreted as a constant; otherwise it is interpreted as a channel.

Inherited from​

AxisPassThrough.rotate

season?​

optional season?: SeasonInput

Defined in: packages/sdvplot/src/plot/axis.ts:22

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​

AxisPassThrough.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​

AxisPassThrough.sort

stroke?​

optional stroke?: ChannelValueSpec

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

The stroke; 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​

AxisPassThrough.stroke

strokeDasharray?​

optional strokeDasharray?: string | number

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

The stroke-dasharray; a constant number indicating the length in pixels of alternating dashes and gaps, or a constant string of numbers separated by spaces or commas (e.g., 10 2 for dashes of 10 pixels separated by gaps of 2 pixels), or none (the default) for no dashing

Inherited from​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.strokeMiterlimit

strokeOpacity?​

optional strokeOpacity?: ChannelValueSpec

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

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.

Inherited from​

AxisPassThrough.strokeOpacity

strokeWidth?​

optional strokeWidth?: ChannelValueSpec

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

The stroke-width; a constant number in pixels, or a channel.

Inherited from​

AxisPassThrough.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​

AxisPassThrough.target

text?​

optional text?: ChannelValue

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

The text contents channel, possibly with line breaks (\n, \r\n, or \r). If not specified, defaults to the zero-based index [0, 1, 2, …].

Inherited from​

AxisPassThrough.text

textAnchor?​

optional textAnchor?: "start" | "end" | "middle"

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

The text anchor controls how text is aligned (typically horizontally) relative to its anchor point; it is one of start, end, or middle. If the frame anchor is left, top-left, or bottom-left, the default text anchor is start; if the frame anchor is right, top-right, or bottom-right, the default is end; otherwise it is middle.

Inherited from​

AxisPassThrough.textAnchor

textOverflow?​

optional textOverflow?: "clip" | "ellipsis" | "clip-start" | "clip-end" | "ellipsis-start" | "ellipsis-middle" | "ellipsis-end" | null

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

How truncate (or wrap) lines of text longer than the given lineWidth; one of:

  • null (default) - preserve overflowing characters (and wrap if needed)
  • clip or clip-end - remove characters from the end
  • clip-start - remove characters from the start
  • ellipsis or ellipsis-end - replace characters from the end with an ellipsis (…)
  • ellipsis-start - replace characters from the start with an ellipsis (…)
  • ellipsis-middle - replace characters from the middle with an ellipsis (…)

If no title was specified, if text requires truncation, a title containing the non-truncated text will be implicitly added.

Inherited from​

AxisPassThrough.textOverflow

textStroke?​

optional textStroke?: ChannelValueSpec

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

The tick text stroke, say for a white outline to improve legibility; defaults to null.

Inherited from​

AxisPassThrough.textStroke

textStrokeOpacity?​

optional textStrokeOpacity?: ChannelValueSpec

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

The tick text strokeOpacity; defaults to 1; has no effect unless textStroke is set.

Inherited from​

AxisPassThrough.textStrokeOpacity

textStrokeWidth?​

optional textStrokeWidth?: ChannelValueSpec

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

The tick text strokeWidth; defaults to 4; has no effect unless textStroke is set.

Inherited from​

AxisPassThrough.textStrokeWidth

tickPadding?​

optional tickPadding?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:579

The distance between an axis tick mark and its associated text label (in pixels); often defaults to 3, but may be affected by tickSize and tickRotate.

Inherited from​

AxisPassThrough.tickPadding

tickRotate?​

optional tickRotate?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:596

The rotation angle of axis tick labels in degrees clocksize; defaults to 0.

Inherited from​

AxisPassThrough.tickRotate

ticks?​

optional ticks?: Iterable<any, any, any> | RangeInterval

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:554

The desired approximate number of axis ticks, or an explicit array of tick values, or an interval such as day or month.

For axes and legends.

Inherited from​

AxisPassThrough.ticks

tickSize?​

optional tickSize?: number

Defined in: packages/sdvplot/src/plot/axis.ts:29

tickSpacing?​

optional tickSpacing?: number

Defined in: node_modules/.pnpm/@observablehq+plot@0.6.17/node_modules/@observablehq/plot/src/scales.d.ts:572

The desired approximate spacing between adjacent axis ticks, affecting the default ticks; defaults to 80 pixels for x and fx, and 35 pixels for y and fy.

For axes.

Inherited from​

AxisPassThrough.tickSpacing

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​

AxisPassThrough.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​

AxisPassThrough.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​

AxisPassThrough.transform

variant?​

optional variant?: Variant

Defined in: packages/sdvplot/src/plot/axis.ts:25

x?​

optional x?: ChannelValueSpec

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

The horizontal position channel specifying the text’s anchor point, typically bound to the x scale.

Inherited from​

AxisPassThrough.x

y?​

optional y?: ChannelValueSpec

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

The vertical position channel specifying the text’s anchor point, typically bound to the y scale.

Inherited from​

AxisPassThrough.y