Class: FocusControls

PhotoEditorSDK.UI~DesktopUI.Controls. FocusControls

The Controls for the Focus tool.

new PhotoEditorSDK.UI.DesktopUI.Controls.FocusControls()

ui/desktop-ui/controls/focus/index.js, line 28

Extends

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
availableModes Array.<String> <optional>
 null
highQualityCanvasBlur Boolean <optional>
 false

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.FocusControls.getItemByIdentifier(identifier)

ui/desktop-ui/controls/focus/index.js, line 261

Gets the focus item by it's identifier

Name Type Description
identifier string

staticPhotoEditorSDK.UI.DesktopUI.Controls.FocusControls.getItemByOperationIdentifier(identifier)

ui/desktop-ui/controls/focus/index.js, line 270

Gets the focus item by it's identifier

Name Type Description
identifier string

staticPhotoEditorSDK.UI.DesktopUI.Controls.FocusControls.getPreloadAssets(editor){Array.<String>}

ui/desktop-ui/controls/focus/index.js, line 239

Returns the assets that should be preloaded for this control

Name Type Description
editor PhotoEditorSDK.UI.DesktopUI.Editor
Returns:
Type Description
Array.<String>

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

ui/desktop-ui/controls/focus/index.js, line 252

Checks if this control is enabled

Returns:
Type Description
Boolean

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

ui/desktop-ui/controls/focus/index.js, line 134

Maps the operations state to a shared state object

Name Type Default Description
operations Object
initial Boolean false optional
Returns:
Type Description
Object