Add registry of component modules #845
Merged
Conversation
This file contains hidden or 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
- this will help free Plots of some circular dependencies - make sure the ref back Registry contents in Plots for backward compatibility
by: - requiring svgTextUtils in plot_api.js - moving a injected modules in to src/core.js - requiring some module directly in src/core.js instead of through src/plotly.js
- legend, annotations, shapes, images, rangeslider, rangeselector and updatemenus are now registerd in src/core.js - add 'moduleType' and 'name' properties to component modules - rename 'attributes' prop -> 'layoutAttributes' (for consistency) - rename 'supplyLayoutDefaults' -> 'handleDefaults' when component defaults are required in another default module
- so that they are called only when the range slider/selector components are registered
| Legend.draw(gd); | ||
| RangeSelector.draw(gd); | ||
| UpdateMenus.draw(gd); | ||
| Registry.getComponentMethod('legend', 'draw')(gd); |
There was a problem hiding this comment.
Unlike traces and plot modules, we can't simply loop over them in a given plot step. Some components may require two draw calls per plot call, some component may not. Some components may have a calc step, some components may not etc.
So instead, we use a getter method to the component method on-demand. Note that if a given component isn't register, Registry.getComponentMethod() will return a noop.
15 tasks
| @@ -498,6 +493,10 @@ module.exports = { | |||
| ].join(' ') | |||
| }, | |||
|
|
|||
| _nestedModules: { | |||
There was a problem hiding this comment.
this tells Plotly.PlotSchema.get to look for the attributes in the component registry.
|
Okey dokes. After the conflicts are all bueno and lil change to the |
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.
This PR introduces a new registry, this one for component modules. For those keeping track, we now have registries for trace, plot (aka subplot aka base plot), transform and component modules.
This new component registry, will allow us to remove (some, maybe all?) component modules from the core plotly.js module for 🍃 custom builds in
v2.0.0.Internally, this PR
Plotly.registerout ofsrc/plotly.jsand intosrc/plot_api/register.jsside-by-side with itsPlotlymethod friendssrc/plots/plots.jsand intosrc/registry.js. This newregistry.jsmodule only depends onLiband one attribute file which allow us to 🔪 a lot of circular dependenciesRegister.getComponentMethodused to access method of registered component modules without having to require the module themselves.