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

get default(): FormXObject;

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

Returns

FormXObject

Set Signature

set default(value): void;

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

Parameters

value

FormXObject

Returns

void

Methods

getStream()

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

setStream()

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

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

Returns

void