new PhotoEditorSDK.UI.ReactUI(options, provider)
Creates an UI instance
Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
provider |
PhotoEditorSDK.UI.ReactUI.PhotoRoll.Provider |
The class providing all data for the photo roll |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options.preloader |
Boolean | true |
optional
Enables the preloader |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options.editor |
Object |
optional
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
options.assets |
Object |
optional
|
Extends
Classes
Namespaces
Members
-
identifierString
-
A unique string that represents this UI
Methods
-
deserialize(data){Promise}
react-ui/ui.js, line 185 -
Deserializes the given data
Name Type Description data
Object Returns:
Type Description Promise -
dispose()
react-ui/ui.js, line 440 -
Disposes the UI
-
export(download){Promise}
react-ui/ui.js, line 168 -
Exports an image
Name Type Description download
Boolean = false
Returns:
Type Description Promise -
getAssetPath(asset, uiAsset, disableRetina){String}
react-ui/ui.js, line 400 -
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.UI.ReactUI.Editor}
react-ui/ui.js, line 193 -
Returns the editor
Returns:
Type Description PhotoEditorSDK.UI.ReactUI.Editor -
getFontLoader(){FontLoader}
react-ui/ui.js, line 433 -
Returns the font loader
Returns:
Type Description FontLoader -
serialize(){Promise}
react-ui/ui.js, line 176 -
Serializes the editor state
Returns:
Type Description Promise -
setImage(image)
react-ui/ui.js, line 388 -
Sets the image to the given one
Name Type Description image
Image -
translate(key, interpolationOptions){String}
react-ui/ui.js, line 380 -
Returns the translation for
key
Name Type Description key
String interpolationOptions
Object optional Returns:
Type Description String
Events
-
controls:switched
react-ui/ui.js, line 483 -
Controls switched event
Type:
-
export
react-ui/ui.js, line 456 -
Export event
Type:
- Image | String | Blob
-
history:undo
react-ui/ui.js, line 477 -
History undo event
-
operation:created
react-ui/ui.js, line 463 -
Operation created event
Type:
-
operation:removed
react-ui/ui.js, line 470 -
Operation removed event
Type: