Class: Server

PhotoEditorSDK~ Server

The NodeJS Server

new Server()

server/index.js, line 31

Extends

Members

identifierString

A unique string that represents this

Methods

deserialize(data){Promise}

server/index.js, line 73

Deserializes the given data

Name Type Description
data Object
Returns:
Type Description
Promise

dispose()

server/index.js, line 224

Disposes the UI

export(download){Promise}

server/index.js, line 56

Exports an image

Name Type Description
download Boolean

= false

Returns:
Type Description
Promise

getAssetPath(asset, uiAsset, disableRetina){String}

server/index.js, line 184

Returns the resolved asset path for the given asset name

Name Type Default Description
asset String
uiAsset Boolean false

= false

disableRetina Boolean false

= false

Returns:
Type Description
String

getEditor(){PhotoEditorSDK.Server.Editor}

server/index.js, line 81

Returns the editor

Returns:
Type Description
PhotoEditorSDK.Server.Editor

getFontLoader(){PhotoEditorSDK.Server.FontLoader}

server/index.js, line 217

Returns the font loader

Returns:
Type Description
PhotoEditorSDK.Server.FontLoader

render(config){Promise}

server/index.js, line 236

Render image given the configuration

Name Type Description
config Object
Returns:
Type Description
Promise

serialize(){Promise}

server/index.js, line 64

Serializes the editor state

Returns:
Type Description
Promise

setImage(image)

server/index.js, line 173

Sets the image to the given one

Name Type Description
image Image

Type Definitions

EventsObject

Events used by the Server

Properties:
Name Type Description
EXPORT String

Emitted when an image is exported from the editor

OPERATION_CREATED String

Emitted when an Operation is created

OPERATION_UPDATED String

Emitted when an Operation is updated

OPERATION_REMOVED String

Emitted when an Operation is removed