Skip to content

New: Change the API to handle OrbView and OrbMapView - #34

Merged
tonilastre merged 3 commits into
release/0.2.xfrom
new-change-view-api
Nov 9, 2022
Merged

New: Change the API to handle OrbView and OrbMapView#34
tonilastre merged 3 commits into
release/0.2.xfrom
new-change-view-api

Conversation

@tonilastre

@tonilastre tonilastre commented Nov 7, 2022

Copy link
Copy Markdown
Contributor

The following PR will include API changes to the views such as:

  • There are separate classes for orb default view (OrbView) and orb map view (OrbMapView)
  • It fixes the Typescript issue with settings: Fix the Typescript usage of the view settings #16
  • Orb view (OrbView or OrbMapView) is the main point where it receives a container and optional settings, data, and events are part of the orb view
  • When changing the views on the same container, view.destroy() should be called on the previous view to remove event listeners and content of the container
  • Hover and click strategy changed into view parameters (strategy.isDefaultSelectEnabled, strategy.isDefaultHoverEnabled) with an example in docs/...md on how to overwrite with custom select/hover strategy
  • Fixed the issue when the strategy was missing, click/hover were not working

@tonilastre
tonilastre requested a review from cizl as a code owner November 7, 2022 12:33
@tonilastre
tonilastre marked this pull request as draft November 7, 2022 12:33
@tonilastre
tonilastre marked this pull request as ready for review November 7, 2022 17:04
@tonilastre tonilastre self-assigned this Nov 7, 2022

@cizl cizl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API even looks cleaner now, and I like the new strategy handling.

It seems to me that are starting to have a couple of reused pieces of markdown in our docs (the strategy section for example). This might get difficult to maintain down the line. Just thinking out loud: maybe we could introduce pandoc or some other preprocessor to build our final docs. (for example reference and reuse the strategy section in multiple files)

@tonilastre

Copy link
Copy Markdown
Contributor Author

The API even looks cleaner now, and I like the new strategy handling.

It seems to me that are starting to have a couple of reused pieces of markdown in our docs (the strategy section for example). This might get difficult to maintain down the line. Just thinking out loud: maybe we could introduce pandoc or some other preprocessor to build our final docs. (for example reference and reuse the strategy section in multiple files)

You are 100% right. We can touch base on the docs after you are done with the simulator part. Skip the docs changes for it so we can figure out how to handle it. How does that sound to you?

@tonilastre
tonilastre changed the base branch from main to release/0.2.x November 8, 2022 14:59
@tonilastre
tonilastre merged commit ab9ba31 into release/0.2.x Nov 9, 2022
@tonilastre
tonilastre deleted the new-change-view-api branch November 9, 2022 16:23
tonilastre added a commit that referenced this pull request Jul 28, 2026
… tooling

