Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EditorFunctions

Hierarchy

Index

Properties

close

close: () => void

Closes the PhotoEditor SDK UI and disposes all Engine instance

Type declaration

    • (): void
    • Returns void

deserialize

deserialize: (data: SerialisationSchema) => Promise<void>

Deserializes serialization schema to editor state

param

Type declaration

dispose

dispose: () => void

Disposes the PhotoEditor SDK Engine instance

Type declaration

    • (): void
    • Returns void

export

export: (options?: ExportConfiguration["image"] & { preventExportEvent?: boolean }) => Promise<ExportData>

Exports an image

param
returns

Type declaration

    • (options?: ExportConfiguration["image"] & { preventExportEvent?: boolean }): Promise<ExportData>
    • Parameters

      • Optional options: ExportConfiguration["image"] & { preventExportEvent?: boolean }

      Returns Promise<ExportData>

hasChanges

hasChanges: () => boolean

returns if editor has some changes

Type declaration

    • (): boolean
    • Returns boolean

reset

reset: () => void

Resets the PhotoEditor SDK

Type declaration

    • (): void
    • Returns void

serialize

serialize: (options: { image: boolean }) => Promise<SerialisationSchema>

Serializes current editor state to the serialization schema

param
param

Type declaration

setImage

setImage: (image: string | HTMLImageElement) => Promise<void>

Dynamically sets the image to the ui

param

Type declaration

    • (image: string | HTMLImageElement): Promise<void>
    • Parameters

      • image: string | HTMLImageElement

      Returns Promise<void>