-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
attributes.js
236 lines (224 loc) · 9.43 KB
/
attributes.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
'use strict';
var overrideAll = require('../../../plot_api/edit_types').overrideAll;
var basePlotAttributes = require('../../../plots/attributes');
var fontAttrs = require('../../../plots/font_attributes');
var dash = require('../../drawing/attributes').dash;
var extendFlat = require('../../../lib/extend').extendFlat;
var shapeTexttemplateAttrs = require('../../../plots/template_attributes').shapeTexttemplateAttrs;
var shapeLabelTexttemplateVars = require('../label_texttemplate');
module.exports = overrideAll({
newshape: {
visible: extendFlat({}, basePlotAttributes.visible, {
description: [
'Determines whether or not new shape is visible.',
'If *legendonly*, the shape is not drawn,',
'but can appear as a legend item',
'(provided that the legend itself is visible).'
].join(' ')
}),
showlegend: {
valType: 'boolean',
dflt: false,
description: [
'Determines whether or not new',
'shape is shown in the legend.'
].join(' ')
},
legend: extendFlat({}, basePlotAttributes.legend, {
description: [
'Sets the reference to a legend to show new shape in.',
'References to these legends are *legend*, *legend2*, *legend3*, etc.',
'Settings for these legends are set in the layout, under',
'`layout.legend`, `layout.legend2`, etc.'
].join(' ')
}),
legendgroup: extendFlat({}, basePlotAttributes.legendgroup, {
description: [
'Sets the legend group for new shape.',
'Traces and shapes part of the same legend group hide/show at the same time',
'when toggling legend items.'
].join(' ')
}),
legendgrouptitle: {
text: extendFlat({}, basePlotAttributes.legendgrouptitle.text, {
}),
font: fontAttrs({
description: [
'Sets this legend group\'s title font.'
].join(' '),
})
},
legendrank: extendFlat({}, basePlotAttributes.legendrank, {
description: [
'Sets the legend rank for new shape.',
'Items and groups with smaller ranks are presented on top/left side while',
'with *reversed* `legend.traceorder` they are on bottom/right side.',
'The default legendrank is 1000,',
'so that you can use ranks less than 1000 to place certain items before all unranked items,',
'and ranks greater than 1000 to go after all unranked items.'
].join(' ')
}),
legendwidth: extendFlat({}, basePlotAttributes.legendwidth, {
description: 'Sets the width (in px or fraction) of the legend for new shape.',
}),
line: {
color: {
valType: 'color',
description: [
'Sets the line color.',
'By default uses either dark grey or white',
'to increase contrast with background color.'
].join(' ')
},
width: {
valType: 'number',
min: 0,
dflt: 4,
description: 'Sets the line width (in px).'
},
dash: extendFlat({}, dash, {
dflt: 'solid',
})
},
fillcolor: {
valType: 'color',
dflt: 'rgba(0,0,0,0)',
description: [
'Sets the color filling new shapes\' interior.',
'Please note that if using a fillcolor with alpha greater than half,',
'drag inside the active shape starts moving the shape underneath,',
'otherwise a new shape could be started over.'
].join(' ')
},
fillrule: {
valType: 'enumerated',
values: ['evenodd', 'nonzero'],
dflt: 'evenodd',
description: [
'Determines the path\'s interior.',
'For more info please visit https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/fill-rule'
].join(' ')
},
opacity: {
valType: 'number',
min: 0,
max: 1,
dflt: 1,
description: 'Sets the opacity of new shapes.'
},
layer: {
valType: 'enumerated',
values: ['below', 'above'],
dflt: 'above',
description: 'Specifies whether new shapes are drawn below or above traces.'
},
drawdirection: {
valType: 'enumerated',
values: ['ortho', 'horizontal', 'vertical', 'diagonal'],
dflt: 'diagonal',
description: [
'When `dragmode` is set to *drawrect*, *drawline* or *drawcircle*',
'this limits the drag to be horizontal, vertical or diagonal.',
'Using *diagonal* there is no limit e.g. in drawing lines in any direction.',
'*ortho* limits the draw to be either horizontal or vertical.',
'*horizontal* allows horizontal extend.',
'*vertical* allows vertical extend.'
].join(' ')
},
name: extendFlat({}, basePlotAttributes.name, {
description: [
'Sets new shape name.',
'The name appears as the legend item.'
].join(' ')
}),
label: {
text: {
valType: 'string',
dflt: '',
description: [
'Sets the text to display with the new shape.',
'It is also used for legend item if `name` is not provided.'
].join(' ')
},
texttemplate: shapeTexttemplateAttrs({newshape: true}, {keys: Object.keys(shapeLabelTexttemplateVars)}),
font: fontAttrs({
description: 'Sets the new shape label text font.'
}),
textposition: {
valType: 'enumerated',
values: [
'top left', 'top center', 'top right',
'middle left', 'middle center', 'middle right',
'bottom left', 'bottom center', 'bottom right',
'start', 'middle', 'end',
],
description: [
'Sets the position of the label text relative to the new shape.',
'Supported values for rectangles, circles and paths are',
'*top left*, *top center*, *top right*, *middle left*,',
'*middle center*, *middle right*, *bottom left*, *bottom center*,',
'and *bottom right*.',
'Supported values for lines are *start*, *middle*, and *end*.',
'Default: *middle center* for rectangles, circles, and paths; *middle* for lines.',
].join(' ')
},
textangle: {
valType: 'angle',
dflt: 'auto',
description: [
'Sets the angle at which the label text is drawn',
'with respect to the horizontal. For lines, angle *auto*',
'is the same angle as the line. For all other shapes,',
'angle *auto* is horizontal.'
].join(' ')
},
xanchor: {
valType: 'enumerated',
values: ['auto', 'left', 'center', 'right'],
dflt: 'auto',
description: [
'Sets the label\'s horizontal position anchor',
'This anchor binds the specified `textposition` to the *left*, *center*',
'or *right* of the label text.',
'For example, if `textposition` is set to *top right* and',
'`xanchor` to *right* then the right-most portion of the',
'label text lines up with the right-most edge of the',
'new shape.',
].join(' '),
},
yanchor: {
valType: 'enumerated',
values: ['top', 'middle', 'bottom'],
description: [
'Sets the label\'s vertical position anchor',
'This anchor binds the specified `textposition` to the *top*, *middle*',
'or *bottom* of the label text.',
'For example, if `textposition` is set to *top right* and',
'`yanchor` to *top* then the top-most portion of the',
'label text lines up with the top-most edge of the',
'new shape.',
].join(' ')
},
padding: {
valType: 'number',
dflt: 3,
min: 0,
description: 'Sets padding (in px) between edge of label and edge of new shape.'
}
}
},
activeshape: {
fillcolor: {
valType: 'color',
dflt: 'rgb(255,0,255)',
description: 'Sets the color filling the active shape\' interior.'
},
opacity: {
valType: 'number',
min: 0,
max: 1,
dflt: 0.5,
description: 'Sets the opacity of the active shape.'
}
}
}, 'none', 'from-root');