Chore: Apply Emitter in simulator and fix cleanup when terminated, Refactor naming #25
Conversation
src/simulator/shared.ts
Outdated
| STABILIZATION_STARTED = 'stabilizationStarted', | ||
| STABILIZATION_PROGRESS = 'stabilizationProgress', | ||
| STABILIZATION_ENDED = 'stabilizationEnded', | ||
| NODE_DRAGGED = 'nodeDragged', | ||
| NODE_DRAG_ENDED = 'nodeDragEnded', | ||
| SETTINGS_UPDATED = 'settingsUpdated', |
There was a problem hiding this comment.
Nitpicking, but now when you cleaned up Events in simulator engines and main classes, maybe it makes sense to make naming consistent with the rest of the library where:
- Event values are present simple (e.g.
render-start,node-hover,mouse-move) - Event values are not camel case (e.g.
render-start, ...)
There was a problem hiding this comment.
Yep! Makes sense. I'll also refactor these messages in the screenshot, as they are not written in MACRO_CASE.
or maybe the best example is this one where both are clearly visible:
Btw regarding naming, I have a few more questions:
- We are using both
stabilizationandsimulation. Should we merge those two? - In the picture above, should all of them be present simple?
There was a problem hiding this comment.
I would say yes to both. Cleaner and consistent.
src/views/default-view.ts
Outdated
| @@ -27,6 +29,7 @@ export interface IDefaultViewSettings<N extends INodeBase, E extends IEdgeBase> | |||
| isOutOfBoundsDragEnabled: boolean; | |||
| areCoordinatesRounded: boolean; | |||
| isSimulationAnimated: boolean; | |||
| areCollapsedContainerDimensionsAllowed: boolean; | |||
There was a problem hiding this comment.
Just don't forget to add this to the docs for both views.
|
@tonilastre Applied the standardized naming convention and updated docs. Feel free to take one final glance. 🙂 |
cizl
changed the title
cizl
changed the title
| } | ||
| tile: new L.TileLayer("https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"), // OpenStreetMaps | ||
| }, | ||
| }; |
There was a problem hiding this comment.
Add areCollapsedContainerDimensionsAllowed here and to the interface above.
src/simulator/shared.ts
Outdated
| onStabilizationProgress: (data: ISimulatorEventGraph & ISimulatorEventProgress) => void; | ||
| onStabilizationEnd: (data: ISimulatorEventGraph) => void; | ||
| onSimulationStart: () => void; | ||
| onSIMULATION_PROGRESS: (data: ISimulatorEventGraph & ISimulatorEventProgress) => void; |
There was a problem hiding this comment.
It was bound to happen 😅
src/views/default-view.ts
Outdated
| @@ -49,7 +50,7 @@ export class DefaultView<N extends INodeBase, E extends IEdgeBase> implements IO | |||
|
|
|||
| private _isSimulating = false; | |||
| private _onSimulationEnd: (() => void) | undefined; | |||
| private _simulationStartedAt = Date.now(); | |||
| private _simulationStartedAtAt = Date.now(); | |||
| @@ -204,7 +206,7 @@ that allows Orb to position the nodes. | |||
|  | |||
|
|
|||
| ```typescript | |||
| import { DefaultView } from '@memgraph/orb'; | |||
| import { DefaultView } from "@memgraph/orb"; | |||
There was a problem hiding this comment.
We have to align our formatters at some point. Seems like every time we open a markdown file and save it we have different outputs.
No description provided.