Skip to content

Commit a71efa7

Browse files
committed
add jsdoc
1 parent ada31b5 commit a71efa7

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/plots/plots.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,16 @@ plots.getSubplotIds = function getSubplotIds(layout, type) {
216216
return subplotIds;
217217
};
218218

219+
/**
220+
* Get the data trace(s) associated with a given subplot.
221+
*
222+
* @param {array} data plotly full data array.
223+
* @param {object} layout plotly full layout object.
224+
* @param {string} subplotId subplot ids to look for.
225+
*
226+
* @return {array} list of trace objects.
227+
*
228+
*/
219229
plots.getSubplotData = function getSubplotData(data, type, subplotId) {
220230
if(plots.subplotsRegistry[type] === undefined) return [];
221231

0 commit comments

Comments
 (0)