---
title: viewer3d.clippingplanes
slug: viewer-3d/events/clippingplanes
docTags: 
createdAt: 2024-08-05T10:49:37.899Z
---

Invoked when the list of clipping planes changes.

## Example

::codepen{url="https://codepen.io/Catenda/embed/xxoLMKR"}

## Usage

:::CodeblockTabs
```javascript
const onClippingPlanesChange = function (event) {
  const { clippingPlanes } = event;
  console.log("viewer3d.clippingplanes", "clippingPlanes:", clippingPlanes);
};

viewer3d.addEventListener("viewer3d.clippingplanes", onClippingPlanesChange);
```

jQuery

```javascript
const onClippingPlanesChange = function (event, clippingPlanes) {
  console.log("viewer.clippingplanes", "clippingPlanes:", clippingPlanes);
};

$("#viewer-3d").on("viewer.clippingplanes", onClippingPlanesChange);
```
:::

## Parameters

### onClippingPlanesChange

::::Tabs
:::Tab{title="JS"}
Function called when the list of clipping planes changes.

| **Type**                  |
| ------------------------- |
| `(event: Object) => Void` |

**event**

| **Name**         | **Type**       | **Description**             |
| ---------------- | -------------- | --------------------------- |
| `clippingPlanes` | Array\[Object] | The current clipping planes |

**Clipping Plane**

| **Name**    | **Type**                                 | **Description**                 |
| ----------- | ---------------------------------------- | ------------------------------- |
| `active`    | Boolean                                  | Is the active clipping plane    |
| `direction` | [Vector3](docId\:kEwRHKTC8Iq2HlT48sRFQ)  | Direction of the clipping plane |
| `location`  | [Vector3](docId\:kEwRHKTC8Iq2HlT48sRFQ)  | Location of the clipping plane  |
| `measure`   | Boolean                                  | Is plane measurement enabled    |
:::

:::Tab{title="jQuery"}
Function called when the list of clipping planes changes.

| **Type**                                                 |
| -------------------------------------------------------- |
| `(event: Object, clippingPlanes: Array[Object]) => Void` |

**event**

[jQuery.Event](https://api.jquery.com/category/events/event-object/)

**Clipping Plane**

| **Name**    | **Type**                                 | **Description**                 |
| ----------- | ---------------------------------------- | ------------------------------- |
| `active`    | Boolean                                  | Is the active clipping plane    |
| `direction` | [Vector3](docId\:kEwRHKTC8Iq2HlT48sRFQ)  | Direction of the clipping plane |
| `location`  | [Vector3](docId\:kEwRHKTC8Iq2HlT48sRFQ)  | Location of the clipping plane  |
| `measure`   | Boolean                                  | Is plane measurement enabled    |
:::
::::