Class: Configurable

PhotoEditorSDK. Configurable

Adds set{OptionName} and get{OptionName} methods to an object. Method names are specified via the availableOptions object.

new PhotoEditorSDK.Configurable()

sdk/lib/configurable.js, line 41

Extends

  • EventEmitter

Methods

getDefaultOptions(){Object}

sdk/lib/configurable.js, line 211

Returns a hash with the default options

Returns:
Type Description
Object

getOption(optionName){*}

sdk/lib/configurable.js, line 182

Returns the value for the given option

Name Type Description
optionName String
Returns:
Type Description
*

getOptionDefault(optionName){*}

sdk/lib/configurable.js, line 191

Returns the default value for the given option

Name Type Description
optionName String
Returns:
Type Description
*

getOptions(){Object}

sdk/lib/configurable.js, line 203

Returns the options

Returns:
Type Description
Object

optionsEqual(options){Boolean}

sdk/lib/configurable.js, line 227

Check if the current options equal the given ones

Name Type Description
options Object
Returns:
Type Description
Boolean

serializeOptions(toObject){Object}

sdk/lib/configurable.js, line 307

Returns a serialized version of this configurable

Name Type Default Description
toObject Boolean false

= false
Returns:
Type Description
Object

set(options)

sdk/lib/configurable.js, line 166

Sets the given options

Name Type Description
options Object

setOption(optionName, value, update, initial)

sdk/lib/configurable.js, line 355

Sets the value for the given option, validates it

Name Type Default Description
optionName String
value *
update Boolean true optional

Should an update event be emitted?
initial Boolean false optional

Is this the first time this option is set?

validateSettings(){Promise}

sdk/lib/configurable.js, line 79

Checks whether all required options are specified

Returns:
Type Description
Promise