Skip to content

Commit 2a0ff3d

Browse files
authored
document the bundle curve (#1144)
Unless there was a reason not to document it? Couldn't find nor remember one.
1 parent 7d76c55 commit 2a0ff3d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2812,6 +2812,7 @@ The following named curve methods are supported:
28122812
* *basis-closed* - a closed cubic basis spline
28132813
* *bump-x* - a Bézier curve with horizontal tangents
28142814
* *bump-y* - a Bézier curve with vertical tangents
2815+
* *bundle* - a straightened cubic basis spline (suitable for lines only, not areas)
28152816
* *cardinal* - a cubic cardinal spline (with one-sided differences at the ends)
28162817
* *cardinal-open* - an open cubic cardinal spline
28172818
* *cardinal-closed* - an closed cubic cardinal spline
@@ -2829,7 +2830,7 @@ The following named curve methods are supported:
28292830
28302831
If *curve* is a function, it will be invoked with a given *context* in the same fashion as a [D3 curve factory](https://github.com/d3/d3-shape/blob/main/README.md#custom-curves).
28312832
2832-
The tension option only has an effect on cardinal and Catmull–Rom splines (*cardinal*, *cardinal-open*, *cardinal-closed*, *catmull-rom*, *catmull-rom-open*, and *catmull-rom-closed*). For cardinal splines, it corresponds to [tension](https://github.com/d3/d3-shape/blob/main/README.md#curveCardinal_tension); for Catmull–Rom splines, [alpha](https://github.com/d3/d3-shape/blob/main/README.md#curveCatmullRom_alpha).
2833+
The tension option only has an effect on bundle, cardinal and Catmull–Rom splines (*bundle*, *cardinal*, *cardinal-open*, *cardinal-closed*, *catmull-rom*, *catmull-rom-open*, and *catmull-rom-closed*). For bundle splines, it corresponds to [beta](https://github.com/d3/d3-shape/blob/main/README.md#curveBundle_beta); for cardinal splines, [tension](https://github.com/d3/d3-shape/blob/main/README.md#curveCardinal_tension); for Catmull–Rom splines, [alpha](https://github.com/d3/d3-shape/blob/main/README.md#curveCatmullRom_alpha).
28332834
28342835
## Markers
28352836

0 commit comments

Comments
 (0)