[Refactor] Extend color scheme management to sequential schemes #6150
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #6150 +/- ##
=======================================
Coverage 76.91% 76.91%
=======================================
Files 47 47
Lines 9362 9362
=======================================
Hits 7201 7201
Misses 2161 2161Continue to review full report at Codecov.
|
williaster
approved these changes
Oct 22, 2018
| @@ -25,7 +25,7 @@ import { nonEmpty } from '../../validators'; | |||
| import vizTypes from '../../visTypes'; | |||
|
|
|||
| import { t } from '../../../locales'; | |||
| import { getScheme } from '../../../modules/ColorSchemeManager'; | |||
| import getCategoricalSchemeRegistry from '../../../modules/colors/CategoricalSchemeRegistrySingleton'; | |||
There was a problem hiding this comment.
do you think this (and analogous calls in other files) should be ClassCase since it's an instance and you still call .get() on it?
i.e., CategoricalSchemeRegistry.get()...
There was a problem hiding this comment.
Currently all registries exports the getInstance function as default.
export default getInstance;usage as
import getXXX from 'XXXSingleton';I will have to modify the export to
export default {
get: getInstance
};and imports to
import { get } from 'XXXSingleton';to make calls become XXX.get()
There was a problem hiding this comment.
Got it, sorry I was thinking about this a litle differently. I think it makes sense as is 👍
michellethomas
pushed a commit
to michellethomas/panoramix
that referenced
this pull request
Oct 24, 2018
…he#6150) * refactor color scheme * Update data structure * Update color scheme files * wip * convert all sequential schemes * Update how color schemes are managed. Extend it for sequential schemes * extract color setup into separate file * Update imports * update imports * Add new functions to Registry * Update ColorSchemeManager to extends Registry and update unit tests * Add test for Registry * Rename ColorSchemeManager to ColorSchemeRegistry * Fix unit tests * Update API * Fix imports * Add label field * Fix reference to colors * update SequentialScheme contructor * Fix controls * rename manager to registry * Split sequential schemes into multiple files * update sequential color labels * add values and valuesAsPromise() * use .values() (cherry picked from commit b9257b2)
bipinsoniguavus
pushed a commit
to ThalesGroup/incubator-superset
that referenced
this pull request
Dec 26, 2018
…he#6150) * refactor color scheme * Update data structure * Update color scheme files * wip * convert all sequential schemes * Update how color schemes are managed. Extend it for sequential schemes * extract color setup into separate file * Update imports * update imports * Add new functions to Registry * Update ColorSchemeManager to extends Registry and update unit tests * Add test for Registry * Rename ColorSchemeManager to ColorSchemeRegistry * Fix unit tests * Update API * Fix imports * Add label field * Fix reference to colors * update SequentialScheme contructor * Fix controls * rename manager to registry * Split sequential schemes into multiple files * update sequential color labels * add values and valuesAsPromise() * use .values()
mistercrunch
added
🏷️ bot
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Centralize color management for ease of maintenance and customization. Also good for future migration to an independent
npmpackage insuperset-ui-core.controls.jsx. The colors are in separate file.Changes
Create data structure
ColorSchemeand childrenCategoricalSchemeandSequentialSchemeto holdcolorsarray, and its metadata (name,label,description,isDiverging) in one place. Convert the arrays of colors incolorSchemesdirectory andsequential.jsto use these new data structures.Leverage
Registryclass that was introduced with the chart plugin system.ColorSchemeManageris renamed toColorSchemeRegistryand extends fromRegistry.Add new function
getMap,getMapAsPromise,values(),valuesAsPromise()andcleartoRegistrywith new unit tests.Create two children singleton classes
CategoricalSchemeManagerandSequentialSchemeManagerto manage categorical and sequential scheme, respectively.Update usage and corresponding unit tests throughout the app.
Extract color setup from
common.jsintosetupColors.jsMove color-related modules under
src/modules/colorsdirectory and unit tests underspec/modules/colors.Test plan
@williaster @conglei @graceguo-supercat @michellethomas