[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,159 @@ 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 all examples located in `/public/examples_templates/`. | ||
| */ | ||
| class NetJSONGraph { | ||
| /** | ||
| * @constructor | ||
| * Initializes a new NetJSONGraph instance. | ||
| * | ||
| * @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; | ||
| } | ||
|
|
||
| /** | ||
| * Initializes the configuration with values and set render to map or 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, | ||
| setupModeSwitching: this.setupModeSwitching, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * 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", | ||
| }); | ||
| } | ||
|
|
||
| // ──────────── Lifecycle Methods ──────────── | ||
|
|
||
| /** | ||
| * Callback function executed during initialization. | ||
| * | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onInit() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * Callback function executed when rendering starts. | ||
| * | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onRender() { | ||
| this.utils.showLoading.call(this); | ||
| this.gui.init(); | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * Callback function executed when data updates. | ||
| * | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| onUpdate() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * Callback function executed after data updates. | ||
| * | ||
| * @this {NetJSONGraph} | ||
| * @returns {Object} - The graph configuration. | ||
| */ | ||
| afterUpdate() { | ||
| return this.config; | ||
| } | ||
|
|
||
| /** | ||
| * Callback function executed when the graph is first rendered. | ||
| * | ||
| * @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 = () => { | ||
| 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; | ||
| document.querySelector(".leaflet-control-attribution").style.display = | ||
| "none"; | ||
| document.querySelector(".leaflet-control-zoom").style.display = | ||
| "none"; | ||
| } else { | ||
| this.echarts.clear(); | ||
| this.config.render = this.utils.mapRender; | ||
| this.utils.mapRender(this.data, this); | ||
| document.querySelector(".leaflet-control-attribution").style.display = | ||
| "block"; | ||
| document.querySelector(".leaflet-control-zoom").style.display = | ||
| "block"; | ||
| } | ||
| }; | ||
| } | ||
| this.utils.hideLoading.call(this); | ||
| return this.config; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -157,6 +169,8 @@ registerLeafletSystem(echarts, L, { | |
| env, | ||
| }); | ||
|
|
||
| // Expose objects globally | ||
|
|
||
| window.NetJSONGraph = NetJSONGraph; | ||
| window.echarts = echarts; | ||
| window.L = L; | ||
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.
Any programmer should know that a constructor initializes a new instance of the class, I think this comment can be removed.
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.
Please remove this. Not useful.