BptImageEditor

API reference for BptImageEditor — parameters, event callbacks, and related configuration.

Home / Documentation / BptImageEditor
Tools

BptImageEditor

Open demo →

Parameters

NameTypeFlagsDescription
BptAppStateBptRootComponentBaseCascadingNullable
CultureStateBptCultureStateCascadingNullable
ImageDataByte[]Nullable
MimeTypestring
WidthstringNullable
HeightstringNullable
CssClassstringNullable
StylestringNullable
FullScreenbool
EnableDrawingToolsbool
EnableTextToolbool
EnableLayersbool
EnableImageAdjustmentsbool
AllowedExportFormatsExportFormat[]
EnableNewbool
EnableImportbool
EnableExportbool
EnableSavebool
EnableLoadbool
EnabledToolsEditorTool[]
SaveBehaviourSaveBehaviour
HostModeEditorHostMode
DisableSaveAsbool
PreloadBptiDataByte[]Nullable
EditorModeEditorMode
PreloadBpttDataByte[]Nullable
BannerTemplateFormatsList<BannerFormatPreset>Nullable
BannerTemplateFormatsModeBannerFormatsMode
GoogleFontsApiKeystringNullable
ChildContentRenderFragmentNullable
EnableImageLibrarybool
ImageLibraryItemsList<ImageLibraryItem>Nullable
AiKeysBptAiVendorKeysNullable

Event callbacks

NameTypeFlagsDescription
OnSaveEventCallback<ImageEditorSaveResult>
OnHostSaveEventCallback<ImageEditorHostSaveResult>
OnExportEventCallback<ImageEditorExportResult>
OnImageChangedEventCallback<Byte[]>
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please reload the page.