add doc & rename variable

Canadian-Geospatial-Platform · Feb 22, 2024 · fdd8401 · fdd8401
1 parent 9f727a4
commit fdd8401
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/packages/geoview-core/src/geo/layer/geoview-layers/abstract-geoview-layers.ts b/packages/geoview-core/src/geo/layer/geoview-layers/abstract-geoview-layers.ts
@@ -1504,10 +1504,11 @@ export abstract class AbstractGeoViewLayer {
    *
    * @param {string} layerPath The layer path to the layer's configuration affected by the change.
    * @param {TimeDimension} temporalDimension The value to assign to the layer temporal dimension property.
+   * @param {boolean} custom Flag allow's to customize the layer's temporal dimension property.
    */
-  setTemporalDimension(layerPath: string, temporalDimension: TimeDimension, override: boolean): void {
+  setTemporalDimension(layerPath: string, temporalDimension: TimeDimension, custom: boolean): void {
     layerPath = layerPath || this.layerPathAssociatedToTheGeoviewLayer;
-    if (override) {
+    if (custom) {
       const timeDimension: TimeDimension = {
         field: temporalDimension.field,
         default: temporalDimension.default,

diff --git a/packages/geoview-time-slider/src/index.tsx b/packages/geoview-time-slider/src/index.tsx
@@ -100,7 +100,9 @@ class TimeSliderPlugin extends FooterPlugin {
     // Set custom time dimension if applicable
     this.configObj.sliders.forEach((obj: SliderProps) => {
       if (obj.temporalDimension) {
-        api.maps[this.pluginProps.mapId].layer.geoviewLayer(obj.layerPaths[0]).setTemporalDimension(obj.layerPaths[0], {
+        api.maps[this.pluginProps.mapId].layer.geoviewLayer(obj.layerPaths[0]).setTemporalDimension(
+          obj.layerPaths[0],
+          {
             ...obj.temporalDimension,
           },
           true