Skip to content

Commit e923ad9

Browse files
Add annotation to all layer classes (#7099)
1 parent 1fac548 commit e923ad9

File tree

56 files changed

+61
-63
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+61
-63
lines changed

docs/api-reference/aggregation-layers/contour-layer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import {ContourLayerDemo} from 'website-components/doc-demos/aggregation-layers'
55

66
# ContourLayer
77

8-
`ContourLayer` renders `Isoline`s or `Isoband`s for a given threshold and cell size. `Isoline` represents collection of line segments that separate the area above and below a given threshold. `Isoband` represents a collection of polygons (filled) that fill the area containing values in a given threshold range. To generate an `Isoline` single threshold value is needed, to generate an `Isoband` an Array with two values needed. Data is first aggregated using given cell size and resulting scalar field is used to run [Marching Squares](https://en.wikipedia.org/wiki/Marching_squares) algorithm that generates a set of vertices to form Isolines or Isobands. In below documentation `Isoline` and `Isoband` is referred as `contour`.
8+
The `ContourLayer` aggregates data into iso-lines or iso-bands for a given threshold and cell size. `Isoline` represents collection of line segments that separate the area above and below a given threshold. `Isoband` represents a collection of polygons (filled) that fill the area containing values in a given threshold range. To generate an `Isoline` single threshold value is needed, to generate an `Isoband` an Array with two values needed. Data is first aggregated using given cell size and resulting scalar field is used to run [Marching Squares](https://en.wikipedia.org/wiki/Marching_squares) algorithm that generates a set of vertices to form Isolines or Isobands. In below documentation `Isoline` and `Isoband` is referred as `contour`.
99

1010

1111
```js

docs/api-reference/aggregation-layers/cpu-grid-layer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {CPUGridLayerDemo} from 'website-components/doc-demos/aggregation-layers'
88

99
# CPUGridLayer
1010

11-
The `CPUGridLayer` renders a grid heatmap based on an array of inputs.
12-
It takes the constant cell size and aggregates input objects into cells. The color
13-
and height of a cell are determined based on the objects it contains. Aggregation is performed on CPU.
11+
The `CPUGridLayer` aggregates data into a grid-based heatmap. The color and height of a cell are determined based on the objects it contains. Aggregation is performed on CPU.
1412

1513
`CPUGridLayer` is one of the sublayers for [GridLayer](/docs/api-reference/aggregation-layers/grid-layer.md), and is provided to customize CPU Aggregation for advanced use cases. For any regular use case, [GridLayer](/docs/api-reference/aggregation-layers/grid-layer.md) is recommended.
1614

docs/api-reference/aggregation-layers/gpu-grid-layer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {GPUGridLayerDemo} from 'website-components/doc-demos/aggregation-layers'
88

99
# GPUGridLayer (WebGL2)
1010

11-
The `GPUGridLayer` renders a grid heatmap based on an array of inputs.
12-
It takes the constant cell size and aggregates input objects into cells. The color
13-
and height of a cell are determined based on the objects it contains. This layer performs aggregation on GPU hence not supported in non WebGL2 browsers.
11+
The `GPUGridLayer` aggregates data into a grid-based heatmap. The color and height of a cell are determined based on the objects it contains. This layer performs aggregation on GPU hence not supported in non WebGL2 browsers.
1412

1513
`GPUGridLayer` is one of the sublayers for [GridLayer](/docs/api-reference/aggregation-layers/grid-layer.md) and is only supported when using `WebGL2` enabled browsers. It is provided to customize GPU Aggregation for advanced use cases. For any regular use case, [GridLayer](/docs/api-reference/aggregation-layers/grid-layer.md) is recommended.
1614

docs/api-reference/aggregation-layers/grid-layer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {GridLayerDemo} from 'website-components/doc-demos/aggregation-layers';
88

99
# GridLayer
1010

11-
The `GridLayer` renders a grid heatmap based on an array of inputs.
12-
It takes the constant cell size and aggregates input objects into cells. The color
13-
and height of a cell are determined based on the objects it contains.
11+
The `GridLayer` aggregates data into a grid-based heatmap. The color and height of a cell are determined based on the objects it contains.
1412

1513
This layer renders either a [GPUGridLayer](/docs/api-reference/aggregation-layers/gpu-grid-layer.md) or a [CPUGridLayer](/docs/api-reference/aggregation-layers/cpu-grid-layer.md), depending on its props and whether GPU aggregation is supported. For more details check the `GPU Aggregation` section below.
1614

docs/api-reference/aggregation-layers/hexagon-layer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ import {HexagonLayerDemo} from 'website-components/doc-demos/aggregation-layers'
88

99
# HexagonLayer
1010

11-
The Hexagon Layer renders a hexagon heatmap based on an array of inputs.
12-
It takes the radius of hexagon bin and aggregates input objects into hexagon bins. The color
13-
and height of a hexagon are determined based on the objects it contains.
11+
The `HexagonLayer` aggregates data into a hexagon-based heatmap. The color and height of a hexagon are determined based on the objects it contains.
1412

1513
HexagonLayer is a [CompositeLayer](/docs/api-reference/core/composite-layer.md) and at the moment only works with `COORDINATE_SYSTEM.LNGLAT`.
1614

docs/api-reference/aggregation-layers/screen-grid-layer.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ import {ScreenGridLayerDemo} from 'website-components/doc-demos/aggregation-laye
44

55
# ScreenGridLayer
66

7-
The Screen Grid Layer takes in an array of latitude and longitude
8-
coordinated points, aggregates them into histogram bins and
9-
renders as a grid. By default aggregation happens on GPU, aggregation falls back to CPU when browser doesn't support GPU Aggregation or when `gpuAggregation` prop is set to false.
7+
The `ScreenGridLayer` aggregates data into histogram bins and renders them as a grid. By default aggregation happens on GPU, aggregation falls back to CPU when browser doesn't support GPU Aggregation or when `gpuAggregation` prop is set to 1.
108

119
```js
1210
import DeckGL from '@deck.gl/react';

docs/api-reference/geo-layers/geohash-layer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {GeohashLayerDemo} from 'website-components/doc-demos/geo-layers';
88

99
# GeohashLayer
1010

11-
The GeohashLayer renders filled and/or stroked polygons, with geometry automatically calculated based on a geohash (geospatial index).
11+
The `GeohashLayer` renders filled and/or stroked polygons based on the [Geohash](https://en.wikipedia.org/wiki/Geohash) geospatial indexing system.
1212

1313
`GeohashLayer` is a [CompositeLayer](/docs/api-reference/core/composite-layer.md).
1414

docs/api-reference/geo-layers/mvt-layer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {MVTLayerDemo} from 'website-components/doc-demos/geo-layers';
88

99
# MVTLayer
1010

11-
`MVTLayer` is a derived `TileLayer` that makes it possible to visualize very large datasets through MVTs ([Mapbox Vector Tiles](https://docs.mapbox.com/vector-tiles/specification/)). Behaving like `TileLayer`, it will only load, decode and render MVTs containing features that are visible within the current viewport.
11+
The `MVTLayer` is a derived `TileLayer` that makes it possible to visualize very large datasets through MVTs ([Mapbox Vector Tiles](https://docs.mapbox.com/vector-tiles/specification/)). Behaving like `TileLayer`, it will only load, decode and render MVTs containing features that are visible within the current viewport.
1212

1313
Data is loaded from URL templates in the `data` property.
1414

docs/api-reference/geo-layers/quadkey-layer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {QuadkeyLayerDemo} from 'website-components/doc-demos/geo-layers';
88

99
# QuadkeyLayer
1010

11-
The QuadkeyLayer renders filled and/or stroked polygons, with geometry automatically calculated based on a quadkey (geospatial index).
11+
The `QuadkeyLayer` renders filled and/or stroked polygons based on the [Quadkey](https://towardsdatascience.com/geospatial-indexing-with-quadkeys-d933dff01496) geospatial indexing system.
1212

1313
`QuadkeyLayer` is a [CompositeLayer](/docs/api-reference/core/composite-layer.md).
1414

docs/api-reference/geo-layers/s2-layer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {S2LayerDemo} from 'website-components/doc-demos/geo-layers';
88

99
# S2Layer
1010

11-
The S2Layer renders filled and/or stroked polygons, with geometry automatically calculated based on an S2 token (geospatial index). It uses the [`s2-geometry`](http://s2geometry.io/) library for S2 polygon calculations.
11+
The `S2Layer` renders filled and/or stroked polygons based on the [S2](http://s2geometry.io/) geospatial indexing system.
1212

1313
`S2Layer` is a [CompositeLayer](/docs/api-reference/core/composite-layer.md).
1414

0 commit comments

Comments
 (0)