Class: BrushControls

PhotoEditorSDK.UI~DesktopUI.Controls~ BrushControls

The Controls for the Brush tool.

new BrushControls()

ui/desktop-ui/controls/brush/index.js, line 31

Extends

Members

activeIconPathString

The active icon path of this control

canvasControlsComponentReact.Component

The canvas controls 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
brushes Array.<Object> <optional>
 []
replaceBrushes Boolean <optional>
 false
availableBrushes 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.BrushControls.isEnabled(){Boolean}

ui/desktop-ui/controls/brush/index.js, line 213

Checks if this control is enabled

Returns:
Type Description
Boolean

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

ui/desktop-ui/controls/brush/index.js, line 111

Maps the operations state to a shared state object

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