Add registry of component modules #845
move registry objects and helper method to src/registry.js
- this will help free Plots of some circular dependencies - make sure the ref back Registry contents in Plots for backward compatibility
- Loading branch information
commit 910e17c756062d95d50f3698008520802009663f
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| /** | ||
| * Copyright 2012-2016, Plotly, Inc. | ||
| * All rights reserved. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
|
|
||
| 'use strict'; | ||
|
There was a problem hiding this comment. This module doesn't really fit anywhere else then in the Maybe we should move |
||
|
|
||
| var Lib = require('./lib'); | ||
| var basePlotAttributes = require('./plots/attributes'); | ||
|
|
||
| exports.modules = {}; | ||
| exports.allTypes = []; | ||
| exports.allCategories = {}; | ||
| exports.subplotsRegistry = {}; | ||
| exports.transformsRegistry = {}; | ||
|
|
||
| /** | ||
| * register a module as the handler for a trace type | ||
| * | ||
| * @param {object} _module the module that will handle plotting this trace type | ||
| * @param {string} thisType | ||
| * @param {array of strings} categoriesIn all the categories this type is in, | ||
| * tested by calls: traceIs(trace, oneCategory) | ||
| * @param {object} meta meta information about the trace type | ||
| */ | ||
| exports.register = function(_module, thisType, categoriesIn, meta) { | ||
| if(exports.modules[thisType]) { | ||
| Lib.log('Type ' + thisType + ' already registered'); | ||
| return; | ||
| } | ||
|
|
||
| var categoryObj = {}; | ||
| for(var i = 0; i < categoriesIn.length; i++) { | ||
| categoryObj[categoriesIn[i]] = true; | ||
| exports.allCategories[categoriesIn[i]] = true; | ||
| } | ||
|
|
||
| exports.modules[thisType] = { | ||
| _module: _module, | ||
| categories: categoryObj | ||
| }; | ||
|
|
||
| if(meta && Object.keys(meta).length) { | ||
| exports.modules[thisType].meta = meta; | ||
| } | ||
|
|
||
| exports.allTypes.push(thisType); | ||
| }; | ||
|
|
||
| /** | ||
| * register a subplot type | ||
| * | ||
| * @param {object} _module subplot module: | ||
| * | ||
| * @param {string or array of strings} attr | ||
| * attribute name in traces and layout | ||
| * @param {string or array of strings} idRoot | ||
| * root of id (setting the possible value for attrName) | ||
| * @param {object} attributes | ||
| * attribute(s) for traces of this subplot type | ||
| * | ||
| * In trace objects `attr` is the object key taking a valid `id` as value | ||
| * (the set of all valid ids is generated below and stored in idRegex). | ||
| * | ||
| * In the layout object, a or several valid `attr` name(s) can be keys linked | ||
| * to a nested attribute objects | ||
| * (the set of all valid attr names is generated below and stored in attrRegex). | ||
| */ | ||
| exports.registerSubplot = function(_module) { | ||
| var plotType = _module.name; | ||
|
|
||
| if(exports.subplotsRegistry[plotType]) { | ||
| Lib.log('Plot type ' + plotType + ' already registered.'); | ||
| return; | ||
| } | ||
|
|
||
| // not sure what's best for the 'cartesian' type at this point | ||
| exports.subplotsRegistry[plotType] = _module; | ||
| }; | ||
|
|
||
| /** | ||
| * Get registered module using trace object or trace type | ||
| * | ||
| * @param {object||string} trace | ||
| * trace object with prop 'type' or trace type as a string | ||
| * @return {object} | ||
| * module object corresponding to trace type | ||
| */ | ||
| exports.getModule = function(trace) { | ||
| if(trace.r !== undefined) { | ||
| Lib.warn('Tried to put a polar trace ' + | ||
| 'on an incompatible graph of cartesian ' + | ||
| 'data. Ignoring this dataset.', trace | ||
| ); | ||
| return false; | ||
| } | ||
|
|
||
| var _module = exports.modules[getTraceType(trace)]; | ||
| if(!_module) return false; | ||
| return _module._module; | ||
| }; | ||
|
|
||
| /** | ||
| * Determine if this trace type is in a given category | ||
| * | ||
| * @param {object||string} traceType | ||
| * a trace (object) or trace type (string) | ||
| * @param {string} category | ||
| * category in question | ||
| * @return {boolean} | ||
| */ | ||
| exports.traceIs = function(traceType, category) { | ||
| traceType = getTraceType(traceType); | ||
|
|
||
| if(traceType === 'various') return false; // FIXME | ||
|
There was a problem hiding this comment. old plot.ly workspace hack to we need to keep 😞 There was a problem hiding this comment. I'll clean up the comment though. Good 👀 |
||
|
|
||
| var _module = exports.modules[traceType]; | ||
|
|
||
| if(!_module) { | ||
| if(traceType !== undefined) { | ||
| Lib.log('Unrecognized trace type ' + traceType + '.'); | ||
| } | ||
|
|
||
| _module = exports.modules[basePlotAttributes.type.dflt]; | ||
| } | ||
|
|
||
| return !!_module.categories[category]; | ||
| }; | ||
|
|
||
| function getTraceType(traceType) { | ||
| if(typeof traceType === 'object') traceType = traceType.type; | ||
| return traceType; | ||
| } |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Important. Ensure backward compatibility in the
Plotly.Plotsprops and methods ⏬There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we use one of the
Lib.extendvariants here?