# ClipExtension The `ClipExtension` adds support for clipping rendered layers by rectangular bounds. Clipping works with rendering primitives in `@deck.gl/layers` and `@deck.gl/mesh-layers`. Composite layers inherit support from their sublayers. Both clipping modes compose with `BrushingExtension`. Custom layers must expose the [extension shader hooks](../../developer-guide/custom-layers/layer-extensions.md#webgpu-shader-plugins). ```js import {GeoJsonLayer} from '@deck.gl/layers'; import {ClipExtension} from '@deck.gl/extensions'; const layer = new GeoJsonLayer({ // Natural Earth countries dataset includes Antarctica, which renders stretched further to south in MapView with viewState normalization disabled data: 'https://d2ad6b4ur7yvpq.cloudfront.net/naturalearth-3.3.0/ne_50m_admin_0_countries.geojson', // clip rendered layer by Mercator bounds extensions: [new ClipExtension()], clipBounds: [-180, -85.051129, 180, 85.051129], }); ``` ## Installation To install the dependencies from NPM: ```bash npm install deck.gl # or npm install @deck.gl/core @deck.gl/extensions ``` ```js import {ClipExtension} from '@deck.gl/extensions'; new ClipExtension(); ``` To use pre-bundled scripts: ```html ``` ```js new deck.ClipExtension(); ``` ## Constructor ```js new ClipExtension(); ``` ## Layer Properties When added to a layer via the `extensions` prop, the `ClipExtension` adds the following properties to the layer: #### `clipBounds` (number[4]) {#clipbounds} Rectangular bounds to be used for clipping the rendered region. Supported format: `[left, bottom, right, top]` To clip across the antimeridian, use a `left` more than 180° greater than `right`, e.g. `[170, -20, -170, 20]`. Other reversed edges are re-ordered. Crossing regions 180° or wider, and clipping with `clipByInstance: true`, need two layers. #### `clipByInstance` (boolean, optional) {#clipbyinstance} `clipByInstance` controls whether an object is clipped by its anchor (e.g. icon, point) or by its geometry (e.g. path, polygon). If not specified, it is deduced from whether there is an attribute called `instancePositions`. This behavior can be overridden if: - the anchor attribute goes by some other name - to clip an anchored layer by geometry, like the text layer ## Source [modules/extensions/src/clip](https://github.com/visgl/deck.gl/tree/master/modules/extensions/src/clip)