Skip to content

Commit 706a883

Browse files
archmojarchmoj
committed
add option to enable legends for
- choropleth - choroplethmapbox - cone - densitymapbox - heatmap - histogram2d - isosurface - mesh3d - streamtube - surface - volume
1 parent 9174470 commit 706a883

File tree

26 files changed

+173
-28
lines changed

26 files changed

+173
-28
lines changed

‎src/components/legend/defaults.js

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,14 @@ module.exports = function legendDefaults(layoutIn, layoutOut, fullData) {
3333
// *would* be shown by default, toward the two traces you need to
3434
// ensure the legend is shown by default, because this can still help
3535
// disambiguate.
36-
if(trace.showlegend || trace._dfltShowLegend) {
36+
if(trace.showlegend || (
37+
trace._dfltShowLegend && !(
38+
trace._module &&
39+
trace._module.attributes &&
40+
trace._module.attributes.showlegend &&
41+
trace._module.attributes.showlegend.dflt === false
42+
)
43+
)) {
3744
legendTraceCount++;
3845
if(trace.showlegend) {
3946
legendReallyHasATrace = true;

‎src/components/legend/style.js

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ module.exports = function style(s, gd) {
8484
.enter().append('g')
8585
.classed('legendpoints', true);
8686
})
87+
.each(styleSpatial)
8788
.each(styleWaterfalls)
8889
.each(styleFunnels)
8990
.each(styleBars)
@@ -481,6 +482,124 @@ module.exports = function style(s, gd) {
481482
stylePie(pts, d0Mod, tMod);
482483
}
483484
}
485+
486+
function styleSpatial(d) { // i.e. maninly traces having z and colorscale
487+
var trace = d[0].trace;
488+
489+
var useGradient;
490+
var ptsData = [];
491+
if(trace.visible) {
492+
switch(trace.type) {
493+
case 'histogram2d' :
494+
case 'heatmap' :
495+
ptsData = [
496+
['M-15,-2V4H15V-2Z'] // similar to contour
497+
];
498+
useGradient = true;
499+
break;
500+
case 'choropleth' :
501+
case 'choroplethmapbox' :
502+
case 'densitymapbox' :
503+
ptsData = [
504+
['M-6,-6V6H6V-6Z']
505+
];
506+
useGradient = true;
507+
break;
508+
case 'cone' :
509+
ptsData = [
510+
['M-6,2 A2,2 0 0,0 -6,6 V6L6,4Z'],
511+
['M-6,-6 A2,2 0 0,0 -6,-2 L6,-4Z'],
512+
['M-6,-2 A2,2 0 0,0 -6,2 L6,0Z']
513+
];
514+
useGradient = false;
515+
break;
516+
case 'streamtube' :
517+
ptsData = [
518+
['M-6,2 A2,2 0 0,0 -6,6 H6 A2,2 0 0,1 6,2 Z'],
519+
['M-6,-6 A2,2 0 0,0 -6,-2 H6 A2,2 0 0,1 6,-6 Z'],
520+
['M-6,-2 A2,2 0 0,0 -6,2 H6 A2,2 0 0,1 6,-2 Z']
521+
];
522+
useGradient = false;
523+
break;
524+
case 'surface' :
525+
ptsData = [
526+
['M-6,-6 A2,3 0 0,0 -6,0 H6 A2,3 0 0,1 6,-6 Z'],
527+
['M-6,1 A2,3 0 0,1 -6,6 H6 A2,3 0 0,0 6,0 Z']
528+
];
529+
useGradient = true;
530+
break;
531+
case 'mesh3d' :
532+
ptsData = [
533+
['M-6,6H0L-6,-6Z'],
534+
['M6,6H0L6,-6Z'],
535+
['M-6,-6H6L0,6Z']
536+
];
537+
useGradient = false;
538+
break;
539+
case 'volume' :
540+
ptsData = [
541+
['M-6,6H0L-6,-6Z'],
542+
['M6,6H0L6,-6Z'],
543+
['M-6,-6H6L0,6Z']
544+
];
545+
useGradient = true;
546+
break;
547+
case 'isosurface':
548+
ptsData = [
549+
['M-6,6H0L-6,-6Z'],
550+
['M6,6H0L6,-6Z'],
551+
['M-6,-6 A12,24 0 0,0 6,-6 L0,6Z']
552+
];
553+
useGradient = false;
554+
break;
555+
}
556+
}
557+
558+
var pts = d3.select(this).select('g.legendpoints')
559+
.selectAll('path.legend3dandfriends')
560+
.data(ptsData);
561+
pts.enter().append('path').classed('legend3dandfriends', true)
562+
.attr('transform', 'translate(20,0)')
563+
.style('stroke-miterlimit', 1);
564+
pts.exit().remove();
565+
566+
pts.each(function(dd, i) {
567+
var pt = d3.select(this);
568+
569+
var cOpts = extractOpts(trace);
570+
var colorscale = cOpts.colorscale;
571+
var reversescale = cOpts.reversescale;
572+
var fillGradient = function(s) {
573+
if(s.size()) {
574+
var gradientID = 'legendfill-' + trace.uid;
575+
Drawing.gradient(s, gd, gradientID,
576+
reversescale ? 'horizontal' : 'horizontalreversed',
577+
colorscale, 'fill');
578+
}
579+
};
580+
581+
var fillColor;
582+
if(!colorscale) {
583+
var color = trace.vertexcolor || trace.facecolor || trace.color;
584+
fillColor = Lib.isArrayOrTypedArray(color) ? (color[i] || color[0]) : color;
585+
} else {
586+
if(!useGradient) {
587+
var len = colorscale.length;
588+
fillColor =
589+
i === 0 ? colorscale[reversescale ? len - 1 : 0][1] : // minimum
590+
i === 1 ? colorscale[reversescale ? 0 : len - 1][1] : // maximum
591+
colorscale[Math.floor((len - 1) / 2)][1]; // middle
592+
}
593+
}
594+
595+
pt.attr('d', dd[0]);
596+
if(fillColor) {
597+
pt.call(Color.fill, fillColor);
598+
} else {
599+
pt.call(fillGradient);
600+
}
601+
});
602+
}
484603
};
485604

486605
function getGradientDirection(reversescale) {

‎src/plots/plots.js

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1291,9 +1291,16 @@ plots.supplyTraceDefaults = function(traceIn, traceOut, colorIndex, layout, trac
12911291
coerce('meta');
12921292

12931293
if(Registry.traceIs(traceOut, 'showLegend')) {
1294-
traceOut._dfltShowLegend = true;
1295-
coerce('showlegend');
1294+
Lib.coerce(traceIn, traceOut,
1295+
_module.attributes.showlegend ?
1296+
_module.attributes :
1297+
plots.attributes,
1298+
'showlegend'
1299+
);
1300+
12961301
coerce('legendgroup');
1302+
1303+
traceOut._dfltShowLegend = true;
12971304
} else {
12981305
traceOut._dfltShowLegend = false;
12991306
}

‎src/traces/choropleth/attributes.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ module.exports = extendFlat({
7777
editType: 'calc',
7878
flags: ['location', 'z', 'text', 'name']
7979
}),
80-
hovertemplate: hovertemplateAttrs()
80+
hovertemplate: hovertemplateAttrs(),
81+
showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
8182
},
8283

8384
colorScaleAttrs('', {

‎src/traces/choropleth/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = {
2323
moduleType: 'trace',
2424
name: 'choropleth',
2525
basePlotModule: require('../../plots/geo'),
26-
categories: ['geo', 'noOpacity'],
26+
categories: ['geo', 'noOpacity', 'showLegend'],
2727
meta: {
2828
description: [
2929
'The data that describes the choropleth value-to-color mapping',

‎src/traces/choroplethmapbox/attributes.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
var choroplethAttrs = require('../choropleth/attributes');
1212
var colorScaleAttrs = require('../../components/colorscale/attributes');
1313
var hovertemplateAttrs = require('../../plots/template_attributes').hovertemplateAttrs;
14-
14+
var baseAttrs = require('../../plots/attributes');
1515
var extendFlat = require('../../lib/extend').extendFlat;
1616

1717
module.exports = extendFlat({
@@ -103,7 +103,8 @@ module.exports = extendFlat({
103103
},
104104

105105
hoverinfo: choroplethAttrs.hoverinfo,
106-
hovertemplate: hovertemplateAttrs({}, {keys: ['properties']})
106+
hovertemplate: hovertemplateAttrs({}, {keys: ['properties']}),
107+
showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
107108
},
108109

109110
colorScaleAttrs('', {

‎src/traces/choroplethmapbox/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ module.exports = {
5252
moduleType: 'trace',
5353
name: 'choroplethmapbox',
5454
basePlotModule: require('../../plots/mapbox'),
55-
categories: ['mapbox', 'gl', 'noOpacity'],
55+
categories: ['mapbox', 'gl', 'noOpacity', 'showLegend'],
5656
meta: {
5757
hr_name: 'choropleth_mapbox',
5858
description: [

‎src/traces/cone/attributes.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,9 @@ var attrs = {
166166
editType: 'calc',
167167
description: 'Same as `text`.'
168168
},
169-
hovertemplate: hovertemplateAttrs({editType: 'calc'}, {keys: ['norm']})
169+
170+
hovertemplate: hovertemplateAttrs({editType: 'calc'}, {keys: ['norm']}),
171+
showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
170172
};
171173

172174
extendFlat(attrs, colorScaleAttrs('', {

‎src/traces/cone/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module.exports = {
1212
moduleType: 'trace',
1313
name: 'cone',
1414
basePlotModule: require('../../plots/gl3d'),
15-
categories: ['gl3d'],
15+
categories: ['gl3d', 'showLegend'],
1616

1717
attributes: require('./attributes'),
1818
supplyDefaults: require('./defaults'),

‎src/traces/densitymapbox/attributes.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ module.exports = extendFlat({
8484
hoverinfo: extendFlat({}, baseAttrs.hoverinfo, {
8585
flags: ['lon', 'lat', 'z', 'text', 'name']
8686
}),
87-
hovertemplate: hovertemplateAttrs()
87+
hovertemplate: hovertemplateAttrs(),
88+
showlegend: extendFlat({}, baseAttrs.showlegend, {dflt: false})
8889
},
8990
colorScaleAttrs('', {
9091
cLetter: 'z',

0 commit comments

Comments
 (0)