* Fix: Fix multiple maps issue (#33)

* Chore: Update package.json version

* New: Change the API to handle OrbView and OrbMapView (#34)

* New: Change the API to handle OrbView and OrbMapView

* New: Change the API for select/hover strategies

* Chore: Release/1.0.0

* New: Add support to get selected/hovered nodes and edges (#61)

* New: Added support to get selected nodes and edges

* New: Added support to get hovered nodes and edges

---------

Co-authored-by: Abhinav Singh Parmar <abhinavparmar147@gmail.com>

* New: Add support for enabling and disabling dragging of nodes (fixes #62) (#69)

* New: Add feature to enable/disable node dragging (fixes #62)

* New: Added support to modify interaction from setSettings

* New: Updated documentation for interaction property

* New: Add feature to enable/disable zoom (fixes #62)

* NEW: Updated documentation for interaction property

* NEW: Updated documentation to include isDragEnabled

* New: Add support for custom edge line style (#77)

* New Added support for custom edges

* Refactor: Streamline edge rendering code and optimize line style handling

* New: Add support for handling device pixel ratio (#45)

* Chore: Move container and canvas creation from the view to the renderer

* New: Add devicePixelRatio render property and handler

* Fix: Add default DPR for older browsers

* Chore: Remove useless check for automatic DPR

* New: Add new simulator (#56) (#57)

* New: Add new simulator (#56)

* New: Add simulator scenarios for manual testing
* New: Refactor simulator (WIP)
* New: Add progress overlay, Update descriptions
* Fix: Introduce new simulator event, Fix main-thread behavior
* Fix: Rearrange class methods based on visibility
* Fix: Improve naming
* Chore(release): 0.2.0
* Fix: Tweak simulator, adjust API slightly
* Fix: Temporarily patch some physics behavior
* Fix: Adjust re-heating parameters
* Fix: tweak physics behavior -> immediately stop sim when disabling
* Chore: Remove the beta from release branches

---------

Co-authored-by: dlozic <davidlozic@gmail.com>

* New: Add zoom and recenter functions (#74)

* New: Add zoom and recenter functions

* Fix: Reduce excessive recentering (#75)

* Fix: Remove excessive recenterings
* Fix: Remove unused code

* Fix: New simulator (#92)

* Chore: Refactor naming

* New: Add new events

* Chore: Refactor code styling

* Docs: Remove unused flags

* Chore: Remove unused simulation functions

* Chore: Refactor view render function calls

* Chore: Add missing tests

* New: Add removal functions (#96)

* New: Add removal functions

* Fix: Add missing callback data

* Chore: Refactor remove return values

* Chore: Refactor remove function type usage

* Fix: Default settings for node placement (#98)

* New: Add properties setters and getters (#93)

* New: Add node properties setters

* New: Add edge properties setters

* New: Add properties getters

* New: Add patch for nodes and edges

* Fix: Make getters return copies

* Fix: Edge factory listeners copying

* Fix: Jest outdated tests

* Fix: Github actions node version

* Chore: Refactor observer interface

* Chore: Refactor node/edge constructor settings

* Chore: Refactor node/edge function grouping

* Chore: Refactor node/edge function grouping

* Fix: Listeners behaviour

* Chore: Refactor property copying

* Chore: Refactor subject implementation

* Fix: Set position behaviour on node drag

* Chore: Upgrade node version

* Chore: Refactor function type check

* Fix: Remove listener behaviour

* Chore: Refactor util naming

* Chore: Remove unused type assertion

* Chore: Refactor position setter options

* Chore: Refactor property patch function

* Fix: Set map node position behaviour

* Chore: Refactor simulator data patching

* Chore: Change observers to callbacks

* New: Add state setters with options (#95)

* New: Add state setters with options

* Chore: Remove leftover comments

* Chore: Refactor state setter logic

* Chore: Refactor state types

* Fix: Rename merged function usage

* Fix: Merged variable naming

* Chore: Fix tests

---------

Co-authored-by: dlozic <davidlozic@gmail.com>
Co-authored-by: Oleksandr Ichenskyi <55350107+AlexIchenskiy@users.noreply.github.com>
Co-authored-by: AlexIchenskiy <aichenskiy@gmail.com>

* New: Add zoom in and out functions (#100)

* Fix: Skip unnecessary listener notify on set style

* Fix: remove unnecessary rerender on state change

* Chore: Update documentation

* Fix: Node/edge getter performance issue

* Chore: Add data change docs example

* Fix: Docs typos

* Fix: Disable source map generation (#105)

* New: Add tree layout (#107)

* New: Add new layouts

* New: Add layout options

* Chore: Make layout dynamically changeable

* Chore: Update docs

* Fix: Naming typo

* Chore: Refactor layouts

* New: Enable layout node add/remove

* Chore: Improve behavior for recurrent nodes

* Chore: Move some simulator settings to layout

* Chore: Refactor code quality and performance

* Fix: Layout behavior on change

* Chore: Add recenter on layout change

* Fix: Layout change behavior

* Fix: Simulation behavior on data deletion

* Chore: Add recenter on layout change

* Fix: Change layout engine logic (#108)

* Fix: Change layout engine logic

* New: Add simulation cancellation logic

* Chore: Remove leftover code

* Fix: Hierarchical layout recenter logic

* Chore: Refactor package versions and code logic

* Fix: Refactor function types

* New: Add multiselect (#110)

* New: Add multiselect

* Chore: Simplify logic

* Chore: Update package.json

* New: Add SVG export (#111)

* New: Add SVG export

* Chore: Refactor code quality

* New: Add WebGL renderer (#109)

* New: Add WebGL renderer

* New: Add naive WebGL force layout computation

* New: Add WebGL improved node/shape geometry options

* New: Add labels and node images

* Fix: GPU drag behavior

* Chore: Remove leftover comments

* Fix: WebGL renderer style invalidating

* Chore: Refactor code quality

* Chore: Add WebGL example and docs

* New: Add docs page (#112)

* New: Add docs page

* New: Add more docs examples

* Update .github/workflows/docs.yml

---------

Co-authored-by: Toni <toni.lastre@memgraph.io>

* Chore: Finish up the release process

* Chore: Fix sync between package.json files

* Chore: Add new package-lock.json

---------

Co-authored-by: David <davidlozic@gmail.com>
Co-authored-by: Abhinv Singh Parmar <abhi171b010@gmail.com>
Co-authored-by: Abhinav Singh Parmar <abhinavparmar147@gmail.com>
Co-authored-by: Abhinv Singh Parmar <abhinav.parmar@infosys.com>
Co-authored-by: Oleksandr Ichenskyi <55350107+AlexIchenskiy@users.noreply.github.com>
Co-authored-by: AlexIchenskiy <aichenskiy@gmail.com>
github-actions Bot pushed a commit that referenced this pull request Jul 28, 2026
# [1.0.0](v0.4.3...v1.0.0) (2026-07-28)

### Breaking

* Release 1.0.0 with docs site, WebGL renderer and modernized tooling ([19bbf02](19bbf02)), closes [#33](#33) [#34](#34) [#61](#61)

### chore

* Update workflows (#106) ([e502ab7](e502ab7)), closes [#106](#106)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants