From b229cbfd2e1c91182900b4ce2b362926770fad27 Mon Sep 17 00:00:00 2001 From: Manasvini B Suryanarayana Date: Wed, 21 Jun 2023 03:14:53 +0000 Subject: [PATCH] [Vis Colors] Update legacy seed colors to use ouiPaletteColorBlind() Signed-off-by: Manasvini B Suryanarayana --- CHANGELOG.md | 1 + .../public/services/colors/color_palette.ts | 6 +-- .../public/services/colors/colors.test.ts | 4 +- .../charts/public/services/colors/colors.ts | 4 +- .../services/colors/colors_palette.test.ts | 6 +-- .../services/colors/mapped_colors.test.ts | 16 +++---- .../services/colors/seed_colors.test.ts | 37 ---------------- .../public/services/colors/seed_colors.ts | 44 ------------------- 8 files changed, 19 insertions(+), 99 deletions(-) delete mode 100644 src/plugins/charts/public/services/colors/seed_colors.test.ts delete mode 100644 src/plugins/charts/public/services/colors/seed_colors.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 081b56f4f6c2..67f759c75bbe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,6 +55,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Remove unused Sass in `tile_map` plugin ([#4110](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4110)) - [Table Visualization] Remove custom styling for text-align:center in favor of OUI utility class. ([#4164](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4164)) - Replace the use of `bluebird` in `saved_objects` plugin ([#4026](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4026)) +- [Vis Colors] Update legacy seed colors to use `ouiPaletteColorBlind()` ([#4348](https://github.com/opensearch-project/OpenSearch-Dashboards/pull/4348)) ### 🔩 Tests diff --git a/src/plugins/charts/public/services/colors/color_palette.ts b/src/plugins/charts/public/services/colors/color_palette.ts index ac59a3c85f0d..f5f232f76a15 100644 --- a/src/plugins/charts/public/services/colors/color_palette.ts +++ b/src/plugins/charts/public/services/colors/color_palette.ts @@ -31,7 +31,7 @@ import _ from 'lodash'; import { hsl } from 'color'; -import { seedColors } from './seed_colors'; +import { euiPaletteColorBlind } from '@elastic/eui'; const offset = 300; // Hue offset to start at @@ -65,8 +65,8 @@ export function createColorPalette(num: number): string[] { throw new TypeError('ColorPaletteUtilService expects a number'); } - const colors = seedColors; - const seedLength = seedColors.length; + const colors = euiPaletteColorBlind(); + const seedLength = euiPaletteColorBlind().length; _.times(num - seedLength, function (i) { colors.push(hsl((fraction(i + seedLength + 1) * 360 + offset) % 360, 50, 50).hex()); diff --git a/src/plugins/charts/public/services/colors/colors.test.ts b/src/plugins/charts/public/services/colors/colors.test.ts index f25a1d7c476d..c189b9dc7bae 100644 --- a/src/plugins/charts/public/services/colors/colors.test.ts +++ b/src/plugins/charts/public/services/colors/colors.test.ts @@ -30,7 +30,7 @@ import { coreMock } from '../../../../../core/public/mocks'; import { COLOR_MAPPING_SETTING } from '../../../common'; -import { seedColors } from './seed_colors'; +import { euiPaletteColorBlind } from '@elastic/eui'; import { ColorsService } from './colors'; // Local state for config @@ -138,7 +138,7 @@ describe('Vislib Color Service', () => { }); it('should return the first hex color in the seed colors array', () => { - expect(color(arr[0])).toBe(seedColors[0]); + expect(color(arr[0])).toBe(euiPaletteColorBlind()[0]); }); it('should return the value from the mapped colors', () => { diff --git a/src/plugins/charts/public/services/colors/colors.ts b/src/plugins/charts/public/services/colors/colors.ts index 8f60e3bc29f1..1706f67acf97 100644 --- a/src/plugins/charts/public/services/colors/colors.ts +++ b/src/plugins/charts/public/services/colors/colors.ts @@ -32,8 +32,8 @@ import _ from 'lodash'; import { CoreSetup } from 'opensearch-dashboards/public'; +import { euiPaletteColorBlind } from '@elastic/eui'; import { MappedColors } from './mapped_colors'; -import { seedColors } from './seed_colors'; /** * Accepts an array of strings or numbers that are used to create a @@ -44,7 +44,7 @@ import { seedColors } from './seed_colors'; export class ColorsService { private _mappedColors?: MappedColors; - public readonly seedColors = seedColors; + public readonly seedColors = euiPaletteColorBlind(); public get mappedColors() { if (!this._mappedColors) { diff --git a/src/plugins/charts/public/services/colors/colors_palette.test.ts b/src/plugins/charts/public/services/colors/colors_palette.test.ts index ca9d2f2654e1..cfeff4a68d7c 100644 --- a/src/plugins/charts/public/services/colors/colors_palette.test.ts +++ b/src/plugins/charts/public/services/colors/colors_palette.test.ts @@ -28,7 +28,6 @@ * under the License. */ -import { seedColors } from './seed_colors'; import { createColorPalette } from './color_palette'; describe('Color Palette', () => { @@ -91,7 +90,8 @@ describe('Color Palette', () => { }); it('should return the seed color array when input length is 72', () => { - expect(createColorPalette(num2)[71]).toBe(seedColors[71]); + expect(createColorPalette(num2).length).toBe(72); + expect(createColorPalette(num2)[71]).toBe('#BFB540'); }); it('should return an array of the same length as the input when input is greater than 72', () => { @@ -99,7 +99,7 @@ describe('Color Palette', () => { }); it('should create new darker colors when input is greater than 72', () => { - expect(createColorPalette(num3)[72]).not.toEqual(seedColors[0]); + expect(createColorPalette(num3)[72]).not.toEqual('#54B399'); }); it('should create new colors and convert them correctly', () => { diff --git a/src/plugins/charts/public/services/colors/mapped_colors.test.ts b/src/plugins/charts/public/services/colors/mapped_colors.test.ts index 3db2db01dcbd..2753b37e56dc 100644 --- a/src/plugins/charts/public/services/colors/mapped_colors.test.ts +++ b/src/plugins/charts/public/services/colors/mapped_colors.test.ts @@ -33,7 +33,7 @@ import Color from 'color'; import { coreMock } from '../../../../../core/public/mocks'; import { COLOR_MAPPING_SETTING } from '../../../common'; -import { seedColors } from './seed_colors'; +import { euiPaletteColorBlind } from '@elastic/eui'; import { MappedColors } from './mapped_colors'; // Local state for config @@ -65,19 +65,19 @@ describe('Mapped Colors', () => { }); it('should not include colors used by the config', () => { - const newConfig = { bar: seedColors[0] }; + const newConfig = { bar: euiPaletteColorBlind()[9] }; config.set(COLOR_MAPPING_SETTING, newConfig); const arr = ['foo', 'baz', 'qux']; mappedColors.mapKeys(arr); const colorValues = _(mappedColors.mapping).values(); - expect(colorValues).not.toContain(seedColors[0]); + expect(colorValues).not.toContain(euiPaletteColorBlind()[9]); expect(colorValues.uniq().size()).toBe(arr.length); }); it('should create a unique array of colors even when config is set', () => { - const newConfig = { bar: seedColors[0] }; + const newConfig = { bar: euiPaletteColorBlind()[9] }; config.set(COLOR_MAPPING_SETTING, newConfig); const arr = ['foo', 'bar', 'baz', 'qux']; @@ -85,11 +85,11 @@ describe('Mapped Colors', () => { const expectedSize = _(arr).difference(_.keys(newConfig)).size(); expect(_(mappedColors.mapping).values().uniq().size()).toBe(expectedSize); - expect(mappedColors.get(arr[0])).not.toBe(seedColors[0]); + expect(mappedColors.get(arr[0])).not.toBe(euiPaletteColorBlind()[9]); }); it('should treat different formats of colors as equal', () => { - const color = new Color(seedColors[0]); + const color = new Color(euiPaletteColorBlind()[9]); const rgb = `rgb(${color.red()}, ${color.green()}, ${color.blue()})`; const newConfig = { bar: rgb }; config.set(COLOR_MAPPING_SETTING, newConfig); @@ -99,8 +99,8 @@ describe('Mapped Colors', () => { const expectedSize = _(arr).difference(_.keys(newConfig)).size(); expect(_(mappedColors.mapping).values().uniq().size()).toBe(expectedSize); - expect(mappedColors.get(arr[0])).not.toBe(seedColors[0]); - expect(mappedColors.get('bar')).toBe(seedColors[0]); + expect(mappedColors.get(arr[0])).not.toBe(euiPaletteColorBlind()[9]); + expect(mappedColors.get('bar')).toBe(euiPaletteColorBlind()[9].toLowerCase()); }); it('should have a flush method that moves the current map to the old map', function () { diff --git a/src/plugins/charts/public/services/colors/seed_colors.test.ts b/src/plugins/charts/public/services/colors/seed_colors.test.ts deleted file mode 100644 index ef13065554e4..000000000000 --- a/src/plugins/charts/public/services/colors/seed_colors.test.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * - * The OpenSearch Contributors require contributions made to - * this file be licensed under the Apache-2.0 license or a - * compatible open source license. - * - * Any modifications Copyright OpenSearch Contributors. See - * GitHub history for details. - */ - -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -import { seedColors } from './seed_colors'; - -describe('Seed Colors', function () { - it('should return an array', function () { - expect(seedColors).toBeInstanceOf(Array); - }); -}); diff --git a/src/plugins/charts/public/services/colors/seed_colors.ts b/src/plugins/charts/public/services/colors/seed_colors.ts deleted file mode 100644 index c7527f7768b1..000000000000 --- a/src/plugins/charts/public/services/colors/seed_colors.ts +++ /dev/null @@ -1,44 +0,0 @@ -/* - * SPDX-License-Identifier: Apache-2.0 - * - * The OpenSearch Contributors require contributions made to - * this file be licensed under the Apache-2.0 license or a - * compatible open source license. - * - * Any modifications Copyright OpenSearch Contributors. See - * GitHub history for details. - */ - -/* - * Licensed to Elasticsearch B.V. under one or more contributor - * license agreements. See the NOTICE file distributed with - * this work for additional information regarding copyright - * ownership. Elasticsearch B.V. licenses this file to you under - * the Apache License, Version 2.0 (the "License"); you may - * not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - */ - -/** - * Using a random color generator presented awful colors and unpredictable color schemes. - * So we needed to come up with a color scheme of our own that creates consistent, pleasing color patterns. - * The order allows us to guarantee that 1st, 2nd, 3rd, etc values always get the same color. - */ -export const seedColors: string[] = [ - '#00a69b', - '#57c17b', - '#6f87d8', - '#663db8', - '#bc52bc', - '#9e3533', - '#daa05d', -];