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

Update documentation for generateLegend method; fix corresponding unit tests #2

Merged
merged 1 commit into from
Apr 1, 2019
Merged

Update documentation for generateLegend method; fix corresponding unit tests #2

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
4 changes: 2 additions & 2 deletions docs/configuration/legend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Now when you click the legend in this chart, the visibility of the first two dat

## HTML Legends

Sometimes you need a very complex legend. In these cases, it makes sense to generate an HTML legend. Charts provide a `generateLegend()` method on their prototype that returns an HTML string for the legend.
Sometimes you need a very complex legend. In these cases, it makes sense to generate an HTML legend. Charts provide a `generateLegend()` method on their prototype that returns an HTML fragment for the legend.

To configure how this legend is generated, you can change the `legendCallback` config property.

Expand All @@ -171,7 +171,7 @@ var chart = new Chart(ctx, {
data: data,
options: {
legendCallback: function(chart) {
// Return the HTML string here.
// Return the HTML fragment here.
}
}
});
Expand Down
5 changes: 4 additions & 1 deletion src/controllers/controller.doughnut.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ defaults._set('doughnut', {
mode: 'single'
},
legendCallback: function(chart) {
var fragment = document.createDocumentFragment();
var list = document.createElement('ul');
list.setAttribute('class', chart.id + '-legend');

Expand All @@ -35,9 +36,11 @@ defaults._set('doughnut', {
listItem.appendChild(document.createTextNode(labels[i]));
}
}

fragment.appendChild(list);
}

return list;
return fragment;
},
legend: {
labels: {
Expand Down
7 changes: 5 additions & 2 deletions src/controllers/controller.polarArea.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ defaults._set('polarArea', {
},

startAngle: -0.5 * Math.PI,
legendCallback: function(chart) {
legendCallback: function (chart) {
var fragment = document.createDocumentFragment();
var list = document.createElement('ul');
list.setAttribute('class', chart.id + '-legend');

Expand All @@ -48,9 +49,11 @@ defaults._set('polarArea', {
listItem.appendChild(document.createTextNode(labels[i]));
}
}

fragment.appendChild(list);
}

return list;
return fragment;
},
legend: {
labels: {
Expand Down
21 changes: 14 additions & 7 deletions src/plugins/plugin.legend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,24 @@ defaults._set('global', {
},

legendCallback: function(chart) {
var fragment = document.createDocumentFragment();
var list = document.createElement('ul');
list.setAttribute('class', chart.id + '-legend');
for (var i = 0; i < chart.data.datasets.length; i++) {
var listItem = list.appendChild(document.createElement('li'));
var listItemSpan = listItem.appendChild(document.createElement('span'));
listItemSpan.style.backgroundColor = chart.data.datasets[i].backgroundColor;
if (chart.data.datasets[i].label) {
listItem.appendChild(document.createTextNode(chart.data.datasets[i].label));

if (datasets.length) {
for (var i = 0; i < chart.data.datasets.length; i++) {
var listItem = list.appendChild(document.createElement('li'));
var listItemSpan = listItem.appendChild(document.createElement('span'));
listItemSpan.style.backgroundColor = chart.data.datasets[i].backgroundColor;
if (chart.data.datasets[i].label) {
listItem.appendChild(document.createTextNode(chart.data.datasets[i].label));
}
}

fragment.appendChild(list);
}
return list;

return fragment;
}
});

Expand Down
16 changes: 12 additions & 4 deletions test/specs/global.defaults.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,12 @@ describe('Default Configs', function() {
options: config
});

var expectedLegend = '<ul class="' + chart.id + '-legend"><li><span style="background-color:red"></span>label1</li><li><span style="background-color:green"></span>label2</li></ul>';
expect(chart.generateLegend()).toBe(expectedLegend);
var expectedLegend = document.createDocumentFragment();
var expectedLegendList = document.createElement('ul');
expectedLegendList.setAttribute('class', chart.id + '-legend');
expectedLegendList.innerHTML = '<li><span style="background-color: red;"></span>label1</li><li><span style="background-color: green;"></span>label2</li>';
expectedLegend.appendChild(expectedLegendList);
expect(chart.generateLegend().firstElementChild.outerHTML).toBe(expectedLegend.firstElementChild.outerHTML);
});

it('should return correct legend label objects', function() {
Expand Down Expand Up @@ -218,8 +222,12 @@ describe('Default Configs', function() {
options: config
});

var expectedLegend = '<ul class="' + chart.id + '-legend"><li><span style="background-color:red"></span>label1</li><li><span style="background-color:green"></span>label2</li></ul>';
expect(chart.generateLegend()).toBe(expectedLegend);
var expectedLegend = document.createDocumentFragment();
var expectedLegendList = document.createElement('ul');
expectedLegendList.setAttribute('class', chart.id + '-legend');
expectedLegendList.innerHTML = '<li><span style="background-color: red;"></span>label1</li><li><span style="background-color: green;"></span>label2</li>';
expectedLegend.appendChild(expectedLegendList);
expect(chart.generateLegend().firstElementChild.outerHTML).toBe(expectedLegend.firstElementChild.outerHTML);
});

it('should return correct legend label objects', function() {
Expand Down