Class: OverlayControls

Extends

• PhotoEditorSDK.UI.DesktopUI.BaseControls

Members

activeIconPathString

The active icon path of this control

canvasControlsComponentReact.Component

The canvas component for these controls

controlsComponentReact.Component

The controls component for these controls

defaultOptionsObject

The default options for this control

Properties:

Name	Type	Argument	Default	Description
overlays	Array.<Object>	<optional>	[]
replaceOverlays	Boolean	<optional>	false
availableOverlays	Array.<String>	<optional>	null

iconPathString

The icon path of this control

identifierString

A unique identifier for these controls

requiredOperationsArray

The operations required for this control to work properly

switchToDefaultControlsOnRemovalBoolean

If true, the editor will switch to the default controls when any of the updatableOperations is removed.

updatableOperationsArray.<String>

Operations which will trigger UI updates on this controls.

Methods

staticPhotoEditorSDK.UI.DesktopUI.Controls.OverlayControls.isEnabled(){Boolean}

ui/desktop-ui/controls/overlay/index.js, line 155

Checks if this control is enabled

Returns:

Type	Description
Boolean

staticPhotoEditorSDK.UI.DesktopUI.Controls.OverlayControls.mapOperationsToSharedState(operations, initial){Object}

ui/desktop-ui/controls/overlay/index.js, line 104

Maps the operations state to a shared state object

Name	Type	Default	Description
operations	Object
initial	Boolean	false	optional

Returns:

Type	Description
Object

loadOverlay(overlay)

ui/desktop-ui/controls/overlay/index.js, line 125

Loads the overlay image and options

Name	Type	Description
overlay	Object