Skip to content

Commit

Permalink
docs: updated center method signature [build doc]
Browse files Browse the repository at this point in the history
  • Loading branch information
claustres committed Jun 10, 2024
1 parent ddb91ca commit 1b82445
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docs/api/map/globe-mixins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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] ]`

Expand Down
3 changes: 2 additions & 1 deletion docs/api/map/map-mixins.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 1b82445

Please sign in to comment.