Photopea

https://www.photopea.com/learn
Admin
Photopea is an advanced, web-based image editor for raster and vector graphics. It runs offline in...
Tokens:852
Snippets:3
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Photopea Application (App) API

Source: https://www.photopea.com/learn/scripts

This section details the Photopea `App` object's extended functionalities, allowing interaction with external URLs, the outer environment, UI elements, and specific Photopea windows. These methods provide ways to integrate Photopea's capabilities with external systems or automate UI actions.

```APIDOC
App.open(url, as, asSmart)
  - Loads an image from a URL.
  - Parameters:
    - url: The URL of the image.
    - as: Ignored.
    - asSmart: Set to true to paste the image into the current document as a smart object.

App.echoToOE(string)
  - Sends a string to an outer environment (See Live Messaging API).
  - Parameters:
    - string: The string to send.

App.showWindow(string)
  - Shows a specific Photopea window.
  - Parameters:
    - string: The identifier for the window (e.g., "magiccut" for Magic Cut, "vbitmap" for Vectorize Bitmap).

App.UI
  - Provides methods to modify the "viewing state" of the Photopea UI.
  - Methods:
    - zoomIn(): Zooms in the current view.
    - zoomOut(): Zooms out the current view.
    - fitTheArea(): Fits the document to the current viewing area.
    - pixelToPixel(): Sets the zoom to 1:1 pixel ratio.
    - switchFullscreen(): Toggles fullscreen mode.
    - scroll(dx, dy): Scrolls the view by the specified delta.
    - scrollTo(x, y): Scrolls the view to the specified coordinates.
```

--------------------------------

### Photopea Layer and TextItem API Extensions

Source: https://www.photopea.com/learn/scripts

This section details Photopea's extensions to the Layer and TextItem objects, providing additional properties for querying layer selection status and accessing text style and transformation data.

```APIDOC
Layer.selected
  - Type: Boolean (read only)
  - Description: Indicates whether the layer is currently selected ("highlighted").

TextItem.totalTextStyle
  - Type: String (JSON object)
  - Description: A JSON object containing all style parameters of the text.

TextItem.transform
  - Type: String (JSON array)
  - Description: A JSON array representing the affine transform matrix of the text.
```

--------------------------------

### Photopea Document API Extensions

Source: https://www.photopea.com/learn/scripts

This section describes Photopea's extensions to the standard Document object, providing additional properties for identification and naming, and methods for exporting documents to an outer environment with various format options, as well as clearing the document's history.

```APIDOC
Document.source
  - Type: String (read / write)
  - Description: A string that identifies the document. Initially, it is the URL for files loaded from a server, or "local,X,NAME" for other files.

Document.name
  - Type: String (read / write)
  - Description: A string to be displayed as a "label" of a document. Setting the name does not add a step into History.

Document.saveToOE(formatString)
  - Converts the document into a binary file and sends the file to an outer environment (See Live Messaging API).
  - Parameters:
    - formatString: A string specifying the export format and optional parameters.
      - Examples:
        - "png": Exports as PNG.
        - "jpg:0.8": Exports as JPG with 80% quality (quality 0 to 1).
        - "webp:0.6": Exports as WEBP with 60% quality (quality 0 to 1).
        - "psd:true": Produces a minified PSD file.
        - "svg:true,false,...": Exports as SVG with parameters corresponding to the SVG export options in Photopea.

Document.clearHistory()
  - Clears the history of editing of a document. This action should lead to releasing some RAM memory.
```
Tokens:
Raw