OptionEditor

Type: OptionEditor

Extends View

Script class of the Number Edit view.

Properties

Property	Description
	Since version 4.04.23, Named properties may be accessed directly instead of requiring getViewProperty / setViewProperty. The property ID may be identified in the Properties view.
`enabled`	Enables/disables the view.
`value`	Get/Set the (real) value of the OptionEditor.

View Properties

Properties defined by the view that are normally editable via properties editor.

Property	Name	Description
`object`	Object	Enable the script (prevents script overriding direct object connection).
`title`	Title	The title of the window.
`id`	Script ID	The scripting ID of the window. Can be used as an alternative to the title for searching for windows from scripts.
`tooltip`	Tool Tip	Window tool tip.
`font_size`	Font Size	Size of the text.
`stretch`	Stretch	Stretch to fill view
`show_dial`	Show Dial	Show dial control on applicable views
`show_spin_buttons`	Show Spin Buttons	Show spin buttons on applicable views
`show_checkbox`	Show Checkbox	Makes the control a checkbox instead of a drop-down for appropriate objects
`checkbox_label`	Checkbox Label	Override the checkbox label. Uses the object name if blank.
`show_units`	Show Units	Display units next to the editor

Methods

Method	Description
`callListener(eventName, [args])`	Calls all event listeners for the given event name, useful for testing.
`getParent()`	Get the parent window/view (if any) of this view.
`getViewProperties()`	Returns an array of objects containing the view properties. Each element has the fields 'name', 'id', 'value', 'hint'. If the property is a category then it will also have an array field 'properties'. These properties are the ones normally editable via the properties view.
`getViewProperty(id)`	Gets a property value from the view, given the property ID. Property IDs can be listed using getViewProperties. These properties are the ones normally editable via the properties view.
`on(eventName, callback)`	Adds an event listener for the given event name. e.g. view.on("click", function() { ... });
`pxFromDimension(dimension)`	Convert a dimension string (e.g. "10em", "50dp", "100px") into pixel units, relative to the view object. Returns the size in pixels.
`removeAllListeners([eventName])`	Removes all event listeners for the given event name. If the event name is not given then all listeners for all events are removed.
`removeListener(eventName, callback)`	Removes an event listener for the given event name. e.g. let callback = function() { ... }; view.on("click", callback); view.removeListener("click", callback);
`setViewProperty(id, value)`	Sets a property on the view, given the property ID and value. Property IDs can be listed using getViewProperties These properties are the ones normally editable via the properties view.

Events

Event Description

Event	Description
`change(value)`	Called in when the OptionEditor value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... });

change(value)

Called in when the OptionEditor value has changed.

External scripts can bind to the 'change' event to be notified when the value changes.

view.on("change", function(value) { ... });