[refactor] Improve code structure #347 #348
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,147 +7,154 @@ const colorTool = require("zrender/lib/tool/color"); | |
| const {each} = require("zrender/lib/core/util"); | ||
| const env = require("zrender/lib/core/env"); | ||
|
|
||
| /** | ||
| * @class | ||
| * Class NetJSONGraph is entry point for NetJSONGraph library. | ||
| * Used as a global object in the examples_templates. | ||
| */ | ||
| class NetJSONGraph { | ||
| /** | ||
| * @constructor | ||
| * | ||
| * @param {string} JSONParam - The NetJSON file parameter. | ||
| * @param {Object} [config={}] - Configuration options for the graph. | ||
| */ | ||
| constructor(JSONParam, config = {}) { | ||
| this.graph = new NetJSONGraphCore(JSONParam); | ||
| this.config = this.initializeConfig(config); | ||
| this.graph.setConfig(this.config); | ||
| this.setupGraph(); | ||
| this.config.onInit.call(this.graph); | ||
| this.initializeECharts(); | ||
| // eslint-disable-next-line no-constructor-return | ||
| return this.graph; | ||
| } | ||
|
|
||
| /** | ||
| * @param {Object} config - The user-defined configuration. | ||
| * @returns {Object} - The final configuration object. | ||
| */ | ||
| initializeConfig(config = {}) { | ||
| return { | ||
| ...config, | ||
| render: | ||
| config.render === "map" | ||
|
There was a problem hiding this comment. @dee077 & @nemesifier
https://github.com/openwisp/netjsongraph.js?tab=readme-ov-file#configuration-instructions I think, config can be undefined and user can pass custom render function so this need to be handled. |
||
| ? NetJSONGraphRender.prototype.mapRender | ||
| : NetJSONGraphRender.prototype.graphRender, | ||
| onInit: this.onInit, | ||
| onRender: this.onRender, | ||
| onUpdate: this.onUpdate, | ||
| afterUpdate: this.afterUpdate, | ||
| onLoad: this.onLoad, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Sets up rendering utilities, GUI, and event handling. Used in constructor | ||
| */ | ||
| setupGraph() { | ||
| Object.setPrototypeOf(NetJSONGraphRender.prototype, this.graph.utils); | ||
| this.graph.gui = new NetJSONGraphGUI(this.graph); | ||
| this.graph.utils = new NetJSONGraphRender(); | ||
| this.graph.setUtils(); | ||
| this.graph.event = this.graph.utils.createEvent(); | ||
| } | ||
|
|
||
| /** | ||
| * Initializes the ECharts rendering engine. Used in constructor | ||
| */ | ||
| initializeECharts() { | ||
| this.graph.echarts = echarts.init(this.graph.el, null, { | ||
| renderer: this.graph.config.svgRender ? "svg" : "canvas", | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onInit() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onRender() { | ||
| this.utils.showLoading.call(this); | ||
| this.gui.init(); | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onUpdate() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| afterUpdate() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * In map mode, two canvas elements are used: | ||
| * - One canvas displays the map tiles (background). | ||
| * - The other canvas renders the nodes and links on top of the map. | ||
| * | ||
| * When switching to graph mode, the map canvas remains in the DOM, | ||
| * but its container's background color is updated to match the graph rendering, | ||
| * | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onLoad() { | ||
| if (this.config.metadata && this.type === "netjson") { | ||
| this.gui.createMetaInfoContainer(this.graph); | ||
| this.utils.updateMetadata.call(this); | ||
| } else { | ||
| this.gui.nodeLinkInfoContainer = this.gui.createNodeLinkInfoContainer(); | ||
| } | ||
| if (this.config.switchMode && this.type === "netjson") { | ||
nemesifier marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| this.gui.renderModeSelector.onclick = () => { | ||
| // Switch from map to graph mode, first clear canvasContainer and then render | ||
| if (this.config.render === this.utils.mapRender) { | ||
| this.config.render = this.utils.graphRender; | ||
| const canvasContainer = this.echarts | ||
| .getZr() | ||
| .painter.getViewportRoot().parentNode; | ||
| this.echarts.clear(); | ||
| this.utils.graphRender(this.data, this); | ||
| canvasContainer.style.background = | ||
| // eslint-disable-next-line no-underscore-dangle | ||
| this.echarts.getZr()._backgroundColor; | ||
|
|
||
| // Hide Openstreetmap credits in the bottom right corner | ||
| document.querySelector(".leaflet-control-attribution").style.display = | ||
| "none"; | ||
| // Hide zoom control buttons in top right corner | ||
| document.querySelector(".leaflet-control-zoom").style.display = | ||
| "none"; | ||
| } else { | ||
| this.echarts.clear(); | ||
| this.config.render = this.utils.mapRender; | ||
| this.utils.mapRender(this.data, this); | ||
| // Show OpenStreetMap credits and zoom control buttons in map mode | ||
| document.querySelector(".leaflet-control-attribution").style.display = | ||
| "block"; | ||
| document.querySelector(".leaflet-control-zoom").style.display = | ||
| "block"; | ||
| } | ||
| }; | ||
| } | ||
| this.utils.hideLoading.call(this); | ||
| return this.config; | ||
| } | ||
| } | ||
|
|
||
|
|
||
Oops, something went wrong.
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.
I am not 100% sure if in Javascript this is an antipattern how in python is, but we have been bitten quite a few times by this issue in Python: https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments
Are you sure this is not goint to be problematic here? Are you sure this change is really necessary?
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.
I went through this doc
Evaluated at call time
The default argument is evaluated at call time. Unlike with Python (for example), a new object is created each time the function is called.
With this, I don't think there would be any problem.