Knob
A circular dial input component that provides an interactive way to select numeric values. Features customizable appearance including thickness, colors, value display options, icon integration, and precise control over minimum or maximum values. Supports both simple value selection and range-based input with inner and outer bounds.
Extends: fieldComponent
Fields
Name | Code | Data Type | Description |
|---|---|---|---|
Size |
| text | Sets the overall size of the knob control |
Thickness |
| text | Controls the thickness of the knob's outer ring |
Color |
| text | Defines the color of the knob's active portion |
Center Color |
| text | Sets the color of the knob's center area |
Track Color |
| text | Defines the color of the knob's inactive track |
Value Classes |
| text | CSS classes to apply to the value display |
Show Value |
| boolean | Controls whether the current value is displayed |
Show Value Percentage |
| boolean | Toggles display of the value as a percentage |
Font Size |
| text | Sets the size of the displayed value text |
Show Icon with Value |
| boolean | Controls whether an icon is shown alongside the value |
Icon |
| text | Specifies the icon to display |
Show Icon after Value |
| boolean | Determines if the icon appears after the value |
Image URL |
| text | URL for an image to display in the knob's center |
Avatar Size |
| text | Size of the avatar image when imageLink is used |
Minimum Value |
| text | Minimum value that can be selected |
Maximum Value |
| text | Maximum value that can be selected |
Inner Minimum Value |
| text | Minimum value for the inner range |
Inner Maximum Value |
| text | Maximum value for the inner range |
Angle |
| text | The angle of rotation for the knob |
Step |
| text | The increment value for each step of rotation |
Label |
| multi-locale | Display label for the knob |
ID |
| text | Unique identifier for the component |
Style Classes |
| text | CSS classes for styling |
Style |
| text | Custom inline styles |
Width |
| text | Controls component width |
Value |
| text | Current value of the knob |
Visible |
| boolean | Controls component visibility |
Enabled |
| boolean | Controls whether component is enabled |
Field Style |
| text | Additional field styling options |
Methods
Name | Description |
|---|---|
| Converts the input value to the knob's internal value representation |
| Converts the knob's internal value to the output value format |
Events
Name | Description |
|---|---|
| Triggered when the knob value changes |
| Triggered when the knob loses focus |
| Triggered when the knob gains focus |