new Circular(optionsopt)
- Source:
- Mixes In:
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options.value |
Number |
<optional> |
0
|
Sets the value on the hand and on the ring at the same time. |
||||||||||||||||||||
options.value_hand |
Number |
<optional> |
0
|
Sets the value on the hand. |
||||||||||||||||||||
options.value_ring |
Number |
<optional> |
0
|
Sets the value on the ring. |
||||||||||||||||||||
options.size |
Number |
<optional> |
100
|
The diameter of the circle. This is the base value for all following layout-related parameters. Keeping it set to 100 offers percentual lenghts. Set the final size of the widget via CSS. |
||||||||||||||||||||
options.thickness |
Number |
<optional> |
3
|
The thickness of the circle. |
||||||||||||||||||||
options.margin |
Number |
<optional> |
0
|
The margin between base and value circles. |
||||||||||||||||||||
options.show_hand |
Boolean |
<optional> |
true
|
Draw the hand. |
||||||||||||||||||||
options.hand |
Object |
<optional> |
Dimensions of the hand. Properties
|
|||||||||||||||||||||
options.start |
Number |
<optional> |
135
|
The starting point in degrees. |
||||||||||||||||||||
options.angle |
Number |
<optional> |
270
|
The maximum degree of the rotation when
|
||||||||||||||||||||
options.base |
Number | Boolean |
<optional> |
false
|
If a base value is set in degrees, circular starts drawing elements from this position. |
||||||||||||||||||||
options.show_base |
Boolean |
<optional> |
true
|
Draw the base ring. |
||||||||||||||||||||
options.show_value |
Boolean |
<optional> |
true
|
Draw the value ring. |
||||||||||||||||||||
options.x |
Number |
<optional> |
0
|
Horizontal displacement of the circle. |
||||||||||||||||||||
options.y |
Number |
<optional> |
0
|
Vertical displacement of the circle. |
||||||||||||||||||||
options.show_dots |
Boolean |
<optional> |
true
|
Show/hide all dots. |
||||||||||||||||||||
options.dots_defaults |
Object |
<optional> |
This option acts as default values for the individual dots
specified in Properties
|
|||||||||||||||||||||
options.dots |
Array.<(Object|Number)> |
<optional> |
[]
|
An array of objects describing where dots should be placed
along the circle. Members are position |
||||||||||||||||||||
options.show_markers |
Boolean |
<optional> |
true
|
Show/hide all markers. |
||||||||||||||||||||
options.markers_defaults |
Object |
<optional> |
This option acts as default values of the individual markers
specified in Properties
|
|||||||||||||||||||||
options.markers |
Array.<Object> |
<optional> |
[]
|
An array containing objects which describe where markers
are to be places. Members are the position as |
||||||||||||||||||||
options.show_labels |
Boolean |
<optional> |
true
|
Show/hide all labels. |
||||||||||||||||||||
options.labels_defaults |
Object |
<optional> |
This option acts as default values for the individual labels
specified in Properties
|
|||||||||||||||||||||
options.labels |
Array.<Object> |
<optional> |
[]
|
An array containing objects which describe labels
to be displayed. Either a value or an object whose members are the position |
||||||||||||||||||||
options.title |
String |
<optional> |
""
|
A string to be set as title attribute on the main element to be displayed as tooltip. (Defined in Widget) |
||||||||||||||||||||
options.disabled |
Boolean |
<optional> |
false
|
Toggles the class |
||||||||||||||||||||
options.active |
Boolean |
<optional> |
Toggles the class |
|||||||||||||||||||||
options.visible |
Boolean |
<optional> |
Toggles the class |
|||||||||||||||||||||
options.needs_resize |
Boolean |
<optional> |
true
|
Set to true if the resize function shall be called before the next redraw. (Defined in Widget) |
||||||||||||||||||||
options.dblclick |
Boolean |
<optional> |
400
|
Set a time in milliseconds for triggering double click event. If 0, no double click events are fired. (Defined in Widget) |
||||||||||||||||||||
options.preset |
String |
<optional> |
Set a preset. This string
gets set as class attribute |
|||||||||||||||||||||
options.presets |
Object |
<optional> |
{}
|
An object with available preset
specific options. Refer to |
||||||||||||||||||||
options.notransitions_duration |
number |
<optional> |
500
|
A time in milliseconds until transitions are activated. (Defined in Widget) |
||||||||||||||||||||
options.scale |
String | Array.<Number> | function |
<optional> |
"linear"
|
The type of the scale. Either one of |
||||||||||||||||||||
options.reverse |
Boolean |
<optional> |
false
|
Reverse the scale of the range. (Defined in Ranged) |
||||||||||||||||||||
options.basis |
Number |
<optional> |
1
|
The size of the linear scale. Set to pixel width or height if used for drawing purposes or to 100 for percentages. (Defined in Ranged) |
||||||||||||||||||||
options.clip |
Boolean |
<optional> |
true
|
If true, snap() will clip values into the interval between min and max. (Defined in Ranged) |
||||||||||||||||||||
options.min |
Number |
<optional> |
0
|
Minimum value of the range. (Defined in Ranged) |
||||||||||||||||||||
options.max |
Number |
<optional> |
1
|
Maximum value of the range. (Defined in Ranged) |
||||||||||||||||||||
options.log_factor |
Number |
<optional> |
1
|
Used to overexpand logarithmic curves. 1 keeps the natural curve while values above 1 will overbend. (Defined in Ranged) |
||||||||||||||||||||
options.snap |
Number | Array.<number> |
<optional> |
0
|
Defines a virtual grid.
If |
||||||||||||||||||||
options.step |
Number |
<optional> |
0
|
Step size. Used for instance by ScrollValue as the step size. (Defined in Ranged) |
||||||||||||||||||||
options.shift_up |
Number |
<optional> |
4
|
Multiplier for increased stepping speed, e.g. used by ScrollValue when simultaneously pressing 'shift'. (Defined in Ranged) |
||||||||||||||||||||
options.shift_down |
Number |
<optional> |
0.25
|
Multiplier for decreased stepping speed, e.g. used by ScrollValue when simultaneously pressing 'shift' and 'ctrl'. (Defined in Ranged) |
Circular is a SVG group element containing two paths for displaying numerical values in a circular manner. Circular is able to draw labels, dots and markers and can show a hand. Circular e.g. is implemented by Clock to draw hours, minutes and seconds.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. |
Extends
Members
_base :SVGPath
- Source:
The base of the ring.
Has class .aux-base
Type:
- SVGPath
_dots :SVGGroup
- Source:
A group containing all dots.
Has class .aux-dots
Type:
- SVGGroup
_hand :SVGRect
- Source:
The hand of the knob.
Has class .aux-hand
Type:
- SVGRect
_labels :SVGGroup
- Source:
A group containing all labels.
Has class .aux-labels
Type:
- SVGGroup
_markers :SVGGroup
- Source:
A group containing all markers.
Has class .aux-markers
Type:
- SVGGroup
_value :SVGPath
- Source:
The ring showing the value.
Has class .aux-value
Type:
- SVGPath
element :SVGImage
- Source:
The main SVG element.
Has class .aux-circular
Type:
- SVGImage
Methods
addChild(child)
- Source:
- Inherited From:
- See:
Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.
Parameters:
Name | Type | Description |
---|---|---|
child |
Widget | The child to add. |
Fires:
- Widget#event:child_added
addChildren(a)
- Source:
- Inherited From:
Registers an array of widgets as children.
Parameters:
Name | Type | Description |
---|---|---|
a |
Array.<Widget> | An array of Widgets. |
addEventListener(event, func)
- Source:
- Inherited From:
Register an event handler.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event descriptor. |
func |
function | The function to call when the event happens. |
addLabel(label) → {Object}
- Source:
Adds a label.
Parameters:
Name | Type | Description |
---|---|---|
label |
Object | Number | The label. Please refer to the |
Returns:
label - The interpreted object to build the label from.
- Type
- Object
allChildren()
- Source:
- Inherited From:
Returns an array of all children.
appendChild(child)
- Source:
- Inherited From:
Appends child.element
to the widget element and
registers child
as a child widget.
Parameters:
Name | Type | Description |
---|---|---|
child |
Widget | The child widget to append. |
appendChildren(children)
- Source:
- Inherited From:
Calls Widget#appendChild for an array of widgets.
Parameters:
Name | Type | Description |
---|---|---|
children |
Array.<Widget> | The child widgets to append. |
delegateEvents(element) → {HTMLElement}
- Source:
- Inherited From:
Delegates all occuring DOM events of a specific DOM node to the widget. This way the widget fires e.g. a click event if someone clicks on the given DOM node.
Parameters:
Name | Type | Description |
---|---|---|
element |
HTMLElement | The element all native events of the widget should be bound to. |
Fires:
Returns:
The element
- Type
- HTMLElement
destroy()
- Source:
- Inherited From:
Destroys all event handlers and the options object.
disableTansitions()
- Source:
- Inherited From:
Disable CSS transitions.
dispatchEvent(event, …args)
- Source:
- Inherited From:
Fires an event.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
event |
string | The event descriptor. |
|
args |
* |
<repeatable> |
Event arguments. |
enableDraw()
- Source:
- Overrides:
Schedules this widget for drawing.
Fires:
enableDrawChildren()
- Source:
- Inherited From:
Enables rendering for all children of this widget.
enableTransitions()
- Source:
- Inherited From:
Enable CSS transitions.
forceHide()
- Source:
- Inherited From:
Hide the widget immediately by applying the class aux-hide
.
Does not call disableDraw().
forceShow()
- Source:
- Inherited From:
Show the widget immediately by applying the class aux-show
.
Does not call enableDraw().
get(key)
- Source:
- Inherited From:
Get the value of an option.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
getDefault()
- Source:
- Inherited From:
Returns the default value of a given option. If the option does not exist, an exception is thrown.
getOptionType()
- Source:
- Inherited From:
Returns the type of an option. If the given option does not exist, 'undefined' is returned.
getStyle()
- Source:
- Inherited From:
Returns the computed style of this widget's DOM element.
hasEventListeners(event) → {boolean}
- Source:
- Inherited From:
Test if the event descriptor has some handler functions in the queue.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event desriptor. |
Returns:
True if the event has some handler functions in the queue, false if not.
- Type
- boolean
hidden()
- Source:
- Inherited From:
Returns the current hidden status.
hide()
- Source:
- Inherited From:
Hide the widget. This will result in the class aux-hide
being applied to this widget in the next rendering step.
off(event, fun)
- Source:
- Inherited From:
Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event descriptor. |
fun |
function | The function to remove. |
removeChild(child)
- Source:
- Inherited From:
Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.
Parameters:
Name | Type | Description |
---|---|---|
child |
Widget | The child to remove. |
Fires:
- Widget#event:child_removed
removeChildren(a)
- Source:
- Inherited From:
Removes an array of children.
Parameters:
Name | Type | Description |
---|---|---|
a |
Array.<Widget> | An array of Widgets. |
removeLabel(label) → {Object}
- Source:
Removes a label.
Parameters:
Name | Type | Description |
---|---|---|
label |
Object | The label object as returned from |
Returns:
label - The removed label object.
- Type
- Object
reset(key)
- Source:
- Inherited From:
Resets an option to its default value.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
set(key, value)
- Source:
- Inherited From:
Sets an option.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
value |
The option value. |
setOptions(optionsopt)
- Source:
- Inherited From:
Merges a new options object into the existing one, including deep copies of objects. If an option key begins with the string "on" it is considered an event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. |
setStyle()
- Source:
- Inherited From:
Sets a CSS style property in this widget's DOM element.
show()
- Source:
- Inherited From:
Make the widget visible. This will apply the class aux-show
during the next rendering step.
toggleHidden()
- Source:
- Inherited From:
Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.
update(key, value)
- Source:
- Inherited From:
Conditionally sets an option unless it already has the requested value.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The name of the option. |
value |
mixed | The value of the option. |
Fires:
userset(key, value)
- Source:
- Inherited From:
Sets an option by user interaction. Emits the userset
event. The userset
event can be cancelled (if an event handler
returns false
), in which case the option is not set.
Returns true
if the option was set, false
otherwise. If the option was set, it will emit a useraction
event.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The name of the option. |
value |
mixed | The value of the option. |
Fires:
- Base#event:userset
- Base#event:useraction
visibleChildren()
- Source:
- Inherited From:
Returns an array of all visible children.
Events
delegated
- Source:
- Inherited From:
Is fired when an element is delegated.
Parameters:
Name | Type | Description |
---|---|---|
element |
HTMLElement | Array | The element which receives all native DOM events. |
old_element |
HTMLElement | Array | The element which previously received all native DOM events. |
destroy
- Source:
- Inherited From:
Is fired when a widget is destroyed.
dotsdrawn
- Source:
Is fired when dots are (re)drawn.
doubleclick
- Source:
- Inherited From:
Is fired after a double click appeared. Set dblclick
to 0 to
disable click event handling.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The browsers |
GenericDOMEvents
- Source:
- Inherited From:
Generic DOM events. Please refer to W3Schools for further details.
hide
- Source:
- Inherited From:
The hide
event is emitted when a widget is hidden and is not rendered anymore.
This happens both with browser visibility changes and also internally when using layout widgets
such as Pager.
initialized
- Source:
- Inherited From:
Is fired when a widget is initialized.
labelsdrawn
- Source:
Is fired when labels are (re)drawn.
markersdrawn
- Source:
Is fired when markers are (re)drawn.
redraw
- Source:
- Inherited From:
The redraw
event is emitted when a widget is redrawn. This can be used
to do additional DOM modifications to a Widget.
resize
- Source:
- Inherited From:
The resize
event is emitted whenever a widget is being resized. This event can
be used to e.g. measure its new size. Note that some widgets do internal adjustments after
the resize
event. If that is relevant, the Widget#resized event can
be used instead.
resized
- Source:
- Inherited From:
The resized
event is emitted after each rendering frame, which was triggered by
a resize event.
set
- Source:
- Inherited From:
The set
event is emitted when an option was set using the Widget#set
method. The arguments are the option name and its new value.
Note that this happens both for user interaction and programmatical option changes.
set_[option]
- Source:
- Inherited From:
Is fired when an option is set.
Parameters:
Name | Type | Description |
---|---|---|
value |
mixed | The value of the option. |
show
- Source:
- Inherited From:
The show
event is emitted when a widget is shown and is being rendered. This is the
counterpart to Widget#hide.
visibility
- Source:
- Inherited From:
Is fired when the visibility state changes. The first argument
is the visibility state, which is either true
or false
.