Class Guide

Represents a single guide in the document.

See

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

Example

// Create a vertical guide at 100px
const doc = app.activeDocument;
const guide = doc.guides.add(constants.Direction.VERTICAL, 100);

Example

// Access existing guides
const doc = app.activeDocument;
const firstGuide = doc.guides[0];
console.log(`Guide at ${firstGuide.coordinate}px, direction: ${firstGuide.direction}`);

Min Version

23.0

Index

Accessors

coordinate direction docId id parent typename

Methods

delete

Accessors

coordinate

get coordinate(): number
Position of the guide measured from the ruler origin in pixels. The value can be a decimal.

Note: the user can move the ruler origin which will affect the position value of the guides.

Fixes in Photoshop 24.0:
- Return correct value when resolution is not 72 PPI
Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guide/#coordinate

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Guide.d.ts:78
set coordinate(coordinate: number): void
Position of the guide measured from the ruler origin in pixels. The value can be a decimal.

Note: the user can move the ruler origin which will affect the position value of the guides.

Fixes in Photoshop 24.0:
- Sets correct value when resolution is not 72 PPI
Parameters
- coordinate: number
Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guide/#coordinate
- Defined in packages/types-photoshop/src/internal/dom/Guide.d.ts:89

direction

get direction(): Direction
Indicates whether the guide is vertical or horizontal.

Returns Direction
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guide/#direction

Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Guide.d.ts:65
set direction(direction: Direction): void
Parameters
- direction: Direction
Returns void
- Defined in packages/types-photoshop/src/internal/dom/Guide.d.ts:66

docId

get docId(): number
The ID of the document of this guide.

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

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

id

get id(): number
For use with batchPlay operations. This guide ID, along with its document ID can be used to represent this guide for the lifetime of this document or the guide.

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

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

parent

get parent(): Document
Owner document of this guide.

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

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

typename

get typename(): "Guide"
The class name of the referenced object: "Guide".

Returns "Guide"
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guide/#typename

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

Methods

delete

delete(): void
Deletes the guide from the document.

Returns void
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guide/#delete
Example
```
// Delete all guides in the document
const doc = app.activeDocument;
doc.guides.forEach(guide => guide.delete());
```
Min Version
23.0
- Defined in packages/types-photoshop/src/internal/dom/Guide.d.ts:104

Class Guide

See

Example

Example

Min Version

Index

Accessors

Methods

Accessors

coordinate

Returns number

See

Min Version

Parameters

Returns void

See

direction

Returns Direction

See

Min Version

Parameters

Returns void

docId

Returns number

See

Min Version

id

Returns number

See

Min Version

parent

Returns Document

See

Min Version

typename

Returns "Guide"

See

Min Version

Methods

delete

Returns void

See

Example

Min Version

Settings

On This Page