Skip to content

High performance, self-hosted, newsletter and mailing list manager with a modern dashboard. Single binary app.

Fix campaign donut % and add legend for slices. Closes #3090.

Kailash Nadhc0bb919f30ef
diff --git a/cmd/campaign_analytics.go b/cmd/campaign_analytics.go
index c49b1da6..8b6c0dc9 100644
--- a/cmd/campaign_analytics.go
+++ b/cmd/campaign_analytics.go
@@ -13,6 +13,7 @@ import (
type analyticsCampaign struct {
ID int `json:"id"`
Name string `json:"name"`
+ Sent int `json:"sent"`
}
// analyticsData is the chart data embedded into the analytics page for the Chart.js renderer.
@@ -59,7 +60,7 @@ func (a *App) ViewCampaignAnalytics(c echo.Context) error {
continue
}
- campaigns = append(campaigns, analyticsCampaign{ID: camp.ID, Name: camp.Name})
+ campaigns = append(campaigns, analyticsCampaign{ID: camp.ID, Name: camp.Name, Sent: camp.Sent})
}
}
diff --git a/static/admin/assets/js/views/analytics.js b/static/admin/assets/js/views/analytics.js
index 8d94383e..c76482e8 100644
--- a/static/admin/assets/js/views/analytics.js
+++ b/static/admin/assets/js/views/analytics.js
@@ -35,10 +35,7 @@ const DEFAULT_DONUT = {
callbacks: {
label: (item) => {
const data = item.chart.data.datasets[item.datasetIndex];
- const total = data.data.reduce((acc, val) => acc + val, 0);
- const val = data.data[item.dataIndex];
- const percentage = ((val / total) * 100).toFixed(2);
- return `${val} (${percentage}%)`;
+ return formatCount(data.data[item.dataIndex], data.sent[item.dataIndex]);
},
},
},
@@ -64,6 +61,12 @@ const DEFAULT_LINE = {
bodyFont: { size: 15 },
bodySpacing: 10,
padding: 10,
+ callbacks: {
+ labelColor: (item) => ({
+ backgroundColor: item.dataset.borderColor,
+ borderColor: 'transparent',
+ }),
+ },
},
},
scales: {
@@ -167,14 +170,18 @@ function draw(id, def, data, extraOptions) {
return;
}
- // eslint-disable-next-line no-new
- new Chart(canvas, {
+ return new Chart(canvas, {
type: def.type,
data,
options: { ...def.options, ...(extraOptions || {}) },
});
}
+// Use the campaign's sent count instead of the chart total.
+function formatCount(count, sent) {
+ return sent > 0 ? `${count} (${((count / sent) * 100).toFixed(2)}%)` : `${count}`;
+}
+
// Render a line chart (time series per campaign) and its donut (totals per campaign).
function renderCounts(key, camps, rows) {
const datasets = camps.map((c, n) => ({
@@ -182,6 +189,7 @@ function renderCounts(key, camps, rows) {
data: rows.filter((item) => item.campaign_id === c.id)
.map((item) => ({ x: toLabel(item.timestamp), y: item.count })),
borderColor: chartColors[n % chartColors.length],
+ backgroundColor: chartColors[n % chartColors.length],
borderWidth: 2,
pointHoverBorderWidth: 5,
pointBorderWidth: 0.5,
@@ -194,10 +202,32 @@ function renderCounts(key, camps, rows) {
});
draw(`chart-${key}`, DEFAULT_LINE, { datasets });
- draw(`chart-${key}-donut`, DEFAULT_DONUT, {
+ const donut = draw(`chart-${key}-donut`, DEFAULT_DONUT, {
labels,
- datasets: [{ data: totals, backgroundColor: chartColors, borderWidth: 6 }],
+ datasets: [{
+ data: totals,
+ sent: camps.map((c) => c.sent),
+ backgroundColor: chartColors,
+ borderWidth: 6,
+ }],
});
+
+ const legend = document.getElementById(`chart-${key}-legend`);
+ if (legend) {
+ legend.querySelectorAll('[data-index]').forEach((item) => {
+ const n = Number(item.dataset.index);
+ item.querySelector('[data-marker]').style.color = datasets[n].borderColor;
+ item.querySelector('[data-count]').textContent = formatCount(totals[n], camps[n].sent);
+
+ const highlight = () => {
+ donut.setActiveElements(item.matches(':hover, :focus-within') ? [{ datasetIndex: 0, index: n }] : []);
+ donut.update('none');
+ };
+ ['mouseenter', 'mouseleave', 'focusin', 'focusout'].forEach((event) => {
+ item.addEventListener(event, highlight);
+ });
+ });
+ }
}
// Render the link-clicks bar chart.
diff --git a/static/admin/views/analytics.html b/static/admin/views/analytics.html
index 315ccad7..6c00d208 100644
--- a/static/admin/views/analytics.html
+++ b/static/admin/views/analytics.html
@@ -70,9 +70,9 @@
</form>
{{- if $d.HasData }}
- {{ template "analytics-chart" dict "Title" (.L.T "campaigns.views") "Count" $d.Counts.Views "Key" "views" }}
- {{ template "analytics-chart" dict "Title" (.L.T "campaigns.clicks") "Count" $d.Counts.Clicks "Key" "clicks" }}
- {{ template "analytics-chart" dict "Title" (.L.T "globals.terms.bounces") "Count" $d.Counts.Bounces "Key" "bounces" }}
+ {{ template "analytics-chart" dict "Title" (.L.T "campaigns.views") "Count" $d.Counts.Views "Key" "views" "Campaigns" $d.Campaigns }}
+ {{ template "analytics-chart" dict "Title" (.L.T "campaigns.clicks") "Count" $d.Counts.Clicks "Key" "clicks" "Campaigns" $d.Campaigns }}
+ {{ template "analytics-chart" dict "Title" (.L.T "globals.terms.bounces") "Count" $d.Counts.Bounces "Key" "bounces" "Campaigns" $d.Campaigns }}
<article class="card float">
<h4 class="title">{{ .L.T "analytics.links" }}</h4>
@@ -100,6 +100,14 @@
<div class="col-9"><div class="chart-box"><canvas id="chart-{{ $key }}"></canvas></div></div>
<div class="col-3 donut-container"><canvas id="chart-{{ $key }}-donut"></canvas></div>
</div>
+ <div id="chart-{{ $key }}-legend" class="hstack text-8 mt-2">
+ {{- range $n, $c := .Campaigns }}
+ <span data-index="{{ $n }}">
+ <span data-marker aria-hidden="true">●</span>
+ <a href="{{ URI "/admin/campaigns" }}/{{ .ID }}" class="unstyled">#{{ .ID }}: {{ .Name }}</a>: <span data-count></span>
+ </span>
+ {{- end }}
+ </div>
{{- else }}
{{- template "empty-state" }}
{{- end }}