Closes #1460 virtual-tour: new "updateNode" method

mistic100 · Oct 21, 2024 · 93e3c08 · 93e3c08
1 parent 8fda3c7
commit 93e3c08
Show file tree

Hide file tree

Showing 4 changed files with 226 additions and 115 deletions.
diff --git a/docs/plugins/virtual-tour.md b/docs/plugins/virtual-tour.md
@@ -361,6 +361,22 @@ The default behaviour is to rotate the view to face the direction of the link an
 
 If the [Compass plugin](./compass.md) is enabled, displays the links on the compass.
 
+#### `showLinkTooltip`
+
+-   type: `boolean`
+-   default: `true`
+-   updatable: no
+
+Should a tooltip be displayed on each link. The default tooltip contains `name` + `thumbnail` + `caption`, it is customizable with the [getLinkTooltip](#getlinktooltipcontent-link-node) option.
+
+#### `getLinkTooltip(content, link, node)`
+
+-   type: `function(string, link, node) => string`
+-   default: `null`
+-   updatable: no
+
+Callback used to replace/modify the tooltip for a link. The first parameter is the default tooltip content.
+
 #### `map` (client mode only)
 
 Configuration when using the [Map plugin](./map.md).
@@ -434,14 +450,6 @@ Each node can still have a `map` property to override `color`, `image` and `size
 
 :::::
 
-#### `getLinkTooltip(content, link, node)`
-
--   type: `function(string, link, node) => string`
--   default: `null`
--   updatable: no
-
-Callback used to replace/modify the tooltip for a link. The first parameter is the default tooltip content which contains the node `name` + `thumbnail` + `caption`.
-
 #### `arrowStyle`
 
 -   type: `object`
@@ -486,6 +494,18 @@ Default value is:
 
 Changes the nodes and display the first one (or the one designated by `startNodeId`).
 
+#### `updateNode(node)` (client mode only)
+
+Updates a single node. If it is the current node, the viewer will be updated accordingly. All attributes or optionnal but `id`.
+
+```js
+virtualTourPlugin.updateNode({
+    id: 'node-1',
+    caption: 'New caption',
+    links: [...newLinks],
+});
+```
+
 #### `setCurrentNode(nodeId, [options])`
 
 Changes the current node. `options` allows to override the default `transitionOptions`.

diff --git a/examples/plugin-virtual-tour.html b/examples/plugin-virtual-tour.html
@@ -200,6 +200,7 @@
                         renderMode: '3d',
                         startNodeId: nodes[1].id,
                         preload: true,
+                        // showLinkTooltip: false,
                         transitionOptions: {
                             // showLoader: false,
                             // speed: '10rpm',