From 1b8244543c5ef5721c20e1e7e3044a101d5b9987 Mon Sep 17 00:00:00 2001 From: Luc Claustres Date: Mon, 10 Jun 2024 17:48:42 +0200 Subject: [PATCH] docs: updated center method signature [build doc] --- docs/api/map/globe-mixins.md | 5 +++-- docs/api/map/map-mixins.md | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/api/map/globe-mixins.md b/docs/api/map/globe-mixins.md index 99e232c15..8c9f68760 100644 --- a/docs/api/map/globe-mixins.md +++ b/docs/api/map/globe-mixins.md @@ -9,7 +9,7 @@ This mixin is a mandatory one to build a globe activity ::: Make it possible to manage globe layers and extend supported layer types: -* **setupGlobe(domElement, token)** creates the underlying Cesium globe object with given Cesium Ion token +* **setupGlobe(domElement, token, options)** creates the underlying Cesium globe object with given Cesium Ion token and viewer options * **addLayer(options)/removeLayer(name)** registers/destroys a layer based on a [catalog layer descriptor](./services.md#catalog-service) * **showLayer/hideLayer(name)** (un)hides the given layer in globe, on first show the layer will be lazily created * **hasLayer(name)** check if a given layer is already registered @@ -22,7 +22,8 @@ Make it possible to manage globe layers and extend supported layer types: * **getCesiumLayerByName(name)** retrieve the underlying Cesium object for a given layer * **createCesiumLayer(options)** creates the underlying Cesium object based on a [catalog layer descriptor](./services.md#catalog-service), will check all registered constructor for any one matching * **registerCesiumConstructor(constructor)** registers a Cesium constructor function for a given type of layer -* **center(longitude, latitude, altitude, heading, pitch, roll)** centers the globe view to visualize a given point at a given altitude with and orientation (default is pointing ground vertically [0, 0, -90]) +* **center(longitude, latitude, altitude, heading, pitch, roll, options)** centers the globe view to visualize a given point at a given altitude with and orientation (default is pointing ground vertically [0, 0, -90]), + some options like an animation `duration` can also be added * **getCenter()** get the current globe view center as longitude, latitude and altitude * **getBounds()** get the current map view bounds as `[ [south, west], [north, east] ]` diff --git a/docs/api/map/map-mixins.md b/docs/api/map/map-mixins.md index a67b28a2a..c92b2e671 100644 --- a/docs/api/map/map-mixins.md +++ b/docs/api/map/map-mixins.md @@ -25,9 +25,10 @@ Make it possible to manage map layers and extend supported layer types: * **createLeafletPane(name)** creates the underlying Leaflet object for a pane * **removeLeafletPane(name)** destroys the underlying Leaflet object for a given pane * **registerLeafletConstructor(constructor)** registers a Leaflet constructor function for a given type of layer -* **center(longitude, latitude, zoomLevel)** centers the map view to visualize a given point at a given zoom level +* **center(longitude, latitude, zoomLevel, bearing, options)** centers the map view to visualize a given point at a given zoom level, and possibly bearing when the [leaflet-rotate](https://github.com/Raruto/leaflet-rotate) plugin is active, some options like an animation `duration` can also be added * **getCenter()** get the current map view center as longitude, latitude and zoom level * **getBounds()** get the current map view bounds as `[ [south, west], [north, east] ]` +* **setBearing(bearing)** change the current bearing of the map when the [leaflet-rotate](https://github.com/Raruto/leaflet-rotate) plugin is active * **setCurrentTime(datetime)** sets the current time to be used for time-based visualisation (e.g. weather forecast data or dynamic features) This mixin also adds the following internal data properties: