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

Jump to bottom

Legend boxes support borderRadius #8875

Merged
merged 1 commit into from Apr 10, 2021
Merged

Legend boxes support borderRadius #8875

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/configuration/legend.md
View file
Open in desktop
Expand Up @@ -84,6 +84,10 @@ Items passed to the legend `onClick` function are the ones returned from `labels
// Label that will be displayed
text: string,

// Border radius of the legend item.
// Introduced in 3.1.0
borderRadius?: number | BorderRadius,

// Index of the associated dataset
datasetIndex: number,

Expand Down
24 changes: 21 additions & 3 deletions src/plugins/plugin.legend.js
View file
Open in desktop
@@ -1,13 +1,14 @@
import defaults from '../core/core.defaults';
import Element from '../core/core.element';
import layouts from '../core/core.layouts';
import {drawPoint, renderText} from '../helpers/helpers.canvas';
import {addRoundedRectPath, drawPoint, renderText} from '../helpers/helpers.canvas';
import {
callback as call, valueOrDefault, toFont,
toPadding, getRtlAdapter, overrideTextDirection, restoreTextDirection,
clipArea, unclipArea
} from '../helpers/index';
import {_toLeftRightCenter, _alignStartEnd, _textX} from '../helpers/helpers.extras';
import {toTRBLCorners} from '../helpers/helpers.options';
/**
* @typedef { import("../platform/platform.base").ChartEvent } ChartEvent
*/
Expand Down Expand Up @@ -341,10 +342,26 @@ export class Legend extends Element {
// Draw box as legend symbol
// Adjust position when boxHeight < fontSize (want it centered)
const yBoxTop = y + Math.max((fontSize - boxHeight) / 2, 0);
const xBoxLeft = rtlHelper.leftForLtr(x, boxWidth);
const borderRadius = toTRBLCorners(legendItem.borderRadius);

ctx.beginPath();

if (Object.values(borderRadius).some(v => v !== 0)) {
addRoundedRectPath(ctx, {
x: xBoxLeft,
y: yBoxTop,
w: boxWidth,
h: boxHeight,
radius: borderRadius,
});
} else {
ctx.rect(xBoxLeft, yBoxTop, boxWidth, boxHeight);
}

ctx.fillRect(rtlHelper.leftForLtr(x, boxWidth), yBoxTop, boxWidth, boxHeight);
ctx.fill();
if (lineWidth !== 0) {
ctx.strokeRect(rtlHelper.leftForLtr(x, boxWidth), yBoxTop, boxWidth, boxHeight);
ctx.stroke();
}
}

Expand Down Expand Up @@ -653,6 +670,7 @@ export default {
pointStyle: pointStyle || style.pointStyle,
rotation: style.rotation,
textAlign: textAlign || style.textAlign,
borderRadius: 0, // TODO: v4, default to style.borderRadius

// Below is extra data used for toggling the datasets
datasetIndex: meta.index
Expand Down
55 changes: 55 additions & 0 deletions test/fixtures/plugin.legend/borderRadius/legend-border-radius.js
View file
Open in desktop
@@ -0,0 +1,55 @@
module.exports = {
config: {
type: 'line',
data: {
labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],
datasets: [
{
label: '# of Votes',
data: [12, 19, 3, 5, 2, 3],
borderWidth: 1,
borderColor: '#FF0000',
backgroundColor: '#00FF00',
},
{
label: '# of Points',
data: [7, 11, 5, 8, 3, 7],
borderWidth: 2,
borderColor: '#FF00FF',
backgroundColor: '#0000FF',
}
]
},
options: {
scales: {
x: {display: false},
y: {display: false}
},
plugins: {
title: false,
tooltip: false,
filler: false,
legend: {
labels: {
generateLabels: (chart) => {
const items = Chart.defaults.plugins.legend.labels.generateLabels(chart);

for (const item of items) {
item.borderRadius = 5;
}

return items;
}
}
}
}
}
},
options: {
spriteText: true,
canvas: {
width: 512,
height: 256
}
}
};
Binary file added test/fixtures/plugin.legend/borderRadius/legend-border-radius.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions test/specs/plugin.legend.tests.js
View file
Open in desktop
Expand Up @@ -61,6 +61,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand All @@ -76,6 +77,7 @@ describe('Legend block tests', function() {
datasetIndex: 0
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: true,
Expand All @@ -91,6 +93,7 @@ describe('Legend block tests', function() {
datasetIndex: 1
}, {
text: 'dataset3',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -137,6 +140,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand All @@ -152,6 +156,7 @@ describe('Legend block tests', function() {
datasetIndex: 0
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: true,
Expand All @@ -167,6 +172,7 @@ describe('Legend block tests', function() {
datasetIndex: 1
}, {
text: 'dataset3',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -220,6 +226,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset3',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand All @@ -235,6 +242,7 @@ describe('Legend block tests', function() {
datasetIndex: 2
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: true,
Expand All @@ -250,6 +258,7 @@ describe('Legend block tests', function() {
datasetIndex: 1
}, {
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -308,6 +317,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand All @@ -323,6 +333,7 @@ describe('Legend block tests', function() {
datasetIndex: 0
}, {
text: 'dataset3',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -380,6 +391,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset3',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand All @@ -395,6 +407,7 @@ describe('Legend block tests', function() {
datasetIndex: 2
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: true,
Expand All @@ -410,6 +423,7 @@ describe('Legend block tests', function() {
datasetIndex: 1
}, {
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -542,6 +556,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -585,6 +600,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: 'rgb(50, 0, 0)',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -643,6 +659,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand All @@ -658,6 +675,7 @@ describe('Legend block tests', function() {
datasetIndex: 0
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand Down Expand Up @@ -717,6 +735,7 @@ describe('Legend block tests', function() {

expect(chart.legend.legendItems).toEqual([{
text: 'dataset1',
borderRadius: 0,
fillStyle: 'rgba(0,0,0,0.1)',
fontColor: '#666',
hidden: false,
Expand All @@ -732,6 +751,7 @@ describe('Legend block tests', function() {
datasetIndex: 0
}, {
text: 'dataset2',
borderRadius: 0,
fillStyle: '#f31',
fontColor: '#666',
hidden: false,
Expand Down
6 changes: 6 additions & 0 deletions types/index.esm.d.ts
View file
Open in desktop
Expand Up @@ -2009,6 +2009,12 @@ export interface LegendItem {
*/
text: string;

/**
* Border radius of the legend box
* @since 3.1.0
*/
borderRadius?: number | BorderRadius;

/**
* Index of the associated dataset
*/
Expand Down