Skip to content

Commit 5b37955

Browse files
committed
doc: update
1 parent a7c9656 commit 5b37955

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

docs/guide/config.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@
66
Photo Sphere Viewer uses a lot of angles for its configuration, most of them can be defined in radians by using a simple number (`3.5`) or in degrees using the "deg" suffix (`'55deg'`).
77
:::
88

9-
::: tip Positions definitions
10-
Some methods takes positionnal arguments, this is either on combination `yaw` and `pitch` (radians or degrees) or `textureX` and `textureY` properties (corresponding to the pixel position on the source panorama file).
11-
:::
12-
139
## Standard options
1410

1511
#### `container` (required)
@@ -348,7 +344,7 @@ keyboardActions: {
348344

349345
Configure keyboard actions. It is a map defining key code->action. (all the available actions are listed above)
350346

351-
Since 5.0.2 you can configure an arbitrary callback to any key.
347+
You can also configure an arbitrary callback to any key.
352348

353349
```js
354350
keyboardActions: {
@@ -367,6 +363,10 @@ keyboardActions: {
367363
},
368364
```
369365

366+
::: warning
367+
Keyboard actions will only be available in fullscreen by default, this can be changed with the [`keyboard` option](#keyboard).
368+
:::
369+
370370
#### `rendererParameters`
371371

372372
- type: [`WebGLRendererParameters`](https://threejs.org/docs/#api/en/renderers/WebGLRenderer)

docs/guide/methods.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ viewer.addEventListener('ready', () => {
2727

2828
This section describes the most useful methods available.
2929

30+
::: tip Positions definitions
31+
Some methods takes positionnal arguments, this is either on combination `yaw` and `pitch` (radians or degrees) or `textureX` and `textureY` properties, corresponding to the pixel position on the source panorama file.
32+
:::
33+
3034
### `animate(options): Animation`
3135

3236
Rotate and zoom the view with a smooth animation. You can change the position (`yaw`, `pitch` or `textureX`, `textureY`) and the zoom level (`zoom`).
@@ -49,6 +53,10 @@ viewer.animate({
4953

5054
Remove the viewer from the page and free the memory used by Three.js.
5155

56+
### `getPlugin(pluginId): PluginInstance`
57+
58+
Return the instance of plugin, more details on [the dedicated page](../plugins/README.md).
59+
5260
### `getPosition(): Position`
5361

5462
Return the current position of the view.
@@ -109,6 +117,10 @@ viewer.setPanorama('image.jpg', {
109117
});
110118
```
111119

112-
### `zoom(level)` | `zoomIn()` | `zoomOut()`
120+
### `setOverlay(overlay[, opacity]): Promise`
121+
122+
Change the current [overlay](./config.md#overlay) without changing the panorama.
123+
124+
### `zoom(level)` | `zoomIn([step = 1])` | `zoomOut([step = 1])`
113125

114126
Change the zoom level without animation.

0 commit comments

Comments
 (0)