@@ -370,23 +370,23 @@ const graphPropTypes = {
370
370
*/
371
371
config : PropTypes . shape ( {
372
372
/**
373
- * no interactivity, for export or image generation
373
+ * No interactivity, for export or image generation
374
374
*/
375
375
staticPlot : PropTypes . bool ,
376
376
377
377
/**
378
- * base URL for a Plotly cloud instance, if `showSendToCloud` is enabled
378
+ * Base URL for a Plotly cloud instance, if `showSendToCloud` is enabled
379
379
*/
380
380
plotlyServerURL : PropTypes . string ,
381
381
382
382
/**
383
- * we can edit titles, move annotations, etc - sets all pieces of `edits`
383
+ * We can edit titles, move annotations, etc - sets all pieces of `edits`
384
384
* unless a separate `edits` config item overrides individual parts
385
385
*/
386
386
editable : PropTypes . bool ,
387
387
388
388
/**
389
- * a set of editable properties
389
+ * A set of editable properties
390
390
*/
391
391
edits : PropTypes . shape ( {
392
392
/**
@@ -397,7 +397,7 @@ const graphPropTypes = {
397
397
annotationPosition : PropTypes . bool ,
398
398
399
399
/**
400
- * just for annotations with arrows, change the length and direction of the arrow
400
+ * Just for annotations with arrows, change the length and direction of the arrow
401
401
*/
402
402
annotationTail : PropTypes . bool ,
403
403
@@ -412,14 +412,14 @@ const graphPropTypes = {
412
412
legendPosition : PropTypes . bool ,
413
413
414
414
/**
415
- * edit the trace name fields from the legend
415
+ * Edit the trace name fields from the legend
416
416
*/
417
417
legendText : PropTypes . bool ,
418
418
419
419
shapePosition : PropTypes . bool ,
420
420
421
421
/**
422
- * the global `layout.title`
422
+ * The global `layout.title`
423
423
*/
424
424
titleText : PropTypes . bool ,
425
425
} ) ,
@@ -436,27 +436,27 @@ const graphPropTypes = {
436
436
responsive : PropTypes . bool ,
437
437
438
438
/**
439
- * set the length of the undo/redo queue
439
+ * Set the length of the undo/redo queue
440
440
*/
441
441
queueLength : PropTypes . number ,
442
442
443
443
/**
444
- * if we DO autosize, do we fill the container or the screen?
444
+ * If we DO autosize, do we fill the container or the screen?
445
445
*/
446
446
fillFrame : PropTypes . bool ,
447
447
448
448
/**
449
- * if we DO autosize, set the frame margins in percents of plot size
449
+ * If we DO autosize, set the frame margins in percents of plot size
450
450
*/
451
451
frameMargins : PropTypes . number ,
452
452
453
453
/**
454
- * mousewheel or two-finger scroll zooms the plot
454
+ * Mousewheel or two-finger scroll zooms the plot
455
455
*/
456
456
scrollZoom : PropTypes . bool ,
457
457
458
458
/**
459
- * double click interaction (false, 'reset', 'autosize' or 'reset+autosize')
459
+ * Double click interaction (false, 'reset', 'autosize' or 'reset+autosize')
460
460
*/
461
461
doubleClick : PropTypes . oneOf ( [
462
462
false ,
@@ -466,50 +466,50 @@ const graphPropTypes = {
466
466
] ) ,
467
467
468
468
/**
469
- * new users see some hints about interactivity
469
+ * New users see some hints about interactivity
470
470
*/
471
471
showTips : PropTypes . bool ,
472
472
473
473
/**
474
- * enable axis pan/zoom drag handles
474
+ * Enable axis pan/zoom drag handles
475
475
*/
476
476
showAxisDragHandles : PropTypes . bool ,
477
477
478
478
/**
479
- * enable direct range entry at the pan/zoom drag points
479
+ * Enable direct range entry at the pan/zoom drag points
480
480
* (drag handles must be enabled above)
481
481
*/
482
482
showAxisRangeEntryBoxes : PropTypes . bool ,
483
483
484
484
/**
485
- * link to open this plot in plotly
485
+ * Link to open this plot in plotly
486
486
*/
487
487
showLink : PropTypes . bool ,
488
488
489
489
/**
490
- * if we show a link, does it contain data or just link to a plotly file?
490
+ * If we show a link, does it contain data or just link to a plotly file?
491
491
*/
492
492
sendData : PropTypes . bool ,
493
493
494
494
/**
495
- * text appearing in the sendData link
495
+ * Text appearing in the sendData link
496
496
*/
497
497
linkText : PropTypes . string ,
498
498
499
499
/**
500
- * display the mode bar (true, false, or 'hover')
500
+ * Display the mode bar (true, false, or 'hover')
501
501
*/
502
502
displayModeBar : PropTypes . oneOf ( [ true , false , 'hover' ] ) ,
503
503
504
504
/**
505
- * should we include a modebar button to send this data to a
505
+ * Should we include a modebar button to send this data to a
506
506
* Plotly Cloud instance, linked by `plotlyServerURL`.
507
507
* By default this is false.
508
508
*/
509
509
showSendToCloud : PropTypes . bool ,
510
510
511
511
/**
512
- * remove mode bar button by name.
512
+ * Remove mode bar button by name.
513
513
* All modebar button names at https://github.com/plotly/plotly.js/blob/master/src/components/modebar/buttons.js
514
514
* Common names include:
515
515
* - sendDataToCloud
@@ -522,19 +522,19 @@ const graphPropTypes = {
522
522
modeBarButtonsToRemove : PropTypes . array ,
523
523
524
524
/**
525
- * add mode bar button using config objects
525
+ * Add mode bar button using config objects
526
526
*/
527
527
modeBarButtonsToAdd : PropTypes . array ,
528
528
529
529
/**
530
- * fully custom mode bar buttons as nested array,
530
+ * Fully custom mode bar buttons as nested array,
531
531
* where the outer arrays represents button groups, and
532
532
* the inner arrays have buttons config objects or names of default buttons
533
533
*/
534
534
modeBarButtons : PropTypes . any ,
535
535
536
536
/**
537
- *
537
+ * Modifications to how the toImage modebar button works
538
538
*/
539
539
toImageButtonOptions : PropTypes . shape ( {
540
540
/**
@@ -561,17 +561,17 @@ const graphPropTypes = {
561
561
} ) ,
562
562
563
563
/**
564
- * add the plotly logo on the end of the mode bar
564
+ * Add the plotly logo on the end of the mode bar
565
565
*/
566
566
displaylogo : PropTypes . bool ,
567
567
568
568
/**
569
- * add the plotly logo even with no modebar
569
+ * Add the plotly logo even with no modebar
570
570
*/
571
571
watermark : PropTypes . bool ,
572
572
573
573
/**
574
- * increase the pixel ratio for Gl plot images
574
+ * Increase the pixel ratio for Gl plot images
575
575
*/
576
576
plotGlPixelRatio : PropTypes . number ,
577
577
0 commit comments