# Mask
Represents a mask applied to a layer.

{/* Do not edit this file. It is automatically generated by API Documenter. */}

## Mask interface

Represents a mask applied to a layer.

**Signature:**

```typescript
interface Mask
```

## Properties

<table>
  <thead>
    <tr>
      <th>
        Property
      </th>

      <th>
        Modifiers
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [mode](/en/creator-api/nodes/mask/mode)
      </td>

      <td />

      <td>
        [MaskMode](/en/creator-api/types/mask-mode)
      </td>

      <td>
        Whether the mask adds or subtracts from visibility
      </td>
    </tr>

    <tr>
      <td>
        [opacity](/en/creator-api/nodes/mask/opacity)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [Animatable](/en/creator-api/nodes/animatable)\<number>
      </td>

      <td>
        The opacity of the mask effect (0 to 100)
      </td>
    </tr>

    <tr>
      <td>
        [pathData](/en/creator-api/nodes/mask/path-data)
      </td>

      <td>
        `readonly`
      </td>

      <td>
        [Animatable](/en/creator-api/nodes/animatable)\<[PathData](/en/creator-api/values/path-data)>
      </td>

      <td>
        The path data defining the mask shape
      </td>
    </tr>
  </tbody>
</table>

## Methods

<table>
  <thead>
    <tr>
      <th>
        Method
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        [remove()](/en/creator-api/nodes/mask/remove)
      </td>

      <td>
        Removes this mask from the layer it is applied to
      </td>
    </tr>
  </tbody>
</table>