Protected _insetProtected _limit0Protected _limit1Protected _majorProtected _majorProtected _minorProtected _minorProtected _s2ticksProtected _t01Protected _thumbProtected _thumbProtected _trackThe unique identifier for this control.
This is true if the control can respond to UI events else false.
Use enable() and disable() to enable and disable it.
This is true if the control background is opaque else false.
Use opaque() and transparent() display / hide the background.
This is true if the control is visible else false.
Use hide() and show() to set visibility.
The type name for this control.
(type name = class name without the Cvs prefix)
Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.
this control
is the actual control or its id
Optional rx: numberOptional ry: numberGet or set the corner radii used for this control.
To set the radii the parameters must be one of the following
If no parameter is passed or does not match one of the above then an array of the currently used radii values.
an array of the currently used radii values
Rest ...c: anyvalid radii combination
Disables this control.
this control
Optional cascade: booleanif true disable child controls
Enables this control.
this control
Optional cascade: booleanif true enable child controls
If the turn angle is < 360° then there will be an 'unused' section of track. This is called the gap and this method sets the position of the gap center effectively rotating the whole knob.
The angle is 0° along positive x-axis and increases clockwise. The default value is 90° which means the gap center is facing south.
this control
must be in the range ≥ 0 and ≤ 360
Make this control invisible.
this control
Optional cascade: booleanif true hide children
Checks whether a value is between the lower and upper limits for this control. It allows the user to prevalidate a value before attempting to change the control's value.
true if the value lies within the control's limits else false
value to test
Remove this control from its parent
this control
Sets the interaction mode for rotating the knob.
'x' : dragging left and right turns the knob
anticlockwise and clockwise respectively.'y' : dragging down and up turns the knob
anticlockwise and clockwise respectively.'a' : dragging in a circular motion round the
knob center turns the knob to face the drag point.Rotation is constrained within the maximum turn angle for this knob.
Any other parameter value is ignored and the mode is unchanged.
this control
'x', 'y' or 'a'
Makes the controls background opaque. The actual color depends on the controls color scheme.
The second parameter, alpha, is optional and controls the level of opaqueness from 0 - transparent to 255 - fully opaque (efault value).
this control
alpha value for controls background color.
Sets this controls display orientation to one of the four cardinal compass points. An invalid parameter will set the orientation to 'east' which is the default value.
this control
'north', 'south', 'east' or 'west'
Adds this control to another control which becomes its parent.
this control
is the parental control or its id
Optional rx: numberx position relative to parent
Optional ry: numbery position relative to parent
Remove a child control from this one so that it stays in same screen position.
this control
the control to remove or its id
If the name of a valid color scheme is provided then it will use it to display the control, non-existant scheme names will be ignored. In both cases this control is returned.
If there is no parameter it returns the name of the current color scheme used by this control.
this control or the control's color scheme
Optional name: stringthe color scheme name e.g. 'blue'
Optional cascade: booleanif true propogate scheme to all child controls.
Only applies to modes 'x' and 'y'. It controls how far the knob rotates for a given drag distance.
The drag distance needed to rotate the knob by the maximum turn
angle is the reciprocal of the parameter value i.e. 1.0 / sens.
The default value is 0.005 which equates to a drag distance of 200 pixels and the minimum permitted value is 0.0025 (400 pixels).
this control
≥0.0025
This sets the event handler to be used when this control fires an event. The parameter can take one of three forms:
this control
the function to handle this control's events.
Make this control visible.
this control
Optional cascade: booleanif true show children
Shrink the control to fit contents.
To shrink on one dimension only pass either 'w' (width) or 'h' (height) to indicate which dimmension to shrink
this control
Optional dim: stringthe dimension to shrink
The track can be divided up into a number of domains separated with major ticks. The major domains and be further divided into subdomains separated with minor ticks. If the final parameter is true then values returned by the slider are consrained to the tick values.
this slider object
the number of major domains on the track
the number of minor domains between major ticks
Optional stick2ticks: booleanslider value is constrainged to tick values
Sets the width of the track surrounding the central knob-grip. The value will be constrained so the minimum width is 6 pixels upto the radius of the knob.
The track is used to display current value bar as well as any user specified ticks.
this control
the width of the value track
Makes the controls background fully transparent.
this control
If the parameter value is withing the slider limits it will move the thumb to the appropriate position. If no parameter is passed or is outside the limits this methods returns the current slider value.
the current value or this slider object
Optional value: numberthe selected value to be set
Gets or sets the thickness of the track.
If there is no parameter the currect track thickness is returned. Any other value is constrained to the range ≥ 4 and ≤ 0.1 * control width.
the curent track thickness or this control
the required track thickness)
Generated using TypeDoc
This class represents a turnable knob with a surrounding status track (optional). Three modes are available to rotate the knob.
Major and minor tick marks can be added to the status track and supports stick-to-ticks if wanted.