From 03e0225386ebd0884d4dd88caa3311f691130701 Mon Sep 17 00:00:00 2001 From: Tariq Soliman Date: Thu, 26 Sep 2024 13:49:37 -0700 Subject: [PATCH] #587 Update more docs --- docs/pages/Configure/Layers/Tile/Tile.md | 11 +++++++++++ docs/pages/Configure/Layers/Vector/Vector.md | 11 +++++++++++ src/essence/Basics/Layers_/Layers_.js | 2 +- src/essence/Tools/Layers/LayersTool.js | 2 +- 4 files changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/pages/Configure/Layers/Tile/Tile.md b/docs/pages/Configure/Layers/Tile/Tile.md index 4ca47c08..cb70e37b 100644 --- a/docs/pages/Configure/Layers/Tile/Tile.md +++ b/docs/pages/Configure/Layers/Tile/Tile.md @@ -40,6 +40,17 @@ The format of the tiles. - WMS: Web Map Service tiles are a popular way of publishing maps by professional GIS software. This format is similar to the previous two formats, but more generic and not so well optimized for use in web maps. A WMS image is defined by the coordinates of its corners. A layer (or list of layers) should be provided as an options by appending `?layers=<,another_if_you _want>` to your `URL`. To override WMS parameters append `&=` again to the `URL` after the "layers" parameters. If desired, use `&TILESIZE=` to change the tile size of the request and layer away from the default of 256. _Example URL: `http://ows.mundialis.de/services/service?layers=TOPO-WMS,OSM-Overlay-WMS`_ +#### Refresh Interval Enabled + +_type:_ boolean +If 'Time Enabled' and 'Refresh Interval Enabled', this layer will automatically refresh/requery its data every 'Refresh Every N Seconds'. This is useful when the layer's data updates at some uniform cadence. Be aware that this may be an expensive operation depending on the amount of data a layer needs and the number of layers that have this enabled. + +#### Refresh Every N Seconds + +_type:_ number +_default:_ 60 +If 'Time Enabled' and 'Refresh Interval Enabled', this layer will automatically refresh/requery its data every n seconds. + #### Initial Visibility _type:_ bool diff --git a/docs/pages/Configure/Layers/Vector/Vector.md b/docs/pages/Configure/Layers/Vector/Vector.md index d2ba3f4e..e9c9be7d 100644 --- a/docs/pages/Configure/Layers/Vector/Vector.md +++ b/docs/pages/Configure/Layers/Vector/Vector.md @@ -79,6 +79,17 @@ Required in `Time Enabled = true` and `Time Type = Local`. The main time propert _type:_ string _optional_ The string format to be used in the URL for `{starttime}` and `{endtime}`. Defaults to `YYYY-MM-DDTHH:mm:ssZ`. +#### Refresh Interval Enabled + +_type:_ boolean +If 'Time Enabled' and 'Refresh Interval Enabled', this layer will automatically refresh/requery its data every 'Refresh Every N Seconds'. This is useful when the layer's data updates at some uniform cadence. Be aware that this may be an expensive operation depending on the amount of data a layer needs and the number of layers that have this enabled. + +#### Refresh Every N Seconds + +_type:_ number +_default:_ 60 +If 'Time Enabled' and 'Refresh Interval Enabled', this layer will automatically refresh/requery its data every n seconds. + #### Stroke Color _type:_ CSS color string or a prop _optional_ diff --git a/src/essence/Basics/Layers_/Layers_.js b/src/essence/Basics/Layers_/Layers_.js index 851cbf2f..d1d53075 100644 --- a/src/essence/Basics/Layers_/Layers_.js +++ b/src/essence/Basics/Layers_/Layers_.js @@ -3580,7 +3580,7 @@ function parseConfig(configData, urlOnLayers) { } } }, - (d[i].time.refreshIntervalAmount || 30) * 1000 + (d[i].time.refreshIntervalAmount || 60) * 1000 ) } //Save the prevName for easy tracing back diff --git a/src/essence/Tools/Layers/LayersTool.js b/src/essence/Tools/Layers/LayersTool.js index ebdfdaad..69ca102e 100644 --- a/src/essence/Tools/Layers/LayersTool.js +++ b/src/essence/Tools/Layers/LayersTool.js @@ -364,7 +364,7 @@ function interfaceWithMMGIS(fromInit) { '', '', ''