Class: FilterControls

PhotoEditorSDK.UI~DesktopUI.Controls. FilterControls

The Controls for the Filter tool.

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

ui/desktop-ui/controls/filter/index.js, line 27

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
categories Array.<Object> <optional>
 []
replaceCategories Boolean <optional>
 false
availableFilters 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

updatableOperationsArray.<String>

Operations which will trigger UI updates on this controls.

Methods

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

ui/desktop-ui/controls/filter/index.js, line 100

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.FilterControls.isEnabled(){Boolean}

ui/desktop-ui/controls/filter/index.js, line 91

Checks if this control is enabled

Returns:
Type Description
Boolean

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

ui/desktop-ui/controls/filter/index.js, line 129

Maps the operations state to a shared state object

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