Skip to content

Commit 906220d

Browse files
committed
Add carpet meta
1 parent e3b6d2a commit 906220d

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

src/traces/carpet/index.js

+7
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ Carpet.basePlotModule = require('../../plots/cartesian');
2323
Carpet.categories = ['cartesian', 'carpet', 'carpetAxis', 'notLegendIsolatable'];
2424
Carpet.meta = {
2525
description: [
26+
'The data describing carpet axis layout is set in `y` and (optionally)',
27+
'also `x`. If only `y` is present, `x` the plot is interpreted as a',
28+
'cheater plot and is filled in using the `y` values.',
29+
30+
'`x` and `y` may either be 2D arrays matching with each dimension matching',
31+
'that of `a` and `b`, or they may be 1D arrays with total length equal to',
32+
'that of `a` and `b`.'
2633
].join(' ')
2734
};
2835

src/traces/contourcarpet/index.js

+6-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,12 @@ ContourCarpet.basePlotModule = require('../../plots/cartesian');
2323
ContourCarpet.categories = ['cartesian', 'carpet', 'contour', 'symbols', 'showLegend', 'hasLines', 'carpetDependent'];
2424
ContourCarpet.meta = {
2525
hrName: 'contour_carpet',
26-
description: [].join(' ')
26+
description: [
27+
'Plots contours on either the first carpet axis or the',
28+
'carpet axis with a matching `carpet` attribute. Data `z`',
29+
'is interpreted as matching that of the corresponding carpet',
30+
'axis.'
31+
].join(' ')
2732
};
2833

2934
module.exports = ContourCarpet;

src/traces/scattercarpet/index.js

+4-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ ScatterCarpet.basePlotModule = require('../../plots/cartesian');
2525
ScatterCarpet.categories = ['carpet', 'symbols', 'markerColorscale', 'showLegend', 'carpetDependent'];
2626
ScatterCarpet.meta = {
2727
hrName: 'scatter_carpet',
28-
description: [].join(' ')
28+
description: [
29+
'Plots a scatter trace on either the first carpet axis or the',
30+
'carpet axis with a matching `carpet` attribute.'
31+
].join(' ')
2932
};
3033

3134
module.exports = ScatterCarpet;

0 commit comments

Comments
 (0)