UXP Toolkit
    Preparing search index...

    Class Guides

    A collections class allowing for array access into a document's guides

    Access this collection through Document.guides property. For example, following adds a new guide to the collection:

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

    app.activeDocument.guides.add(Constants.Direction.HORIZONTAL, 20);

    Hierarchy

    Indexable

    • [index: number]: Guide

      Used to access the guides in the collection.

      23.0

    Index

    Accessors

    length parent

    Methods

    add removeAll

    Accessors

    Methods

    • Adds a guide for the collection at the given coordinate and direction

      Fixes in Photoshop 24.0:

      • Correct coordinate when resolution is not 72 PPI
      • Returns valid instance of guide

      Parameters

      • direction: Direction

        Indicates whether the guide is vertical or horizontal

      • 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.

      Returns Guide

      23.0

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods