Class Channel`Abstract`

Represents a channel in a Photoshop document. You can access instances of channels using one of these methods:

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/

Example

// An array of component channels in the document
const componentChannels = app.activeDocument.componentChannels

// An array of active (selected) channels in the document
const activeChannels = app.activeDocument.activeChannels

// Reference a document's Red channel
const redChannel = app.activeDocument.channels[0]

Min Version

23.0

Index

Constructors

constructor

new Channel(): Channel
Returns Channel

Accessors

`Abstract`color

get color(): SolidColor
The color of the channel.

Returns SolidColor
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#color

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:96
set color(color: SolidColor): void
Parameters
- color: SolidColor
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:97

`Abstract`histogram

get histogram(): number[]
A histogram containing the number of pixels at each color intensity level for this channel. The array contains 256 members. The target channel must be visible.

Returns number[]
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#histogram

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:89

kind

get kind(): ChannelType
The type or kind of the channel.

Returns ChannelType
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#kind

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:37
set kind(kind: ChannelType): void
Parameters
- kind: ChannelType
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:38

`Abstract`name

get name(): string
The name of the channel. For component channels this name can be localized.

Fixes in Photoshop 24.6
- For component channel it is no longer converted into lowercase and is same as in UI
- For component channel it will throw an error if channel no longer exist in document
Returns string
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#name

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:79
set name(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:80

`Abstract`opacity

get opacity(): number
The opacity or solidity of the channel.

Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#opacity

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:104
set opacity(opacity: number): void
Parameters
- opacity: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:105

parent

get parent(): Document
The containing document.

Returns Document
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#parent

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:30

visible

get visible(): boolean
The visibility of the channel.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#visible

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:45
set visible(visible: boolean): void
Parameters
- visible: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:46

Methods

duplicate

duplicate(targetDocument?: Document): Promise<void>
Duplicates the channel to the parent document, or a target document if specified.
Parameters
- OptionaltargetDocument: Document
  if specified, duplicate to a different document target.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#duplicate
Example
```
// duplicate the channel
await channel.duplicate()

// duplicate to a different, compatible document
const newDoc = psApp.documents[1]
await channel.duplicate(newDoc)
```
Async
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:68

`Abstract`merge

merge(): Promise<void>
Merges a Spot Color channel into the component channels.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#merge

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:119

`Abstract`remove

remove(): Promise<void>
Deletes the channel.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channel/#remove

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Channel.d.ts:112

Class ChannelAbstract

See

Example

Min Version

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Channel

Accessors

Abstractcolor

Returns SolidColor

See

Min Version

Parameters

Returns void

Abstracthistogram

Returns number[]

See

Min Version

kind

Returns ChannelType

See

Min Version

Parameters

Returns void

Abstractname

Returns string

See

Min Version

Parameters

Returns void

Abstractopacity

Returns number

See

Min Version

Parameters

Returns void

parent

Returns Document

See

Min Version

visible

Returns boolean

See

Min Version

Parameters

Returns void

Methods

duplicate

Parameters

Returns Promise<void>

See

Example

Async

Min Version

Abstractmerge

Returns Promise<void>

See

Min Version

Abstractremove

Returns Promise<void>

See

Min Version

Settings

On This Page

Class Channel`Abstract`

`Abstract`color

`Abstract`histogram

`Abstract`name

`Abstract`opacity

`Abstract`merge

`Abstract`remove