Skip to content

Commit 9f94494

Browse files
committed
add info about data/layout and fullData/fullLayout
1 parent c59a960 commit 9f94494

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

src/plots/plots.js

+7-4
Original file line numberDiff line numberDiff line change
@@ -438,16 +438,19 @@ plots.sendDataToCloud = function(gd) {
438438
// Fill in default values:
439439
//
440440
// gd.data, gd.layout:
441-
// are precisely what the user specified
441+
// are precisely what the user specified,
442+
// these fields shouldn't be modified nor used directly
443+
// after the supply defaults step.
442444
//
443445
// gd._fullData, gd._fullLayout:
444-
// are complete descriptions of how to draw the plot
446+
// are complete descriptions of how to draw the plot,
447+
// use these fields in all required computations.
445448
//
446449
// gd._fullLayout._modules
447-
// is a list of all the trace modules required to draw the plot
450+
// is a list of all the trace modules required to draw the plot.
448451
//
449452
// gd._fullLayout._basePlotModules
450-
// is a list of all the plot modules required to draw the plot
453+
// is a list of all the plot modules required to draw the plot.
451454
//
452455
plots.supplyDefaults = function(gd) {
453456
var oldFullLayout = gd._fullLayout || {},

0 commit comments

Comments
 (0)