# AppearanceStream

## Content

# Class: AppearanceStream

Represents an appearance entry ("N", "D" or "R") of an annotation's appearance dictionary.
An appearance entry can contain a single (default) appearance stream, or a set of named
appearance streams (e.g. representing the on/off states of a check box).

## Accessors

### default

#### Get Signature

```ts
get default(): FormXObject;
```

Gets the default appearance stream (a [FormXObject](FormXObject)), or null if there is none.

##### Returns

[`FormXObject`](FormXObject)

#### Set Signature

```ts
set default(value): void;
```

Sets the default appearance stream (a [FormXObject](FormXObject)), null removes it.

##### Parameters

###### value

[`FormXObject`](FormXObject)

##### Returns

`void`

## Methods

### getStream()

```ts
getStream(name): FormXObject;
```

Gets the appearance stream with the specified name, or null if there is none.

#### Parameters

##### name

`string`

The name of the appearance stream.

#### Returns

[`FormXObject`](FormXObject)

***

### setStream()

```ts
setStream(name, value): void;
```

Sets the appearance stream with the specified name, null removes it.

#### Parameters

##### name

`string`

The name of the appearance stream.

##### value

[`FormXObject`](FormXObject)

The new appearance stream (a [FormXObject](FormXObject)), or null.

#### Returns

`void`
