Skip to content

Commit

Permalink
#587 Update more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tariqksoliman committed Sep 26, 2024
1 parent 0503b9d commit 03e0225
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/pages/Configure/Layers/Tile/Tile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<your_layer_name><,another_if_you _want>` to your `URL`. To override WMS parameters append `&<wms_param>=<value>` 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
Expand Down
11 changes: 11 additions & 0 deletions docs/pages/Configure/Layers/Vector/Vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand Down
2 changes: 1 addition & 1 deletion src/essence/Basics/Layers_/Layers_.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/essence/Tools/Layers/LayersTool.js
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ function interfaceWithMMGIS(fromInit) {
'<label class="autoRefreshInterval ' +
F_.getSafeName(node[i].name) +
'">' +
(node[i].time.refreshIntervalAmount || 30) +
(node[i].time.refreshIntervalAmount || 60) +
' Seconds</label>',
'</div>',
'</li>'
Expand Down

0 comments on commit 03e0225

Please sign in to comment.