Interface File

File represents a file in the Penpot application. It includes properties for the file's identifier, name, and revision number.

interface File {
    id: string;
    name: string;
    revn: number;
    pages: Page[];
    export(exportType: "penpot" | "zip", libraryExportType?: "all" | "merge" | "detach"): Promise<Uint8Array>;
    findVersions(criteria?: {
        createdBy: User;
    }): Promise<FileVersion[]>;
    saveVersion(label: string): Promise<FileVersion>;
    getPluginData(key: string): string;
    setPluginData(key: string, value: string): void;
    getPluginDataKeys(): string[];
    getSharedPluginData(namespace: string, key: string): string;
    setSharedPluginData(namespace: string, key: string, value: string): void;
    getSharedPluginDataKeys(namespace: string): string[];
}

Hierarchy (view full)

Properties

id name revn pages

Methods

export findVersions saveVersion getPluginData setPluginData getPluginDataKeys getSharedPluginData setSharedPluginData getSharedPluginDataKeys

Properties

Readonlyid

id: string

The id property is a unique identifier for the file.

name

name: string

The name for the file

revn

revn: number

The revn will change for every document update

pages

pages: Page[]

List all the pages for the current file

Methods

export

  • export(exportType, libraryExportType?): Promise<Uint8Array>

  • Parameters

    • exportType: "penpot" | "zip"
    • OptionallibraryExportType: "all" | "merge" | "detach"

    Returns Promise<Uint8Array>

findVersions

saveVersion

  • saveVersion(label): Promise<FileVersion>

  • Saves the current version into the versions history. Requires the content:write permission.

    Parameters

    • label: string

    Returns Promise<FileVersion>

getPluginData

  • getPluginData(key): string

  • Retrieves the data for our own plugin, given a specific key.

    Parameters

    • key: string

      The key for which to retrieve the data.

    Returns string

    Returns the data associated with the key as a string.

    Example

    const data = shape.getPluginData('exampleKey');
    console.log(data);

setPluginData

  • setPluginData(key, value): void

  • Sets the plugin-specific data for the given key.

    Parameters

    • key: string

      The key for which to set the data.

    • value: string

      The data to set for the key.

    Returns void

    Example

    shape.setPluginData('exampleKey', 'exampleValue');

getPluginDataKeys

  • getPluginDataKeys(): string[]

  • Retrieves all the keys for the plugin-specific data.

    Returns string[]

    Returns an array of strings representing all the keys.

    Example

    const keys = shape.getPluginDataKeys();
    console.log(keys);

getSharedPluginData

  • getSharedPluginData(namespace, key): string

  • If we know the namespace of an external plugin, this is the way to get their data.

    Parameters

    • namespace: string

      The namespace for the shared data.

    • key: string

      The key for which to retrieve the data.

    Returns string

    Returns the shared data associated with the key as a string.

    Example

    const sharedData = shape.getSharedPluginData('exampleNamespace', 'exampleKey');
    console.log(sharedData);

setSharedPluginData

  • setSharedPluginData(namespace, key, value): void

  • Sets the shared plugin-specific data for the given namespace and key.

    Parameters

    • namespace: string

      The namespace for the shared data.

    • key: string

      The key for which to set the data.

    • value: string

      The data to set for the key.

    Returns void

    Example

    shape.setSharedPluginData('exampleNamespace', 'exampleKey', 'exampleValue');

getSharedPluginDataKeys

  • getSharedPluginDataKeys(namespace): string[]

  • Retrieves all the keys for the shared plugin-specific data in the given namespace.

    Parameters

    • namespace: string

      The namespace for the shared data.

    Returns string[]

    Returns an array of strings representing all the keys in the namespace.

    Example

    const sharedKeys = shape.getSharedPluginDataKeys('exampleNamespace');
    console.log(sharedKeys);

Settings

Member Visibility

On This Page

Properties
Methods