Skip to content

Commit 8e20ae0

Browse files
committed
document link maybeSameValue
1 parent f70a2a2 commit 8e20ae0

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

src/marks/link.d.ts

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,42 @@ import type {MarkerOptions} from "../marker.js";
55

66
/** Options for the link mark. */
77
export interface LinkOptions extends MarkOptions, MarkerOptions, CurveAutoOptions {
8-
/** The horizontal position, for vertical links; bound to the *x* scale. */
8+
/**
9+
* The horizontal position, for vertical links; bound to the *x* scale. **x**
10+
* specifies defaults for both **x1** and **x2**.
11+
*/
912
x?: ChannelValueSpec;
10-
/** The vertical position, for horizontal links; bound to the *y* scale. */
13+
14+
/**
15+
* The vertical position, for horizontal links; bound to the *y* scale. **y**
16+
* specifies defaults for both **y1** and **y2**.
17+
*/
1118
y?: ChannelValueSpec;
12-
/** The starting horizontal position; bound to the *x* scale. */
19+
20+
/**
21+
* The starting horizontal position; bound to the *x* scale. **x1** specifies
22+
* defaults for **x2**.
23+
*/
1324
x1?: ChannelValueSpec;
14-
/** The ending vertical position; bound to the *y* scale. */
25+
26+
/**
27+
* The starting vertical position; bound to the *y* scale. **y1** specifies
28+
* defaults for **y2**.
29+
*/
1530
y1?: ChannelValueSpec;
16-
/** The starting horizontal position; bound to the *x* scale. */
31+
32+
/**
33+
* The ending horizontal position; bound to the *x* scale. **x2** specifies
34+
* defaults for **x1**.
35+
*/
1736
x2?: ChannelValueSpec;
18-
/** The ending vertical position; bound to the *y* scale. */
37+
38+
/**
39+
* The ending vertical position; bound to the *y* scale. **y2** specifies
40+
* defaults for **y1**.
41+
*/
1942
y2?: ChannelValueSpec;
43+
2044
/**
2145
* The **curve** option controls interpolation between points. Since a link
2246
* always has two points by definition, only the following curves (or a custom

0 commit comments

Comments
 (0)