Dial

Type: Dial

Extends View

Script class of the Dial 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 value of the dial.

View Properties

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

Property	Name	Description
`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.
`show_label`	Show Label	Show/hide the label
`show_value`	Show Value	Show/hide the value
`show_selector`	Show Selector	Show/hide the object selector
`show_pgm_button`	Show Program Button	Show/hide the program button for modifier channels.
`user_label`	Label	Overrides the default label
`value`	Value	Sets the value.
`use_extended_limits`	Use Extended Limits	Allow values to be set for extended limits.
`show_extended_limits`	Show Extended Limits	Display extended limit range(s).
`use_custom_limits`	Use Custom Limits	Use custom minimum / maximum for this control only.
`custom_minimum`	Minimum	Custom minimum for this control only.
`custom_maximum`	Maximum	Custom maximum for this control only.
`script`	Script	Edit the button script.
`enable_script`	Enable Script	Enable the script (prevents script overriding direct object connection).
`object`	Object	Enable the script (prevents script overriding direct object connection).

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.
`program()`	For Modifier Channels, the program button will apply the modification to the related Map / Table.

Events

Event Description

Event	Description
`onProgramButton()`	Called in when the Dial 'program' button (of available) is clicked. External scripts can bind to the 'program' event to be notified when this event occurs. view.on("program", function(value) { ... });
`onSetValue(value)`	Called in when the Dial value has changed. External scripts can bind to the 'change' event to be notified when the value changes. view.on("change", function(value) { ... });

onProgramButton()

Called in when the Dial 'program' button (of available) is clicked.

External scripts can bind to the 'program' event to be notified when this event occurs.

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

onSetValue(value)

Called in when the Dial value has changed.

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

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