Class: IccProfile

Represents a PDF ICC profile stream defining a color space transformation.

Extends

• ObjectBase

Accessors

id

Get Signature

get id(): number;

Gets the reference to the object.

Returns

number

Inherited from

ObjectBase.id

---

metadata

Get Signature

get metadata(): Uint8Array<ArrayBufferLike>;

Gets the XMP metadata stream associated with the ICC profile. Returns null if no metadata stream is present.

Returns

Uint8Array<ArrayBufferLike>

Set Signature

set metadata(value): void;

Sets the XMP metadata stream associated with the ICC profile.

Parameters

value

Uint8Array

Returns

void

---

n

Get Signature

get n(): number;

Gets the number of color components in the color space described by the ICC profile data. Valid values are 1, 3, or 4.

Returns

number

Set Signature

set n(value): void;

Sets the number of color components in the color space described by the ICC profile data. Valid values are 1, 3, or 4.

Parameters

value

number

Returns

void

---

om

Get Signature

get om(): ObjectManager;

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

ObjectBase.om

---

range

Get Signature

get range(): number[];

Gets an array of 2 * n numbers [min0 max0, min1 max1, ...] specifying the minimum and maximum valid values of the corresponding color components. These values shall match the information in the ICC profile. Returns null if not set.

Returns

number[]

Set Signature

set range(value): void;

Sets an array of 2 * n numbers [min0 max0, min1 max1, ...] specifying the minimum and maximum valid values of the corresponding color components. These values shall match the information in the ICC profile. Pass null to remove the entry.

Parameters

value

number[]

Returns

void

Methods

create()

static create(data, om?): IccProfile;

Creates an IccProfile from the given ICC profile data. Returns null if the data is invalid or in an unsupported format.

Parameters

data

Uint8Array

The raw ICC profile bytes.

om?

ObjectManager

An optional object manager that controls the lifetime of the object.

Returns

IccProfile

---

free()

free(): void;

Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns

void

Inherited from

ObjectBase.free

---

rebind()

rebind(omTo): void;

Rebinds the object from the current ObjectManager to the specified one.

Parameters

omTo

ObjectManager

The new ObjectManager for the object.

Returns

void

Inherited from

ObjectBase.rebind