Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

[#66624] Fix contrast in widget graphs (#20193)

Alexander Brandon Coles8845cc23722b
diff --git a/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.component.ts b/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.component.ts
index b54f03fbc3a..ec2245117a9 100644
--- a/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.component.ts
+++ b/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.component.ts
@@ -1,9 +1,12 @@
-import { Component, Input, SimpleChanges } from '@angular/core';
+import { Component, Input, SimpleChanges, OnChanges } from '@angular/core';
import { WorkPackageTableConfiguration } from 'core-app/features/work-packages/components/wp-table/wp-table-configuration';
-import { ChartOptions, Plugin } from 'chart.js';
+import { ChartOptions } from 'chart.js';
import { I18nService } from 'core-app/core/i18n/i18n.service';
import { GroupObject } from 'core-app/features/hal/resources/wp-collection-resource';
-import DataLabelsPlugin from 'chartjs-plugin-datalabels';
+import { CommonModule } from '@angular/common';
+import { BaseChartDirective, provideCharts, withDefaultRegisterables } from 'ng2-charts';
+import ChartDataLabels from 'chartjs-plugin-datalabels';
+import PrimerColorsPlugin from './../plugin.primer-colors';
export interface WorkPackageEmbeddedGraphDataset {
label:string;
@@ -20,9 +23,16 @@ interface ChartDataSet {
selector: 'op-wp-embedded-graph',
templateUrl: './wp-embedded-graph.html',
styleUrls: ['./wp-embedded-graph.component.sass'],
- standalone: false,
+ standalone: true,
+ imports: [
+ CommonModule,
+ BaseChartDirective
+ ],
+ providers: [
+ provideCharts(withDefaultRegisterables(ChartDataLabels, PrimerColorsPlugin)),
+ ]
})
-export class WorkPackageEmbeddedGraphComponent {
+export class WorkPackageEmbeddedGraphComponent implements OnChanges {
@Input() public datasets:WorkPackageEmbeddedGraphDataset[];
@Input() public chartOptions:ChartOptions;
@@ -39,8 +49,6 @@ export class WorkPackageEmbeddedGraphComponent {
public chartData:ChartDataSet[] = [];
- public chartPlugins:Plugin[] = [DataLabelsPlugin];
-
public internalChartOptions:ChartOptions;
public initialized = false;
@@ -71,10 +79,10 @@ export class WorkPackageEmbeddedGraphComponent {
}, [])) as string[];
const labelCountMaps = this.datasets.map((dataset) => {
- const countMap = (dataset.groups || []).reduce((hash, group) => ({
+ const countMap = (dataset.groups || []).reduce<any>((hash, group) => ({
...hash,
[group.value]: group.count,
- }), {} as any);
+ }), {});
return {
label: dataset.label,
@@ -198,11 +206,11 @@ export class WorkPackageEmbeddedGraphComponent {
private setHeight() {
if (this.chartType === 'horizontalBar' && this.datasets && this.datasets[0]) {
const labels:string[] = [];
- this.datasets.forEach((d) => d.groups!.forEach((g) => {
+ this.datasets.forEach((d) => { d.groups!.forEach((g) => {
if (!labels.includes(g.value)) {
labels.push(g.value);
}
- }));
+ }); });
let height = labels.length * 40;
if (this.datasets.length > 1) {
diff --git a/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.html b/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.html
index 333eeec0197..2841a07858b 100644
--- a/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.html
+++ b/frontend/src/app/shared/components/work-package-graphs/embedded/wp-embedded-graph.html
@@ -3,7 +3,6 @@
<canvas baseChart
[datasets]="chartData"
[labels]="chartLabels"
- [plugins]="chartPlugins"
[type]="mappedChartType"
[options]="internalChartOptions"
>
diff --git a/frontend/src/app/shared/components/work-package-graphs/openproject-work-package-graphs.module.ts b/frontend/src/app/shared/components/work-package-graphs/openproject-work-package-graphs.module.ts
index 1492d4f5b67..1c8b086f18a 100644
--- a/frontend/src/app/shared/components/work-package-graphs/openproject-work-package-graphs.module.ts
+++ b/frontend/src/app/shared/components/work-package-graphs/openproject-work-package-graphs.module.ts
@@ -38,8 +38,6 @@ import { WpGraphConfigurationSettingsTabInnerComponent } from 'core-app/shared/c
import { WorkPackageEmbeddedGraphComponent } from 'core-app/shared/components/work-package-graphs/embedded/wp-embedded-graph.component';
import { WorkPackageOverviewGraphComponent } from 'core-app/shared/components/work-package-graphs/overview/wp-overview-graph.component';
import { OpenprojectTabsModule } from 'core-app/shared/components/tabs/openproject-tabs.module';
-import { BaseChartDirective, provideCharts, withDefaultRegisterables } from 'ng2-charts';
-import ChartDataLabels from 'chartjs-plugin-datalabels';
@NgModule({
imports: [
@@ -49,8 +47,10 @@ import ChartDataLabels from 'chartjs-plugin-datalabels';
OpenprojectWorkPackagesModule,
- BaseChartDirective,
OpenprojectTabsModule,
+
+ // Embedded graphs
+ WorkPackageEmbeddedGraphComponent,
],
declarations: [
// Modals
@@ -60,11 +60,8 @@ import ChartDataLabels from 'chartjs-plugin-datalabels';
WpGraphConfigurationSettingsTabComponent,
WpGraphConfigurationSettingsTabInnerComponent,
- // Embedded graphs
- WorkPackageEmbeddedGraphComponent,
// Work package graphs on version page
WorkPackageOverviewGraphComponent,
-
],
exports: [
// Modals
@@ -73,9 +70,6 @@ import ChartDataLabels from 'chartjs-plugin-datalabels';
// Embedded graphs
WorkPackageEmbeddedGraphComponent,
WorkPackageOverviewGraphComponent,
- ],
- providers: [
- provideCharts(withDefaultRegisterables(ChartDataLabels)),
- ],
+ ]
})
export class OpenprojectWorkPackageGraphsModule {} // eslint-disable-line @typescript-eslint/no-extraneous-class
diff --git a/frontend/src/app/shared/components/work-package-graphs/plugin.primer-colors.ts b/frontend/src/app/shared/components/work-package-graphs/plugin.primer-colors.ts
new file mode 100644
index 00000000000..be7c4c617af
--- /dev/null
+++ b/frontend/src/app/shared/components/work-package-graphs/plugin.primer-colors.ts
@@ -0,0 +1,141 @@
+//-- copyright
+// OpenProject is an open source project management software.
+// Copyright (C) the OpenProject GmbH
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License version 3.
+//
+// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+// Copyright (C) 2006-2013 Jean-Philippe Lang
+// Copyright (C) 2010-2013 the ChiliProject Team
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either version 2
+// of the License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+//
+// See COPYRIGHT and LICENSE files for more details.
+//++
+
+// Based on https://github.com/chartjs/Chart.js/blob/master/src/plugins/plugin.colors.ts
+
+import {
+ BarController,
+ Chart,
+ ChartDataset,
+ ChartType,
+ DoughnutController,
+ Plugin,
+ PolarAreaController
+} from 'chart.js';
+
+export interface PrimerColorsPluginOptions {
+ enabled?:boolean;
+}
+
+const PRIMER_COLORS = [
+ 'teal', // (fresh contrast)
+ 'orange', // (bold, warm → most eye-catching → first)
+ 'green', // (contrasts strongly with orange)
+ 'purple', // (cool, distinct)
+ 'red', // (strong, but not first to avoid clash with orange)
+ 'yellow', // (bright highlight, works better later)
+ 'blue', // (strong primary)
+ 'pink', // (vivid, contrasts with blue)
+ 'pine', // (deep green, darker balance)
+ 'auburn', // (earthy tone)
+ 'brown', // (neutral balance)
+ 'cyan', // (slight highlight between neutral colours)
+ 'gray', // (neutral, mid-series filler)
+ 'lemon', // (darker yellow, less eye-catching)
+ 'olive', // (subdued green, background tone)
+ 'lime', // (subdued green, good closing color)
+];
+
+function getCSSVariable(variable:string) {
+ return getComputedStyle(document.body).getPropertyValue(variable).trim();
+}
+
+const EMPHASIS_COLORS = PRIMER_COLORS
+ .map((color) => getCSSVariable(`--display-${color}-scale-4`));
+
+const MUTED_COLORS = PRIMER_COLORS
+ .map((color) => getCSSVariable(`--display-${color}-scale-1`));
+
+function getEmphasisColor(i:number) {
+ return EMPHASIS_COLORS[i % EMPHASIS_COLORS.length];
+}
+
+function getMutedColor(i:number) {
+ return MUTED_COLORS[i % MUTED_COLORS.length];
+}
+
+function colorizeDefaultDataset(dataset:ChartDataset, i:number) {
+ dataset.borderColor = getEmphasisColor(i);
+ dataset.backgroundColor = getMutedColor(i);
+
+ return ++i;
+}
+
+function colorizeBarDataset(dataset:ChartDataset, i:number) {
+ dataset.backgroundColor = dataset.data.map(() => getEmphasisColor(i++));
+
+ return i;
+}
+
+function colorizeDoughnutDataset(dataset:ChartDataset, i:number) {
+ dataset.backgroundColor = dataset.data.map(() => getEmphasisColor(i++));
+
+ return i;
+}
+
+function colorizePolarAreaDataset(dataset:ChartDataset, i:number) {
+ dataset.backgroundColor = dataset.data.map(() => getMutedColor(i++));
+
+ return i;
+}
+
+function getColorizer(chart:Chart) {
+ let i = 0;
+
+ return (dataset:ChartDataset, datasetIndex:number) => {
+ const controller = chart.getDatasetMeta(datasetIndex).controller;
+
+ if (controller instanceof DoughnutController) {
+ i = colorizeDoughnutDataset(dataset, i);
+ } else if (controller instanceof PolarAreaController) {
+ i = colorizePolarAreaDataset(dataset, i);
+ } else if (controller instanceof BarController) {
+ i = colorizeBarDataset(dataset, i);
+ } else {
+ i = colorizeDefaultDataset(dataset, i);
+ }
+ };
+}
+
+const plugin:Plugin<ChartType, PrimerColorsPluginOptions> = {
+ id: 'primer-colors',
+ defaults: { enabled: true },
+
+ beforeLayout(chart, _args, options) {
+ if (!options.enabled) {
+ return;
+ }
+
+ const { data: { datasets } } = chart.config;
+ const colorizer = getColorizer(chart);
+
+ datasets.forEach(colorizer);
+ },
+};
+
+export default plugin;