Penpot plugins API
    Preparing search index...

    Interface RulerGuide

    Represents a ruler guide. These are horizontal or vertical lines that can be used to position elements in the UI.

    interface RulerGuide {
        orientation: RulerGuideOrientation;
        position: number;
        board?: Board;
        remove(): void;
    }
    Index

    Properties

    Methods

    Properties

    orientation indicates whether the ruler is either horizontal or vertical

    position: number

    position is the position in the axis in absolute coordinates. If this is a board guide it will return the position relative to the board.

    board?: Board

    If the guide is attached to a board this will retrieve the board shape

    Methods

    • Removes the guide from its page.

      Returns void