Skip to main content
PESDK/Web/Configuration

Configuration

PhotoEditor SDK for Web can easily be tailored to meet your business needs. Learn how to swiftly create the editor your use-case requires.

You can easily configure the editor to disable specific tools, hide buttons, change components etc. by adding a configuration object to the PhotoEditorSDKUI.

KeyTypeDescription
Key
license
Type
string
Description
A license key that is unique to your product.
Key
image
Type
string or HTMLImageElement
Description
Defines the image that should is initially loaded.
Key
container
Type
Element or Element.id
Description
Defines the element the editor is rendered in.
Key
language
Type
string
Description
Defines the language of the localized strings.
Key
layout
Type
string
Description
Defines the layout that should be used by the editor.
Key
order
Type
string
Description
Defines the position of the ToolControlBar in the AdvancedUI.
Key
theme
Type
string
Description
Defines the theme the SDK is launched in.
Key
assetBaseUrl
Type
string
Description
Definition of the the base URL of all assets required by the SDK.
Key
assetResolver
Type
object
Description
Options to dynamically change the relative or absolute path of a loaded asset.
Key
engine
Type
object
Description
Options to restrict the maximum size of the image.
Key
displayResizeWarning
Type
boolean
Description
Defines if a message is displayed when the image has been scaled down for performance reasons.
Key
displayCloseWarning
Type
boolean
Description
Defines if a message is displayed when PE.SDK is exited with unsaved changes.
Key
displayToolControlBarTitle
Type
boolean
Description
Defines if the title of the tool is displayed in of the ToolControlBar.
Key
displaySerializationModal
Type
boolean
Description
Defines if a serialization modal is displayed while calling Editor.serialize.
Key
enableZoom
Type
boolean
Description
Defines if the user is able to use the zoom feature.
Key
mainCanvasActions
Type
array
Description
Defines the order of buttons in the MainCanvasActionBar.
Key
defaultTool
Type
string
Description
Defines the tool that is initially loaded.
Key
tools
Type
array
Description
Defines which tools are available and their order.
Key
snapping
Type
object
Description
Options to change the snapping behaviour of sprites in the Sticker, Text and Text Design tool.
Key
export
Type
object
Description
Configure the image export.
Key
library
Type
object
Description
Configure the Library tool.
Key
filter
Type
object
Description
Configure the Filter tool.
Key
focus
Type
object
Description
Configure the Focus tool.
Key
adjustment
Type
object
Description
Configure the Adjustment tool.
Key
overlay
Type
object
Description
Configure the Overlay tool.
Key
frame
Type
object
Description
Configure the Frame tool.
Key
sticker
Type
object
Description
Configure the Sticker tool.
Key
text
Type
object
Description
Configure the Text tool.
Key
textdesign
Type
object
Description
Configure the Text design tool.
Key
transform
Type
object
Description
Configure the Transform tool.
Key
custom
Type
object
Description
Options to add a new localization or override existing components.