Skip to content

add delta.prefix and delta.suffix in Indicator trace #6246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions draftlogs/6246_add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Add `delta.prefix` and `delta.suffix` to Indicator trace [[#6246](https://github.com/plotly/plotly.js/pull/6246)],
with thanks to @paulovieira for the contribution!
16 changes: 16 additions & 0 deletions src/traces/indicator/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,22 @@ module.exports = {
'Set the font used to display the delta'
].join(' ')
}),
prefix: {
valType: 'string',
dflt: '',
editType: 'plot',
description: [
'Sets a prefix appearing before the delta.'
].join(' ')
},
suffix: {
valType: 'string',
dflt: '',
editType: 'plot',
description: [
'Sets a suffix appearing next to the delta.'
].join(' ')
},
editType: 'calc'
},
gauge: {
Expand Down
2 changes: 2 additions & 0 deletions src/traces/indicator/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
coerce('delta.decreasing.symbol');
coerce('delta.decreasing.color');
coerce('delta.position');
coerce('delta.prefix');
coerce('delta.suffix');
deltaFontSize = traceOut.delta.font.size;
}
traceOut._scaleNumbers = (!traceOut._hasNumber || auto[0]) && (!traceOut._hasDelta || auto[1]) || false;
Expand Down
13 changes: 8 additions & 5 deletions src/traces/indicator/plot.js
Original file line number Diff line number Diff line change
Expand Up @@ -571,15 +571,15 @@ function drawNumbers(gd, plotGroup, cd, opts) {
bignumberAx.setScale();
Axes.prepTicks(bignumberAx);

var fmt = function(v) { return Axes.tickText(bignumberAx, v).text;};
var bignumberFmt = function(v) { return Axes.tickText(bignumberAx, v).text;};
var bignumberSuffix = trace.number.suffix;
var bignumberPrefix = trace.number.prefix;

var number = numbers.select('text.number');

function writeNumber() {
var txt = typeof cd[0].y === 'number' ?
bignumberPrefix + fmt(cd[0].y) + bignumberSuffix :
bignumberPrefix + bignumberFmt(cd[0].y) + bignumberSuffix :
'-';
number.text(txt)
.call(Drawing.font, trace.number.font)
Expand All @@ -598,7 +598,7 @@ function drawNumbers(gd, plotGroup, cd, opts) {
var interpolator = interpolateNumber(cd[0].lastY, cd[0].y);
trace._lastValue = cd[0].y;

var transitionFmt = transitionFormat(trace.number.valueformat, fmt, cd[0].lastY, cd[0].y);
var transitionFmt = transitionFormat(trace.number.valueformat, bignumberFmt, cd[0].lastY, cd[0].y);
return function(t) {
that.text(bignumberPrefix + transitionFmt(interpolator(t)) + bignumberSuffix);
};
Expand All @@ -607,7 +607,7 @@ function drawNumbers(gd, plotGroup, cd, opts) {
writeNumber();
}

bignumberbBox = measureText(bignumberPrefix + fmt(cd[0].y) + bignumberSuffix, trace.number.font, numbersAnchor, gd);
bignumberbBox = measureText(bignumberPrefix + bignumberFmt(cd[0].y) + bignumberSuffix, trace.number.font, numbersAnchor, gd);
return number;
}

Expand All @@ -617,13 +617,16 @@ function drawNumbers(gd, plotGroup, cd, opts) {
Axes.prepTicks(deltaAx);

var deltaFmt = function(v) { return Axes.tickText(deltaAx, v).text;};
var deltaSuffix = trace.delta.suffix;
var deltaPrefix = trace.delta.prefix;

var deltaValue = function(d) {
var value = trace.delta.relative ? d.relativeDelta : d.delta;
return value;
};
var deltaFormatText = function(value, numberFmt) {
if(value === 0 || typeof value !== 'number' || isNaN(value)) return '-';
return (value > 0 ? trace.delta.increasing.symbol : trace.delta.decreasing.symbol) + numberFmt(value);
return (value > 0 ? trace.delta.increasing.symbol : trace.delta.decreasing.symbol) + deltaPrefix + numberFmt(value) + deltaSuffix;
};
var deltaFill = function(d) {
return d.delta >= 0 ? trace.delta.increasing.color : trace.delta.decreasing.color;
Expand Down
4 changes: 0 additions & 4 deletions test/image/mocks/indicator_scatter.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
"type": "indicator",
"mode": "number+delta",
"delta": {"reference": 512, "valueformat": ".0f"},
"ticker": {
"showticker": true
},
"vmax": 500,
"value": 492
}, {
"name": "Users online",
Expand Down