You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/05/05 15:38:28 UTC
(superset) branch master updated: fix(colors): reassign colliding series when dashboard locks shared dimension color (#39297)
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 9e91ae8cfff fix(colors): reassign colliding series when dashboard locks shared dimension color (#39297)
9e91ae8cfff is described below
commit 9e91ae8cfff733d3a620bd9ccbf33831da44f00a
Author: jesperct <jm...@gmail.com>
AuthorDate: Tue May 5 12:38:19 2026 -0300
fix(colors): reassign colliding series when dashboard locks shared dimension color (#39297)
Co-authored-by: codeant-ai-for-open-source[bot] <24...@users.noreply.github.com>
---
.../src/color/CategoricalColorScale.ts | 47 +++++-
.../test/color/CategoricalColorScale.test.ts | 179 +++++++++++++++++++++
2 files changed, 224 insertions(+), 2 deletions(-)
diff --git a/superset-frontend/packages/superset-ui-core/src/color/CategoricalColorScale.ts b/superset-frontend/packages/superset-ui-core/src/color/CategoricalColorScale.ts
index d5128f03986..b3f28f54d41 100644
--- a/superset-frontend/packages/superset-ui-core/src/color/CategoricalColorScale.ts
+++ b/superset-frontend/packages/superset-ui-core/src/color/CategoricalColorScale.ts
@@ -94,11 +94,20 @@ class CategoricalColorScale extends ExtensibleFunction {
/**
* Increment the color range with analogous colors
+ *
+ * @param forceMinimumExpansion When true, expand at least once even if the
+ * ordinal domain is still shorter than the palette. Shared dashboard labels
+ * can resolve from the global map without entering the scale domain, so
+ * domain-based sizing alone would skip expansion while collision resolution
+ * still needs analogous colors.
*/
- incrementColorRange() {
- const multiple = Math.floor(
+ incrementColorRange(forceMinimumExpansion = false) {
+ const domainBasedMultiple = Math.floor(
this.domain().length / this.originColors.length,
);
+ const multiple = forceMinimumExpansion
+ ? Math.max(domainBasedMultiple, 1)
+ : domainBasedMultiple;
// the domain has grown larger than the original range
// increments the range with analogous colors
if (multiple > this.multiple) {
@@ -144,6 +153,7 @@ class CategoricalColorScale extends ExtensibleFunction {
if (isFeatureEnabled(FeatureFlag.UseAnalogousColors)) {
this.incrementColorRange();
}
+
if (
// feature flag to be deprecated (will become standard behaviour)
isFeatureEnabled(FeatureFlag.AvoidColorsCollision) &&
@@ -154,6 +164,39 @@ class CategoricalColorScale extends ExtensibleFunction {
}
}
+ if (
+ isFeatureEnabled(FeatureFlag.AvoidColorsCollision) &&
+ source === LabelsColorMapSource.Dashboard &&
+ (forcedColor || isExistingLabel)
+ ) {
+ const colliding = [...this.chartLabelsColorMap.entries()].filter(
+ ([labelKey, c]) => c === color && labelKey !== cleanedValue,
+ );
+ if (
+ colliding.length > 0 &&
+ isFeatureEnabled(FeatureFlag.UseAnalogousColors)
+ ) {
+ this.incrementColorRange(true);
+ }
+ for (const [otherLabel] of colliding) {
+ if (
+ Object.prototype.hasOwnProperty.call(this.forcedColors, otherLabel)
+ ) {
+ continue;
+ }
+ const newColor = this.getNextAvailableColor(otherLabel, color);
+ this.chartLabelsColorMap.set(otherLabel, newColor);
+ if (sliceId) {
+ this.labelsColorMapInstance.addSlice(
+ otherLabel,
+ newColor,
+ sliceId,
+ appliedColorScheme,
+ );
+ }
+ }
+ }
+
// keep track of values in this slice
this.chartLabelsColorMap.set(cleanedValue, color);
diff --git a/superset-frontend/packages/superset-ui-core/test/color/CategoricalColorScale.test.ts b/superset-frontend/packages/superset-ui-core/test/color/CategoricalColorScale.test.ts
index 28dfb93abe3..9b7ba990445 100644
--- a/superset-frontend/packages/superset-ui-core/test/color/CategoricalColorScale.test.ts
+++ b/superset-frontend/packages/superset-ui-core/test/color/CategoricalColorScale.test.ts
@@ -21,6 +21,7 @@ import { ScaleOrdinal } from 'd3-scale';
import {
CategoricalColorScale,
FeatureFlag,
+ getLabelsColorMap,
LabelsColorMapSource,
} from '@superset-ui/core';
@@ -199,10 +200,42 @@ describe('CategoricalColorScale', () => {
const returnedColor = scale.getColor(value, sliceId);
expect(returnedColor).toBe(expectedColor);
});
+ test('reassigns colliding colors when no sliceId is provided', () => {
+ window.featureFlags = {
+ [FeatureFlag.AvoidColorsCollision]: true,
+ };
+ const PALETTE = ['red', 'blue', 'green'];
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ const labelsColorMap = chartAScale.labelsColorMapInstance;
+ labelsColorMap.reset();
+ labelsColorMap.source = LabelsColorMapSource.Dashboard;
+
+ try {
+ chartAScale.getColor('Trains', 101, 'testScheme');
+
+ const chartBScale = new CategoricalColorScale(PALETTE);
+ // Call getColor without sliceId (or with undefined)
+ chartBScale.getColor('Classic Cars', undefined, 'testScheme');
+ chartBScale.getColor('Trains', undefined, 'testScheme');
+
+ const classicCarsColor =
+ chartBScale.chartLabelsColorMap.get('Classic Cars');
+ const trainsColor = chartBScale.chartLabelsColorMap.get('Trains');
+
+ expect(trainsColor).toBe('red');
+ expect(classicCarsColor).toBeDefined();
+ expect(classicCarsColor).not.toBe('red');
+ } finally {
+ labelsColorMap.reset();
+ labelsColorMap.source = LabelsColorMapSource.Dashboard;
+ }
+ });
test('conditionally calls getNextAvailableColor', () => {
window.featureFlags = {
[FeatureFlag.AvoidColorsCollision]: true,
};
+ scale.labelsColorMapInstance.source = LabelsColorMapSource.Explore;
scale.getColor('testValue1');
scale.getColor('testValue2');
@@ -225,6 +258,27 @@ describe('CategoricalColorScale', () => {
expect(getNextAvailableColorSpy).not.toHaveBeenCalled();
});
+ test('reassigns non-forced labels when a dashboard-synced label would duplicate their color', () => {
+ window.featureFlags = {
+ [FeatureFlag.AvoidColorsCollision]: true,
+ };
+
+ const dashScale = new CategoricalColorScale(['red', 'blue', 'green']);
+ const sliceId = 501;
+ const colorScheme = 'preset';
+
+ dashScale.labelsColorMapInstance.source = LabelsColorMapSource.Dashboard;
+ jest
+ .spyOn(dashScale.labelsColorMapInstance, 'getColorMap')
+ .mockReturnValue(new Map([['Trains', 'red']]));
+
+ dashScale.getColor('Classic Cars', sliceId, colorScheme);
+ dashScale.getColor('Trains', sliceId, colorScheme);
+
+ expect(dashScale.chartLabelsColorMap.get('Trains')).toBe('red');
+ expect(dashScale.chartLabelsColorMap.get('Classic Cars')).not.toBe('red');
+ expect(dashScale.chartLabelsColorMap.get('Classic Cars')).toBeDefined();
+ });
});
describe('.setColor(value, forcedColor)', () => {
@@ -479,6 +533,131 @@ describe('CategoricalColorScale', () => {
});
});
+ describe('dashboard shared-dimension color collision', () => {
+ let labelsColorMap: ReturnType<typeof getLabelsColorMap>;
+
+ beforeEach(() => {
+ window.featureFlags = {
+ [FeatureFlag.AvoidColorsCollision]: true,
+ };
+ const sentinel = new CategoricalColorScale(['red', 'blue', 'green']);
+ labelsColorMap = sentinel.labelsColorMapInstance;
+ labelsColorMap.reset();
+ labelsColorMap.source = LabelsColorMapSource.Dashboard;
+ });
+
+ afterEach(() => {
+ jest.restoreAllMocks();
+ labelsColorMap.reset();
+ });
+
+ test('reproduces the bug without the fix: Classic Cars and Trains would both be red', () => {
+ window.featureFlags = {
+ [FeatureFlag.AvoidColorsCollision]: false,
+ };
+
+ const PALETTE = ['red', 'blue', 'green'];
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ chartAScale.getColor('Trains', 101, 'testScheme');
+ expect(labelsColorMap.getColorMap().get('Trains')).toBe('red');
+
+ const chartBScale = new CategoricalColorScale(PALETTE);
+ chartBScale.getColor('Classic Cars', 102, 'testScheme');
+ chartBScale.getColor('Trains', 102, 'testScheme');
+
+ const classicCarsColor =
+ chartBScale.chartLabelsColorMap.get('Classic Cars');
+ const trainsColor = chartBScale.chartLabelsColorMap.get('Trains');
+
+ expect(trainsColor).toBe('red');
+ expect(classicCarsColor).toBe('red');
+ });
+
+ test('fix: Classic Cars is reassigned when Trains locks red from the dashboard', () => {
+ const PALETTE = ['red', 'blue', 'green'];
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ chartAScale.getColor('Trains', 101, 'testScheme');
+ expect(labelsColorMap.getColorMap().get('Trains')).toBe('red');
+
+ const chartBScale = new CategoricalColorScale(PALETTE);
+ chartBScale.getColor('Classic Cars', 102, 'testScheme');
+ chartBScale.getColor('Trains', 102, 'testScheme');
+
+ const classicCarsColor =
+ chartBScale.chartLabelsColorMap.get('Classic Cars');
+ const trainsColor = chartBScale.chartLabelsColorMap.get('Trains');
+
+ expect(trainsColor).toBe('red');
+ expect(classicCarsColor).toBeDefined();
+ expect(classicCarsColor).not.toBe('red');
+ });
+
+ test('fix: no series in Chart B share a color when palette has enough colors', () => {
+ const PALETTE = ['red', 'blue', 'green'];
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ chartAScale.getColor('Trains', 101, 'testScheme');
+
+ const chartBScale = new CategoricalColorScale(PALETTE);
+ chartBScale.getColor('Classic Cars', 102, 'testScheme');
+ chartBScale.getColor('Trains', 102, 'testScheme');
+
+ const colors = Array.from(chartBScale.chartLabelsColorMap.values());
+ const uniqueColors = new Set(colors);
+
+ expect(uniqueColors.size).toBe(colors.length);
+ });
+
+ test('fix: increments analogous color range for dashboard collisions when UseAnalogousColors is enabled', () => {
+ window.featureFlags = {
+ [FeatureFlag.AvoidColorsCollision]: true,
+ [FeatureFlag.UseAnalogousColors]: true,
+ };
+
+ const PALETTE = ['red', 'blue', 'green'];
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ chartAScale.getColor('Trains', 101, 'testScheme');
+
+ const chartBScale = new CategoricalColorScale(PALETTE);
+ const addSliceSpy = jest.spyOn(
+ chartBScale.labelsColorMapInstance,
+ 'addSlice',
+ );
+ chartBScale.getColor('Classic Cars', 102, 'testScheme');
+ chartBScale.getColor('Model T', 102, 'testScheme');
+ chartBScale.getColor('Trains', 102, 'testScheme');
+
+ expect(chartBScale.chartLabelsColorMap.get('Trains')).toBe('red');
+ expect(chartBScale.chartLabelsColorMap.get('Classic Cars')).toBeDefined();
+ expect(chartBScale.chartLabelsColorMap.get('Classic Cars')).not.toBe(
+ 'red',
+ );
+ expect(chartBScale.range()).toHaveLength(6);
+ expect(
+ addSliceSpy.mock.calls.some(
+ ([label, color]) => label === 'Classic Cars' && color !== 'red',
+ ),
+ ).toBe(true);
+ });
+
+ test('fix: forced colors (user-set in dashboard JSON) are never reassigned', () => {
+ const PALETTE = ['red', 'blue', 'green'];
+ const forcedColors = { 'Classic Cars': 'red' };
+
+ const chartAScale = new CategoricalColorScale(PALETTE);
+ chartAScale.getColor('Trains', 101, 'testScheme');
+
+ const chartBScale = new CategoricalColorScale(PALETTE, forcedColors);
+ chartBScale.getColor('Classic Cars', 102, 'testScheme');
+ chartBScale.getColor('Trains', 102, 'testScheme');
+
+ expect(chartBScale.chartLabelsColorMap.get('Classic Cars')).toBe('red');
+ });
+ });
+
describe("is compatible with D3's ScaleOrdinal", () => {
test('passes type check', () => {
const scale: ScaleOrdinal<{ toString(): string }, string> =