Skip to content

Commit b1f4e01

Browse files
docs(layers): add getPixelOffset to ScatterplotLayer documentation
Add documentation for the new getPixelOffset accessor prop, following the same format used by IconLayer and TextLayer documentation. Signed-off-by: Asish Kumar <officialasishkumar@gmail.com>
1 parent 352659b commit b1f4e01

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/api-reference/layers/scatterplot-layer.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,15 @@ The width of the outline of each object, in units specified by `lineWidthUnits`
297297
* If a function is provided, it is called on each object to retrieve its outline width.
298298
* If not provided, it falls back to `strokeWidth`.
299299

300+
#### `getPixelOffset` ([Accessor&lt;number[2]&gt;](../../developer-guide/using-layers.md#accessors), optional) ![transition-enabled](https://img.shields.io/badge/transition-enabled-green.svg?style=flat-square") {#getpixeloffset}
301+
302+
* Default: `[0, 0]`
303+
304+
Screen space offset relative to the `coordinates` in pixel unit.
305+
306+
* If an array is provided, it is used as the offset for all objects.
307+
* If a function is provided, it is called on each object to retrieve its offset.
308+
300309
## Source
301310

302311
[modules/layers/src/scatterplot-layer](https://github.com/visgl/deck.gl/tree/master/modules/layers/src/scatterplot-layer)

0 commit comments

Comments
 (0)