Skip to content

Commit 913c97d

Browse files
authoredSep 2, 2022
Clarify useTileLayerAsFallback #222
1 parent 34b26ca commit 913c97d

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed
 

‎README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ by using stacProxyUrl you can proxy the original STAC server with one that enabl
122122

123123
### tileSourceTemplate
124124

125-
The `tileSourceTemplate` variable controls the tile layer that is used to render COGs.
125+
The `tileSourceTemplate` variable controls the tile layer that is used to render imagera such as (cloud-optimized) GeoTiffs.
126126

127127
The format of this value is a tile layer template with an optional `{url}` that will be replaced with the COG asset href. For example,
128128
using a local version of [titiler](https://github.com/developmentseed/titiler) to serve local COG files would look something like:
@@ -131,6 +131,8 @@ using a local version of [titiler](https://github.com/developmentseed/titiler) t
131131
npm start -- --open --tileSourceTemplate="http://localhost:8000/cog/tiles/{z}/{x}/{y}?url={url}"
132132
```
133133

134+
If the option `useTileLayerAsFallback` is set to `true`, the tile server is only used as a fallback.
135+
134136
### buildTileUrlTemplate
135137

136138
A more flexible option than `tileSourceTemplate` is passing a function to `buildTileUrlTemplate`.
@@ -140,12 +142,25 @@ This option replaces the v2 option `tileProxyUrl`.
140142

141143
Please note that this option can only be provided through a config file and is not available via CLI.
142144

145+
If the option `useTileLayerAsFallback` is set to `true`, the tile server is only used as a fallback.
146+
143147
### useTileLayerAsFallback
144148

145-
If either `tileSourceTemplate` or `buildTileUrlTemplate` are given server-side rendering of COGs is enabled.
149+
Depending on this option, either client-side or server-side rendering of imagery such as (cloud-optimized) GeoTiffs can be enabled/disabled.
150+
151+
If either `tileSourceTemplate` or `buildTileUrlTemplate` are given server-side rendering of GeoTiffs is enabled.
146152
If server-side rendering should only be used as a fallback for client-side rendering, enable the boolean `useTileLayerAsFallback` option.
147153

148-
By default, client-side COG rendering is enabled. A server-side fallback is provided via the [tiles.rdnt.io](https://github.com/radiantearth/tiles.rdnt.io) project, which serves publicly accessible COGs as tile layers.
154+
To clarify the behavior, please have a look at the following table:
155+
156+
| `useTileLayerAsFallback` | `tileSourceTemplate` / `buildTileUrlTemplate` | primary imagery renderer | fallback imagery renderer |
157+
| ----- | ---------------------- | ----------- | ----------- |
158+
| true | one of them configured | client-side | tile-server |
159+
| false | one of them configured | tile-server | none |
160+
| true | none configured | client-side | none |
161+
| false | none configured | none | none |
162+
163+
By default, client-side rendering is enabled. A server-side fallback is provided via the [tiles.rdnt.io](https://github.com/radiantearth/tiles.rdnt.io) project, which serves publicly accessible GeoTiffs as tile layers.
149164

150165
### displayGeoTiffByDefault
151166

0 commit comments

Comments
 (0)