Class: Control

Members

staticPhotoEditorSDK.UI.ReactUI.Control.canvasControlsComponentPhotoEditorSDK.UI.ReactUI.ControlsComponent

This control's canvas component. Used for the upper controls part of the editor (on top of the canvas)

staticPhotoEditorSDK.UI.ReactUI.Control.controlsComponentPhotoEditorSDK.UI.ReactUI.ControlsComponent

This control's controls component. Used for the lower controls part of the editor.

staticPhotoEditorSDK.UI.ReactUI.Control.defaultOptionsObject

The default options for this control

staticPhotoEditorSDK.UI.ReactUI.Control.iconPathString

This control's icon path

staticPhotoEditorSDK.UI.ReactUI.Control.identifierString

This control's identifier

staticPhotoEditorSDK.UI.ReactUI.Control.languageKeyString

The language key that should be used when displaying this filter

staticPhotoEditorSDK.UI.ReactUI.Control.topBarControlsComponentPhotoEditorSDK.UI.ReactUI.TopBarControlsComponent

This control's top bar component. Used for the upper part of the editor.

Methods

staticPhotoEditorSDK.UI.ReactUI.Control.getPreloadAssets(editor){Array.<String>}

ui/react-ui/components/controls/controls.js, line 68

Returns the assets that should be preloaded for this control

Name	Type	Description
editor	PhotoEditorSDK.UI.ReactUI.Editor

Returns:

Type	Description
Array.<String>

getGlobalToolState(){Object}

ui/react-ui/components/controls/controls.js, line 38

Returns the global editor state data for this tool.

Returns:

Type	Description
Object

getInitialSharedState(editor, additionalState){Object}

ui/react-ui/components/controls/controls.js, line 29

Returns the initial shared state for this control

Name	Type	Description
editor	PhotoEditorSDK.UI.ReactUI.Editor
additionalState	Object	= {}

Returns:

Type	Description
Object

isAvailable(editor){Boolean}

ui/react-ui/components/controls/controls.js, line 59

Checks if this control is available to the user

Name	Type	Description
editor	PhotoEditorSDK.UI.ReactUI.Editor

Returns:

Type	Description
Boolean

setGlobalToolState(){Object}

ui/react-ui/components/controls/controls.js, line 48

Sets the global editor state data for this tool.

Returns:

Type	Description
Object