Skip to content

Commit 29931ec

Browse files
committed
fix annotation comments/descriptions
1 parent bbfe399 commit 29931ec

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

src/components/annotations/arrow_paths.js

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,13 @@
99
'use strict';
1010

1111
/**
12-
* centerx is a center of scaling tuned for maximum scalability of
13-
* the arrowhead ie throughout mag=0.3..3 the head is joined smoothly
14-
* to the line, but the endpoint moves.
15-
* backoff is the distance to move the arrowhead, and the end of the
16-
* line, in order to end at the right place
17-
*
18-
* TODO: option to have the pointed-to point a little in front of the
19-
* end of the line, as people tend to want a bit of a gap there...
12+
* All paths are tuned for maximum scalability of the arrowhead,
13+
* ie throughout arrowwidth=0.3..3 the head is joined smoothly
14+
* to the line, with the line coming from the left and ending at (0, 0).
15+
* `backoff` is the distance to move the arrowhead and the end of the line,
16+
* in order that the arrowhead points to the desired place, either at
17+
* the tip of the arrow or (in the case of circle or square)
18+
* the center of the symbol.
2019
*/
2120

2221
module.exports = [

src/components/annotations/attributes.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,13 +164,16 @@ module.exports = {
164164
min: 0.3,
165165
dflt: 1,
166166
role: 'style',
167-
description: 'Sets the size (in px) of annotation arrow head.'
167+
description: [
168+
'Sets the size of the annotation arrow head, relative to `arrowwidth`.',
169+
'A value of 1 (default) gives a head about 3x as wide as the line.'
170+
].join(' ')
168171
},
169172
arrowwidth: {
170173
valType: 'number',
171174
min: 0.1,
172175
role: 'style',
173-
description: 'Sets the width (in px) of annotation arrow.'
176+
description: 'Sets the width (in px) of annotation arrow line.'
174177
},
175178
standoff: {
176179
valType: 'number',

0 commit comments

Comments
 (0)