| 1 | # d3-axis
|
|---|
| 2 |
|
|---|
| 3 | The axis component renders human-readable reference marks for [scales](https://github.com/d3/d3-scale). This alleviates one of the more tedious tasks in visualizing data.
|
|---|
| 4 |
|
|---|
| 5 | ## Installing
|
|---|
| 6 |
|
|---|
| 7 | If you use npm, `npm install d3-axis`. You can also download the [latest release on GitHub](https://github.com/d3/d3-axis/releases/latest). For vanilla HTML in modern browsers, import d3-axis from Skypack:
|
|---|
| 8 |
|
|---|
| 9 | ```html
|
|---|
| 10 | <script type="module">
|
|---|
| 11 |
|
|---|
| 12 | import {axisLeft} from "https://cdn.skypack.dev/d3-axis@3";
|
|---|
| 13 |
|
|---|
| 14 | const axis = axisLeft(scale);
|
|---|
| 15 |
|
|---|
| 16 | </script>
|
|---|
| 17 | ```
|
|---|
| 18 |
|
|---|
| 19 | For legacy environments, you can load d3-axis’s UMD bundle from an npm-based CDN such as jsDelivr; a `d3` global is exported:
|
|---|
| 20 |
|
|---|
| 21 | ```html
|
|---|
| 22 | <script src="https://cdn.jsdelivr.net/npm/d3-axis@3"></script>
|
|---|
| 23 | <script>
|
|---|
| 24 |
|
|---|
| 25 | const axis = d3.axisLeft(scale);
|
|---|
| 26 |
|
|---|
| 27 | </script>
|
|---|
| 28 | ```
|
|---|
| 29 |
|
|---|
| 30 | [Try d3-axis in your browser.](https://observablehq.com/collection/@d3/d3-axis)
|
|---|
| 31 |
|
|---|
| 32 | ## API Reference
|
|---|
| 33 |
|
|---|
| 34 | Regardless of orientation, axes are always rendered at the origin. To change the position of the axis with respect to the chart, specify a [transform attribute](http://www.w3.org/TR/SVG/coords.html#TransformAttribute) on the containing element. For example:
|
|---|
| 35 |
|
|---|
| 36 | ```js
|
|---|
| 37 | d3.select("body").append("svg")
|
|---|
| 38 | .attr("width", 1440)
|
|---|
| 39 | .attr("height", 30)
|
|---|
| 40 | .append("g")
|
|---|
| 41 | .attr("transform", "translate(0,30)")
|
|---|
| 42 | .call(axis);
|
|---|
| 43 | ```
|
|---|
| 44 |
|
|---|
| 45 | The elements created by the axis are considered part of its public API. You can apply external stylesheets or modify the generated axis elements to [customize the axis appearance](https://observablehq.com/@d3/styled-axes).
|
|---|
| 46 |
|
|---|
| 47 | [<img alt="Custom Axis" src="https://raw.githubusercontent.com/d3/d3-axis/master/img/custom.png" width="420" height="219">](https://observablehq.com/@d3/styled-axes)
|
|---|
| 48 |
|
|---|
| 49 | An axis consists of a [path element](https://www.w3.org/TR/SVG/paths.html#PathElement) of class “domain” representing the extent of the scale’s domain, followed by transformed [g elements](https://www.w3.org/TR/SVG/struct.html#Groups) of class “tick” representing each of the scale’s ticks. Each tick has a [line element](https://www.w3.org/TR/SVG/shapes.html#LineElement) to draw the tick line, and a [text element](https://www.w3.org/TR/SVG/text.html#TextElement) for the tick label. For example, here is a typical bottom-oriented axis:
|
|---|
| 50 |
|
|---|
| 51 | ```html
|
|---|
| 52 | <g fill="none" font-size="10" font-family="sans-serif" text-anchor="middle">
|
|---|
| 53 | <path class="domain" stroke="currentColor" d="M0.5,6V0.5H880.5V6"></path>
|
|---|
| 54 | <g class="tick" opacity="1" transform="translate(0.5,0)">
|
|---|
| 55 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 56 | <text fill="currentColor" y="9" dy="0.71em">0.0</text>
|
|---|
| 57 | </g>
|
|---|
| 58 | <g class="tick" opacity="1" transform="translate(176.5,0)">
|
|---|
| 59 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 60 | <text fill="currentColor" y="9" dy="0.71em">0.2</text>
|
|---|
| 61 | </g>
|
|---|
| 62 | <g class="tick" opacity="1" transform="translate(352.5,0)">
|
|---|
| 63 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 64 | <text fill="currentColor" y="9" dy="0.71em">0.4</text>
|
|---|
| 65 | </g>
|
|---|
| 66 | <g class="tick" opacity="1" transform="translate(528.5,0)">
|
|---|
| 67 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 68 | <text fill="currentColor" y="9" dy="0.71em">0.6</text>
|
|---|
| 69 | </g>
|
|---|
| 70 | <g class="tick" opacity="1" transform="translate(704.5,0)">
|
|---|
| 71 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 72 | <text fill="currentColor" y="9" dy="0.71em">0.8</text>
|
|---|
| 73 | </g>
|
|---|
| 74 | <g class="tick" opacity="1" transform="translate(880.5,0)">
|
|---|
| 75 | <line stroke="currentColor" y2="6"></line>
|
|---|
| 76 | <text fill="currentColor" y="9" dy="0.71em">1.0</text>
|
|---|
| 77 | </g>
|
|---|
| 78 | </g>
|
|---|
| 79 | ```
|
|---|
| 80 |
|
|---|
| 81 | The orientation of an axis is fixed; to change the orientation, remove the old axis and create a new axis.
|
|---|
| 82 |
|
|---|
| 83 | <a name="axisTop" href="#axisTop">#</a> d3.<b>axisTop</b>(<i>scale</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 84 |
|
|---|
| 85 | Constructs a new top-oriented axis generator for the given [scale](https://github.com/d3/d3-scale), with empty [tick arguments](#axis_ticks), a [tick size](#axis_tickSize) of 6 and [padding](#axis_tickPadding) of 3. In this orientation, ticks are drawn above the horizontal domain path.
|
|---|
| 86 |
|
|---|
| 87 | <a name="axisRight" href="#axisRight">#</a> d3.<b>axisRight</b>(<i>scale</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 88 |
|
|---|
| 89 | Constructs a new right-oriented axis generator for the given [scale](https://github.com/d3/d3-scale), with empty [tick arguments](#axis_ticks), a [tick size](#axis_tickSize) of 6 and [padding](#axis_tickPadding) of 3. In this orientation, ticks are drawn to the right of the vertical domain path.
|
|---|
| 90 |
|
|---|
| 91 | <a name="axisBottom" href="#axisBottom">#</a> d3.<b>axisBottom</b>(<i>scale</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 92 |
|
|---|
| 93 | Constructs a new bottom-oriented axis generator for the given [scale](https://github.com/d3/d3-scale), with empty [tick arguments](#axis_ticks), a [tick size](#axis_tickSize) of 6 and [padding](#axis_tickPadding) of 3. In this orientation, ticks are drawn below the horizontal domain path.
|
|---|
| 94 |
|
|---|
| 95 | <a name="axisLeft" href="#axisLeft">#</a> d3.<b>axisLeft</b>(<i>scale</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 96 |
|
|---|
| 97 | Constructs a new left-oriented axis generator for the given [scale](https://github.com/d3/d3-scale), with empty [tick arguments](#axis_ticks), a [tick size](#axis_tickSize) of 6 and [padding](#axis_tickPadding) of 3. In this orientation, ticks are drawn to the left of the vertical domain path.
|
|---|
| 98 |
|
|---|
| 99 | <a name="_axis" href="#_axis">#</a> <i>axis</i>(<i>context</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 100 |
|
|---|
| 101 | Render the axis to the given *context*, which may be either a [selection](https://github.com/d3/d3-selection) of SVG containers (either SVG or G elements) or a corresponding [transition](https://github.com/d3/d3-transition).
|
|---|
| 102 |
|
|---|
| 103 | <a name="axis_scale" href="#axis_scale">#</a> <i>axis</i>.<b>scale</b>([<i>scale</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 104 |
|
|---|
| 105 | If *scale* is specified, sets the [scale](https://github.com/d3/d3-scale) and returns the axis. If *scale* is not specified, returns the current scale.
|
|---|
| 106 |
|
|---|
| 107 | <a name="axis_ticks" href="#axis_ticks">#</a> <i>axis</i>.<b>ticks</b>(<i>arguments…</i>) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 108 | <br><a href="#axis_ticks">#</a> <i>axis</i>.<b>ticks</b>([<i>count</i>[, <i>specifier</i>]])
|
|---|
| 109 | <br><a href="#axis_ticks">#</a> <i>axis</i>.<b>ticks</b>([<i>interval</i>[, <i>specifier</i>]])
|
|---|
| 110 |
|
|---|
| 111 | Sets the *arguments* that will be passed to [*scale*.ticks](https://github.com/d3/d3-scale/blob/master/README.md#continuous_ticks) and [*scale*.tickFormat](https://github.com/d3/d3-scale/blob/master/README.md#continuous_tickFormat) when the axis is [rendered](#_axis), and returns the axis generator. The meaning of the *arguments* depends on the [axis’ scale](#axis_scale) type: most commonly, the arguments are a suggested *count* for the number of ticks (or a [time *interval*](https://github.com/d3/d3-time) for time scales), and an optional [format *specifier*](https://github.com/d3/d3-format) to customize how the tick values are formatted.
|
|---|
| 112 |
|
|---|
| 113 | This method has no effect if the scale does not implement *scale*.ticks, as with [band](https://github.com/d3/d3-scale/blob/master/README.md#band-scales) and [point](https://github.com/d3/d3-scale/blob/master/README.md#point-scales) scales. To set the tick values explicitly, use [*axis*.tickValues](#axis_tickValues). To set the tick format explicitly, use [*axis*.tickFormat](#axis_tickFormat).
|
|---|
| 114 |
|
|---|
| 115 | For example, to generate twenty ticks with SI-prefix formatting on a linear scale, say:
|
|---|
| 116 |
|
|---|
| 117 | ```js
|
|---|
| 118 | axis.ticks(20, "s");
|
|---|
| 119 | ```
|
|---|
| 120 |
|
|---|
| 121 | To generate ticks every fifteen minutes with a time scale, say:
|
|---|
| 122 |
|
|---|
| 123 | ```js
|
|---|
| 124 | axis.ticks(d3.timeMinute.every(15));
|
|---|
| 125 | ```
|
|---|
| 126 |
|
|---|
| 127 | This method is also a convenience function for [*axis*.tickArguments](#axis_tickArguments). For example, this:
|
|---|
| 128 |
|
|---|
| 129 | ```js
|
|---|
| 130 | axis.ticks(10);
|
|---|
| 131 | ```
|
|---|
| 132 |
|
|---|
| 133 | Is equivalent to:
|
|---|
| 134 |
|
|---|
| 135 | ```js
|
|---|
| 136 | axis.tickArguments([10]);
|
|---|
| 137 | ```
|
|---|
| 138 |
|
|---|
| 139 | To generate tick values directly, use [*scale*.ticks](https://github.com/d3/d3-scale/blob/master/README.md#continuous_ticks).
|
|---|
| 140 |
|
|---|
| 141 | <a name="axis_tickArguments" href="#axis_tickArguments">#</a> <i>axis</i>.<b>tickArguments</b>([<i>arguments</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 142 |
|
|---|
| 143 | If *arguments* is specified, sets the *arguments* that will be passed to [*scale*.ticks](https://github.com/d3/d3-scale/blob/master/README.md#continuous_ticks) and [*scale*.tickFormat](https://github.com/d3/d3-scale/blob/master/README.md#continuous_tickFormat) when the axis is [rendered](#_axis), and returns the axis generator. The meaning of the *arguments* depends on the [axis’ scale](#axis_scale) type: most commonly, the arguments are a suggested *count* for the number of ticks (or a [time *interval*](https://github.com/d3/d3-time) for time scales), and an optional [format *specifier*](https://github.com/d3/d3-format) to customize how the tick values are formatted.
|
|---|
| 144 |
|
|---|
| 145 | If *arguments* is specified, this method has no effect if the scale does not implement *scale*.ticks, as with [band](https://github.com/d3/d3-scale/blob/master/README.md#band-scales) and [point](https://github.com/d3/d3-scale/blob/master/README.md#point-scales) scales. To set the tick values explicitly, use [*axis*.tickValues](#axis_tickValues). To set the tick format explicitly, use [*axis*.tickFormat](#axis_tickFormat).
|
|---|
| 146 |
|
|---|
| 147 | If *arguments* is not specified, returns the current tick arguments, which defaults to the empty array.
|
|---|
| 148 |
|
|---|
| 149 | For example, to generate twenty ticks with SI-prefix formatting on a linear scale, say:
|
|---|
| 150 |
|
|---|
| 151 | ```js
|
|---|
| 152 | axis.tickArguments([20, "s"]);
|
|---|
| 153 | ```
|
|---|
| 154 |
|
|---|
| 155 | To generate ticks every fifteen minutes with a time scale, say:
|
|---|
| 156 |
|
|---|
| 157 | ```js
|
|---|
| 158 | axis.tickArguments([d3.timeMinute.every(15)]);
|
|---|
| 159 | ```
|
|---|
| 160 |
|
|---|
| 161 | See also [*axis*.ticks](#axis_ticks).
|
|---|
| 162 |
|
|---|
| 163 | <a name="axis_tickValues" href="#axis_tickValues">#</a> <i>axis</i>.<b>tickValues</b>([<i>values</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 164 |
|
|---|
| 165 | If a *values* iterable is specified, the specified values are used for ticks rather than using the scale’s automatic tick generator. If *values* is null, clears any previously-set explicit tick values and reverts back to the scale’s tick generator. If *values* is not specified, returns the current tick values, which defaults to null. For example, to generate ticks at specific values:
|
|---|
| 166 |
|
|---|
| 167 | ```js
|
|---|
| 168 | var xAxis = d3.axisBottom(x)
|
|---|
| 169 | .tickValues([1, 2, 3, 5, 8, 13, 21]);
|
|---|
| 170 | ```
|
|---|
| 171 |
|
|---|
| 172 | The explicit tick values take precedent over the tick arguments set by [*axis*.tickArguments](#axis_tickArguments). However, any tick arguments will still be passed to the scale’s [tickFormat](#axis_tickFormat) function if a tick format is not also set.
|
|---|
| 173 |
|
|---|
| 174 | <a name="axis_tickFormat" href="#axis_tickFormat">#</a> <i>axis</i>.<b>tickFormat</b>([<i>format</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 175 |
|
|---|
| 176 | If *format* is specified, sets the tick format function and returns the axis. If *format* is not specified, returns the current format function, which defaults to null. A null format indicates that the scale’s default formatter should be used, which is generated by calling [*scale*.tickFormat](https://github.com/d3/d3-scale/blob/master/README.md#continuous_tickFormat). In this case, the arguments specified by [*axis*.tickArguments](#axis_tickArguments) are likewise passed to *scale*.tickFormat.
|
|---|
| 177 |
|
|---|
| 178 | See [d3-format](https://github.com/d3/d3-format) and [d3-time-format](https://github.com/d3/d3-time-format) for help creating formatters. For example, to display integers with comma-grouping for thousands:
|
|---|
| 179 |
|
|---|
| 180 | ```js
|
|---|
| 181 | axis.tickFormat(d3.format(",.0f"));
|
|---|
| 182 | ```
|
|---|
| 183 |
|
|---|
| 184 | More commonly, a format specifier is passed to [*axis*.ticks](#axis_ticks):
|
|---|
| 185 |
|
|---|
| 186 | ```js
|
|---|
| 187 | axis.ticks(10, ",f");
|
|---|
| 188 | ```
|
|---|
| 189 |
|
|---|
| 190 | This has the advantage of setting the format precision automatically based on the tick interval.
|
|---|
| 191 |
|
|---|
| 192 | <a name="axis_tickSize" href="#axis_tickSize">#</a> <i>axis</i>.<b>tickSize</b>([<i>size</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 193 |
|
|---|
| 194 | If *size* is specified, sets the [inner](#axis_tickSizeInner) and [outer](#axis_tickSizeOuter) tick size to the specified value and returns the axis. If *size* is not specified, returns the current inner tick size, which defaults to 6.
|
|---|
| 195 |
|
|---|
| 196 | <a name="axis_tickSizeInner" href="#axis_tickSizeInner">#</a> <i>axis</i>.<b>tickSizeInner</b>([<i>size</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 197 |
|
|---|
| 198 | If *size* is specified, sets the inner tick size to the specified value and returns the axis. If *size* is not specified, returns the current inner tick size, which defaults to 6. The inner tick size controls the length of the tick lines, offset from the native position of the axis.
|
|---|
| 199 |
|
|---|
| 200 | <a name="axis_tickSizeOuter" href="#axis_tickSizeOuter">#</a> <i>axis</i>.<b>tickSizeOuter</b>([<i>size</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 201 |
|
|---|
| 202 | If *size* is specified, sets the outer tick size to the specified value and returns the axis. If *size* is not specified, returns the current outer tick size, which defaults to 6. The outer tick size controls the length of the square ends of the domain path, offset from the native position of the axis. Thus, the “outer ticks” are not actually ticks but part of the domain path, and their position is determined by the associated scale’s domain extent. Thus, outer ticks may overlap with the first or last inner tick. An outer tick size of 0 suppresses the square ends of the domain path, instead producing a straight line.
|
|---|
| 203 |
|
|---|
| 204 | <a name="axis_tickPadding" href="#axis_tickPadding">#</a> <i>axis</i>.<b>tickPadding</b>([<i>padding</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 205 |
|
|---|
| 206 | If *padding* is specified, sets the padding to the specified value in pixels and returns the axis. If *padding* is not specified, returns the current padding which defaults to 3 pixels.
|
|---|
| 207 |
|
|---|
| 208 | <a name="axis_offset" href="#axis_offset">#</a> <i>axis</i>.<b>offset</b>([<i>offset</i>]) · [Source](https://github.com/d3/d3-axis/blob/master/src/axis.js)
|
|---|
| 209 |
|
|---|
| 210 | If *offset* is specified, sets the offset to the specified value in pixels and returns the axis. If *offset* is not specified, returns the current offset which defaults to 0 on devices with a [devicePixelRatio](https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio) greater than 1, and 0.5px otherwise. This default offset ensures crisp edges on low-resolution devices.
|
|---|
