Skip to content
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.

Sign up for GitHub

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

feat(gauge): Enhance display multiline labels #516

Merged
merged 1 commit into from
Jul 30, 2018
Merged

feat(gauge): Enhance display multiline labels #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions spec/internals/arc-spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ describe("ARC", () => {
});


it("should show custom min/max gauge labels", () => {
it("should show custom gauge labels", () => {
const chart = util.generate({
gauge: {
width: 10,
Expand All @@ -245,6 +245,9 @@ describe("ARC", () => {
}

return `Min: ${value}%`;
},
format: function(value) {
return value +"%\nTest\nValue";
}
}
},
Expand All @@ -256,12 +259,15 @@ describe("ARC", () => {
}
});

const chartArc = chart.internal.main.select(`.${CLASS.chartArcs}`);
const chartArc = chart.$.arc;
const min = chartArc.select(`.${CLASS.chartArcsGaugeMin}`);
const max = chartArc.select(`.${CLASS.chartArcsGaugeMax}`);

expect(min.text()).to.equal("Min: 0%");
expect(max.text()).to.equal("Max: 100%");

// gauge text should be multilined
expect(chartArc.selectAll(`.${CLASS.target}-data tspan`).size()).to.be.equal(3);
});

it("should not show gauge labels", () => {
Expand Down
5 changes: 4 additions & 1 deletion src/config/Options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2500,7 +2500,7 @@ export default class Options {
* @type {Object}
* @property {Boolean} [gauge.fullCircle=false] Show full circle as donut. When set to 'true', the max label will not be showed due to start and end points are same location.
* @property {Boolean} [gauge.label.show=true] Show or hide label on gauge.
* @property {Function} [gauge.label.format] Set formatter for the label on gauge.
* @property {Function} [gauge.label.format] Set formatter for the label on gauge. Label text can be multilined with `\n` character.
* @property {Function} [gauge.label.extents] Set customized min/max label text.
* @property {Boolean} [gauge.expand=true] Enable or disable expanding gauge.
* @property {Number} [gauge.expand.duration=50] Set the expand transition time in milliseconds.
Expand All @@ -2516,6 +2516,9 @@ export default class Options {
* show: false,
* format: function(value, ratio) {
* return value;
*
* // to multiline, return with '\n' character
* // return value +"%\nLine1\n2Line2";
* },
* extents: function(value, isMax) {
* return (isMax ? "Max:" : "Min:") + value;
Expand Down
32 changes: 27 additions & 5 deletions src/shape/arc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,9 @@ extend(ChartInternal.prototype, {
});
},

textForArcLabel(d) {
textForArcLabel(val) {
const $$ = this;
const d = val.node ? val.datum() : val;

if (!$$.shouldShowArcLabel()) {
return "";
Expand All @@ -233,9 +234,27 @@ extend(ChartInternal.prototype, {
return "";
}

const format = $$.getArcLabelFormat();
const text = (
$$.getArcLabelFormat() || $$.defaultArcValueFormat
)(value, ratio, id).toString();

return format ? format(value, ratio, id) : $$.defaultArcValueFormat(value, ratio);
if (val.node) {
if (text.indexOf("\n") === -1) {
val.text(text);
} else {
const multiline = text.split("\n");
const len = multiline.length - 1;

multiline.forEach((v, i) => {
val.append("tspan")
.attr("x", 0)
.attr("dy", `${i === 0 ? -len : 1}em`)
.text(v);
});
}
}

return text;
},

textForGaugeMinMax(value, isMax) {
Expand Down Expand Up @@ -654,8 +673,11 @@ extend(ChartInternal.prototype, {

config.gauge_fullCircle && gaugeTextValue.attr("dy", `${Math.round($$.radius / 14)}`);

gaugeTextValue
.text($$.textForArcLabel.bind($$))
// to handle multiline text for gauge type
const textMethod = !gaugeTextValue.empty() &&
gaugeTextValue.classed(CLASS.gaugeValue) ? "call" : "text";

gaugeTextValue[textMethod]($$.textForArcLabel.bind($$))
.attr("transform", $$.transformForArcLabel.bind($$))
.style("font-size", d => ($$.isGaugeType(d.data) ? `${Math.round($$.radius / 5)}px` : ""))
.transition()
Expand Down