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

[IMP] custom color: handle all the chart colors #4967

Closed
wants to merge 1 commit into from
Closed

[IMP] custom color: handle all the chart colors #4967

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
75 changes: 32 additions & 43 deletions src/plugins/ui_core_views/custom_colors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ import {
rgbaToHSLA,
toHex,
} from "../../helpers";
import { GaugeChart, ScorecardChart } from "../../helpers/figures/charts";
import { Color, CoreViewCommand, Immutable, RGBA, TableElementStyle, UID } from "../../types";
import { Color, Command, Immutable, RGBA, TableElementStyle, UID } from "../../types";
import { UIPlugin, UIPluginConfig } from "../ui_plugin";

const chartColorRegex = /"(#[0-9a-fA-F]{6})"/g;

/**
* https://tomekdev.com/posts/sorting-colors-in-js
*/
Expand Down Expand Up @@ -76,16 +77,23 @@ export class CustomColorsPlugin extends UIPlugin<CustomColorState> {

constructor(config: UIPluginConfig) {
super(config);
for (const color of config.customColors ?? []) {
this.tryToAddColor(color);
}
this.tryToAddColors(config.customColors ?? []);
}

handle(cmd: CoreViewCommand) {
handle(cmd: Command) {
switch (cmd.type) {
case "UPDATE_CELL":
case "START":
for (const sheetId of this.getters.getSheetIds()) {
for (const chartId of this.getters.getChartIds(sheetId)) {
this.tryToAddColors(this.getChartColors(chartId));
hokolomopo marked this conversation as resolved.
Show resolved Hide resolved
}
}
break;
case "UPDATE_CHART":
case "CREATE_CHART":
this.tryToAddColors(this.getChartColors(cmd.id));
break;
case "UPDATE_CELL":
case "ADD_CONDITIONAL_FORMAT":
case "SET_BORDER":
case "SET_ZONE_BORDERS":
Expand All @@ -100,9 +108,7 @@ export class CustomColorsPlugin extends UIPlugin<CustomColorState> {
finalize() {
if (this.shouldUpdateColors) {
this.history.update("shouldUpdateColors", false);
for (const color of this.computeCustomColors()) {
this.tryToAddColor(color);
}
this.tryToAddColors(this.computeCustomColors());
}
}

Expand All @@ -116,7 +122,6 @@ export class CustomColorsPlugin extends UIPlugin<CustomColorState> {
usedColors = usedColors.concat(
this.getColorsFromCells(sheetId),
this.getFormattingColors(sheetId),
this.getChartColors(sheetId),
this.getTableColors(sheetId)
);
}
Expand Down Expand Up @@ -157,32 +162,14 @@ export class CustomColorsPlugin extends UIPlugin<CustomColorState> {
return formatColors.filter(isDefined);
}

private getChartColors(sheetId: UID): Color[] {
const charts = this.getters.getChartIds(sheetId).map((cid) => this.getters.getChart(cid));
let chartsColors = new Set<Color>();
for (let chart of charts) {
if (chart === undefined) {
continue;
}
const background = chart.getDefinition().background;
if (background !== undefined) {
chartsColors.add(background);
}
switch (chart.type) {
case "gauge":
const colors = (chart as GaugeChart).sectionRule.colors;
chartsColors.add(colors.lowerColor);
chartsColors.add(colors.middleColor);
chartsColors.add(colors.upperColor);
break;
case "scorecard":
const scoreChart = chart as ScorecardChart;
chartsColors.add(scoreChart.baselineColorDown);
chartsColors.add(scoreChart.baselineColorUp);
break;
}
private getChartColors(chartId: UID): Color[] {
const chart = this.getters.getChart(chartId);
if (chart === undefined) {
return [];
}
return [...chartsColors];
const stringifiedChart = JSON.stringify(chart.getDefinition());
const colors = stringifiedChart.matchAll(chartColorRegex);
return [...colors].map((color) => color[1]); // color[1] is the first capturing group of the regex
}

private getTableColors(sheetId: UID): Color[] {
Expand Down Expand Up @@ -220,13 +207,15 @@ export class CustomColorsPlugin extends UIPlugin<CustomColorState> {
].filter(isDefined);
}

private tryToAddColor(color: Color) {
if (!isColorValid(color)) {
return;
}
const formattedColor = toHex(color);
if (color && !COLOR_PICKER_DEFAULTS.includes(formattedColor)) {
this.history.update("customColors", formattedColor, true);
private tryToAddColors(colors: Color[]) {
for (const color of colors) {
if (!isColorValid(color)) {
continue;
}
const formattedColor = toHex(color);
if (color && !COLOR_PICKER_DEFAULTS.includes(formattedColor)) {
this.history.update("customColors", formattedColor, true);
}
}
}
}
22 changes: 21 additions & 1 deletion tests/colors/custom_colors_plugin.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,25 @@ describe("custom colors are correctly handled when editing charts", () => {
expect(model.getters.getCustomColors()).toEqual(["#112233", "#123456"]);
});

test("Chart data series colors are taken into account", () => {
expect(model.getters.getCustomColors()).toEqual([]);
createChart(
model,
{
type: "bar",
dataSets: [
{
dataRange: "A1:A10",
backgroundColor: "#112233",
trend: { type: "polynomial", order: 2, color: "#123456" },
},
],
},
"1"
);
expect(model.getters.getCustomColors()).toEqual(["#112233", "#123456"]);
});

test("duplicated colors on cell and chart only appears once", () => {
setStyle(model, "A1", { fillColor: "#123456" });
createChart(
Expand All @@ -190,8 +209,9 @@ describe("custom colors are correctly handled when editing charts", () => {

test("custom colors from model imported data", () => {
setStyle(model, "A1", { fillColor: "#123456" });
createChart(model, { type: "bar", background: "#654987" }, "1", sheetId);
const importedModel = new Model(model.exportData());
expect(importedModel.getters.getCustomColors()).toEqual(["#123456"]);
expect(importedModel.getters.getCustomColors()).toEqual(["#654987", "#123456"]);
});
});

Expand Down