Skip to content

Commit

Permalink
Update TileLayer documentation (#7476)
Browse files Browse the repository at this point in the history
  • Loading branch information
Pessimistress committed Dec 28, 2022
1 parent 7fbd714 commit 2a6a30b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/api-reference/geo-layers/tile-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,9 @@ Note that the following sub layer props are overridden by `TileLayer` internally

##### `zRange` (Array, optional)

An array representing the range of minimum and maximum heights in the tile. This is designed to support extruded layers, such as the TerrainLayer, ensuring the right tiles are loaded and rendered. This prop currently only has effect when used with a geospatial view.
An array representing the height range of the content in the tiles, as `[minZ, maxZ]`. This is designed to support tiles with 2.5D content, such as buildings or terrains. At high pitch angles, such a tile may "extrude into" the viewport even if its 2D bounding box is out of view. Therefore, it is necesary to provide additional information for the layer to behave correctly. The value of this prop is used for two purposes: 1) to determine the necesary tiles to load and/or render; 2) to determine the possible intersecting tiles during picking.

This prop currently only has effect when used with a geospatial view.

- Default: `null` (interpreted as `[0, 0]`)

Expand Down
1 change: 1 addition & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
+ `onTileUnload(tile)`
+ `onTileError(tile)`
+ `pickingInfo.tile` returned by `onHover`, `onClick` etc.
- `TileLayer` and `MVTLayer` that render extruded GeoJSON content must set the [zRange](/docs/api-reference/geo-layers/tile-layer.md#zrange) prop. See documentation for details.
- The base `Effect` class is removed. Custom effects should implement the new `interface Effect` in TypeScript.


Expand Down

0 comments on commit 2a6a30b

Please sign in to comment.