FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
plotly.js/src/plot_api/plot_config.js at main · plotly/plotly.js · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
plotly
/
plotly.js
Public
Uh oh!
There was an error while loading.
Please reload this page
.
Notifications
You must be signed in to change notification settings
Fork
2k
Star
18.3k
Code
Issues
757
Pull requests
66
Actions
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
plotly.js
/
src
/
plot_api
/
plot_config.js
Copy path
More file actions
More file actions
Latest commit
History
History
History
434 lines (410 loc) · 14.3 KB
Breadcrumbs
plotly.js
/
src
/
plot_api
/
plot_config.js
Copy path
File metadata and controls
434 lines (410 loc) · 14.3 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
'use strict'
;
/**
* This will be transferred over to gd and overridden by
* config args to Plotly.newPlot.
*
* The defaults are the appropriate settings for plotly.js,
* so we get the right experience without any config argument.
*
* N.B. the config options are not coerced using Lib.coerce so keys
* like `valType` and `values` are only set for documentation purposes
* at the moment.
*/
var
configAttributes
=
{
staticPlot
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Determines whether the graphs are interactive or not.'
,
'If *false*, no interactivity, for export or image generation.'
]
.
join
(
' '
)
}
,
typesetMath
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Determines whether math should be typeset or not,'
,
'when MathJax (either v3 or v4) is present on the page.'
]
.
join
(
' '
)
}
,
plotlyServerURL
:
{
valType
:
'string'
,
dflt
:
'https://cloud.plotly.com/newchart'
,
description
:
[
'Sets the URL for the `sendChartToCloud` modebar button.'
,
'When clicked, the button will send the chart data to this URL.'
,
]
.
join
(
' '
)
}
,
editable
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Determines whether the graph is editable or not.'
,
'Sets all pieces of `edits`'
,
'unless a separate `edits` config item overrides individual parts.'
]
.
join
(
' '
)
}
,
edits
:
{
annotationPosition
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Determines if the main anchor of the annotation is editable.'
,
'The main anchor corresponds to the'
,
'text (if no arrow) or the arrow (which drags the whole thing leaving'
,
'the arrow length & direction unchanged).'
]
.
join
(
' '
)
}
,
annotationTail
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Has only an effect for annotations with arrows.'
,
'Enables changing the length and direction of the arrow.'
]
.
join
(
' '
)
}
,
annotationText
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables editing annotation text.'
}
,
axisTitleText
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables editing axis title text.'
}
,
colorbarPosition
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables moving colorbars.'
}
,
colorbarTitleText
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables editing colorbar title text.'
}
,
legendPosition
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables moving the legend.'
}
,
legendText
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables editing the trace name fields from the legend'
}
,
shapePosition
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables moving shapes.'
}
,
titleText
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'Enables editing the global layout title.'
}
}
,
editSelection
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
'Enables moving selections.'
}
,
autosizable
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Determines whether the graphs are plotted with respect to'
,
'layout.autosize:true and infer its container size.'
]
.
join
(
' '
)
}
,
responsive
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'Determines whether to change the layout size when window is resized.'
,
'In v3, this option will be removed and will always be true.'
]
.
join
(
' '
)
}
,
fillFrame
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
[
'When `layout.autosize` is turned on, determines whether the graph'
,
'fills the container (the default) or the screen (if set to *true*).'
]
.
join
(
' '
)
}
,
frameMargins
:
{
valType
:
'number'
,
dflt
:
0
,
min
:
0
,
max
:
0.5
,
description
:
[
'When `layout.autosize` is turned on, set the frame margins'
,
'in fraction of the graph size.'
]
.
join
(
' '
)
}
,
scrollZoom
:
{
valType
:
'flaglist'
,
flags
:
[
'cartesian'
,
'gl3d'
,
'geo'
,
'map'
]
,
extras
:
[
true
,
false
]
,
dflt
:
'gl3d+geo+map'
,
description
:
[
'Determines whether mouse wheel or two-finger scroll zooms is enable.'
,
'Turned on by default for gl3d, geo and map subplots'
,
'(as these subplot types do not have zoombox via pan),'
,
'but turned off by default for cartesian subplots.'
,
'Set `scrollZoom` to *false* to disable scrolling for all subplots.'
]
.
join
(
' '
)
}
,
doubleClick
:
{
valType
:
'enumerated'
,
values
:
[
false
,
'reset'
,
'autosize'
,
'reset+autosize'
]
,
dflt
:
'reset+autosize'
,
description
:
[
'Sets the double click interaction mode.'
,
'Has an effect only in cartesian plots.'
,
'If *false*, double click is disable.'
,
'If *reset*, double click resets the axis ranges to their initial values.'
,
'If *autosize*, double click set the axis ranges to their autorange values.'
,
'If *reset+autosize*, the odd double clicks resets the axis ranges'
,
'to their initial values and even double clicks set the axis ranges'
,
'to their autorange values.'
]
.
join
(
' '
)
}
,
doubleClickDelay
:
{
valType
:
'number'
,
dflt
:
300
,
min
:
0
,
description
:
[
'Sets the delay for registering a double-click in ms.'
,
'This is the time interval (in ms) between first mousedown and'
,
'2nd mouseup to constitute a double-click.'
,
'This setting propagates to all on-subplot double clicks'
,
'(except for geo and map) and on-legend double clicks.'
]
.
join
(
' '
)
}
,
showAxisDragHandles
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Set to *false* to omit cartesian axis pan/zoom drag handles.'
]
.
join
(
' '
)
}
,
showAxisRangeEntryBoxes
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Set to *false* to omit direct range entry at the pan/zoom drag points,'
,
'note that `showAxisDragHandles` must be enabled to have an effect.'
]
.
join
(
' '
)
}
,
showTips
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Determines whether or not tips are shown while interacting'
,
'with the resulting graphs.'
]
.
join
(
' '
)
}
,
displayNotifier
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
'Determines whether or not notifier is displayed.'
}
,
displayModeBar
:
{
valType
:
'enumerated'
,
values
:
[
'hover'
,
true
,
false
]
,
dflt
:
'hover'
,
description
:
[
'Determines the mode bar display mode.'
,
'If *true*, the mode bar is always visible.'
,
'If *false*, the mode bar is always hidden.'
,
'If *hover*, the mode bar is visible while the mouse cursor'
,
'is on the graph container.'
]
.
join
(
' '
)
}
,
showSendToCloud
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Should we include a modebar button that sends this chart to a URL'
,
'specified by `plotlyServerURL`, for sharing the chart with others?'
,
'Note that this button will (after a confirmation step)'
,
'send chart data to an external server.'
]
.
join
(
' '
)
}
,
modeBarButtonsToRemove
:
{
valType
:
'any'
,
dflt
:
[
]
,
description
:
[
'Remove mode bar buttons by name.'
,
'See ./components/modebar/buttons.js for the list of names.'
]
.
join
(
' '
)
}
,
modeBarButtonsToAdd
:
{
valType
:
'any'
,
dflt
:
[
]
,
description
:
[
'Add mode bar button using config objects'
,
'See ./components/modebar/buttons.js for list of arguments.'
,
'To enable predefined modebar buttons e.g. shape drawing, hover and spikelines,'
,
'simply provide their string name(s). This could include:'
,
'*v1hovermode*, *hoverclosest*, *hovercompare*, *togglehover*, *togglespikelines*,'
,
'*drawline*, *drawopenpath*, *drawclosedpath*, *drawcircle*, *drawrect* and *eraseshape*.'
,
'Please note that these predefined buttons will only be shown if they are compatible'
,
'with all trace types used in a graph.'
]
.
join
(
' '
)
}
,
modeBarButtons
:
{
valType
:
'any'
,
dflt
:
false
,
description
:
[
'Define fully custom mode bar buttons as nested array,'
,
'where the outer arrays represents button groups, and'
,
'the inner arrays have buttons config objects or names of default buttons'
,
'See ./components/modebar/buttons.js for more info.'
]
.
join
(
' '
)
}
,
toImageButtonOptions
:
{
valType
:
'any'
,
dflt
:
{
}
,
description
:
[
'Statically override options for toImage modebar button'
,
'allowed keys are format, filename, width, height, scale'
,
'see ../components/modebar/buttons.js'
]
.
join
(
' '
)
}
,
displaylogo
:
{
valType
:
'boolean'
,
dflt
:
true
,
description
:
[
'Determines whether or not the plotly logo is displayed'
,
'on the end of the mode bar.'
]
.
join
(
' '
)
}
,
watermark
:
{
valType
:
'boolean'
,
dflt
:
false
,
description
:
'watermark the images with the company\'s logo'
}
,
plotGlPixelRatio
:
{
valType
:
'number'
,
dflt
:
2
,
min
:
1
,
max
:
4
,
description
:
[
'Set the pixel ratio during WebGL image export.'
]
.
join
(
' '
)
}
,
setBackground
:
{
valType
:
'any'
,
dflt
:
'transparent'
,
description
:
[
'Set function to add the background color (i.e. `layout.paper_color`)'
,
'to a different container.'
,
'This function take the graph div as first argument and the current background'
,
'color as second argument.'
,
'Alternatively, set to string *opaque* to ensure there is white behind it.'
]
.
join
(
' '
)
}
,
topojsonURL
:
{
valType
:
'string'
,
noBlank
:
true
,
// TODO: Switch the default back to 'https://cdn.plot.ly/' once we remove the legacy maps
dflt
:
'https://cdn.plot.ly/un/'
,
description
:
[
'Set the URL to topojson used in geo charts.'
,
'By default, the topojson files are fetched from cdn.plot.ly.'
,
'For example, set this option to:'
,
'<path-to-plotly.js>/dist/topojson/'
,
'to render geographical feature using the topojson files'
,
'that ship with the plotly.js module.'
]
.
join
(
' '
)
}
,
logging
:
{
valType
:
'integer'
,
min
:
0
,
max
:
2
,
dflt
:
1
,
description
:
[
'Turn all console logging on or off (errors will be thrown)'
,
'This should ONLY be set via Plotly.setPlotConfig'
,
'Available levels:'
,
'0: no logs'
,
'1: warnings and errors, but not informational messages'
,
'2: verbose logs'
]
.
join
(
' '
)
}
,
notifyOnLogging
:
{
valType
:
'integer'
,
min
:
0
,
max
:
2
,
dflt
:
0
,
description
:
[
'Set on-graph logging (notifier) level'
,
'This should ONLY be set via Plotly.setPlotConfig'
,
'Available levels:'
,
'0: no on-graph logs'
,
'1: warnings and errors, but not informational messages'
,
'2: verbose logs'
]
.
join
(
' '
)
}
,
queueLength
:
{
valType
:
'integer'
,
min
:
0
,
dflt
:
0
,
description
:
'Sets the length of the undo/redo queue.'
}
,
locale
:
{
valType
:
'string'
,
dflt
:
'en-US'
,
description
:
[
'Which localization should we use?'
,
'Should be a string like \'en\' or \'en-US\'.'
]
.
join
(
' '
)
}
,
locales
:
{
valType
:
'any'
,
dflt
:
{
}
,
description
:
[
'Localization definitions'
,
'Locales can be provided either here (specific to one chart) or globally'
,
'by registering them as modules.'
,
'Should be an object of objects {locale: {dictionary: {...}, format: {...}}}'
,
'{'
,
' da: {'
,
' dictionary: {\'Reset axes\': \'Nulstil aksler\', ...},'
,
' format: {months: [...], shortMonths: [...]}'
,
' },'
,
' ...'
,
'}'
,
'All parts are optional. When looking for translation or format fields, we'
,
'look first for an exact match in a config locale, then in a registered'
,
'module. If those fail, we strip off any regionalization (\'en-US\' -> \'en\')'
,
'and try each (config, registry) again. The final fallback for translation'
,
'is untranslated (which is US English) and for formats is the base English'
,
'(the only consequence being the last fallback date format %x is DD/MM/YYYY'
,
'instead of MM/DD/YYYY). Currently `grouping` and `currency` are ignored'
,
'for our automatic number formatting, but can be used in custom formats.'
]
.
join
(
' '
)
}
}
;
var
dfltConfig
=
{
}
;
function
crawl
(
src
,
target
)
{
for
(
var
k
in
src
)
{
var
obj
=
src
[
k
]
;
if
(
obj
.
valType
)
{
target
[
k
]
=
obj
.
dflt
;
}
else
{
if
(
!
target
[
k
]
)
{
target
[
k
]
=
{
}
;
}
crawl
(
obj
,
target
[
k
]
)
;
}
}
}
crawl
(
configAttributes
,
dfltConfig
)
;
module
.
exports
=
{
configAttributes
:
configAttributes
,
dfltConfig
:
dfltConfig
}
;
Back
|
FazBrowse Home
|
New Git URL