new Circular(optionsopt)
TK.Circular is a SVG group element containing two paths for displaying numerical values in a circular manner. TK.Circular is able to draw labels, dots and markers and can show a hand. TK.Circular e.g. is implemented by TK.Clock to draw hours, minutes and seconds.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
options |
Object |
<optional> |
{ } | An object containing initial options. |
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.
|
|||||||||||||||||||||
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.dot |
Object |
<optional> |
This option acts as default values for the individual dots
specified in
|
|||||||||||||||||||||
options.dots |
Array.<Object> |
<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.marker |
Object |
<optional> |
This option acts as default values of the individual markers
specified in
|
|||||||||||||||||||||
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.label |
Object |
<optional> |
This option acts as default values for the individual labels
specified in
|
|||||||||||||||||||||
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 |
| Mixes In: | |
| Source: |
Extends
Members
_base :SVGPath
The base of the ring.
Has class toolkit-base
| Source: |
_dots :SVGGroup
A SVG group containing all dots.
Has class toolkit-dots
| Source: |
_hand :SVGRect
The hand of the knob.
Has class toolkit-hand
| Source: |
_labels :SVGGroup
A SVG group containing all labels.
Has class toolkit-labels
| Source: |
_markers :SVGGroup
A SVG group containing all markers.
Has class toolkit-markers
| Source: |
_value :SVGPath
The ring showing the value.
Has class toolkit-value
| Source: |
element :SVGImage
The main SVG element.
Has class toolkit-circular
| Source: |
Methods
add_label(label) → {Object}
Adds a label.
Parameters:
| Name | Type | Description |
|---|---|---|
label |
Object | Number | The label. Please refer to the initial options to learn more about possible values. |
| Source: |
Returns:
label - The interpreted object to build the label from.
- Type
- Object
remove_label(label) → {Object}
Removes a label.
Parameters:
| Name | Type | Description |
|---|---|---|
label |
Object | The label object as returned from |
| Source: |
Returns:
label - The removed label options.
- Type
- Object
Methods inherited from TK.Widget
add_child(child)
Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.
add_children(a)
Registers an array of widgets as children.
all_children()
Returns an array of all children.
enable_draw()
Schedules this widget for drawing.
force_hide()
This is an alias for hide, which may be overloaded. See TK.Container for an example.
force_show()
This is an alias for hide, which may be overloaded. See TK.Container for an example.
get_style()
Returns the computed style of this widgets DOM element.
hidden()
Returns the current hidden status.
hide()
Make the widget hidden. This does not modify the DOM, instead it will stop rendering this widget. Options changed after calling hide will only be rendered (i.e. applied to the DOM) when the widget is made visible again using TK.Widget#show.
remove_child(child)
Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.
remove_children(a)
Removes an array of children.
set(key, value)
Sets an option.
set_style()
Sets a CSS style property in this widgets DOM element.
show()
Make the widget visible. This does not modify the DOM, instead it will only schedule the widget for rendering.
toggle_hidden()
TK.Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.
visible_children()
Returns an array of all visible children.
widgetize()
Set the DOM elements of this widgets. This method is usually only used internally. Basically it means to add the id from options and set a basic CSS class. If delegate is true, basic events will be delegated from the element to the widget instance if classify is true, CSS functions will be bound to the widget instance.
Methods inherited from TK.Base
add_event(event, func, prevent, stop)
Register an event handler.
add_events(events, func)
Add multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.
delegate_events(element) → {HTMLElement}
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.
destroy()
Destroys all event handlers and the options object.
fire_event(event, …args)
Fires an event.
fire_events(events)
Fires several events.
get(key)
Get the value of an option.
has_event_listeners(event) → {boolean}
Test if the event descriptor has some handler functions in the queue.
remove_event(event, fun)
Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.
remove_events(events, func)
Remove multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.
set_options(optionsopt)
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 as event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.
userset(key, value)
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.
Events
dotsdrawn
Is fired when dots are (re)drawn.
| Source: |
labelsdrawn
Is fired when labels are (re)drawn.
| Source: |
markersdrawn
Is fired when markers are (re)drawn.
| Source: |
Events inherited from TK.Widget
GenericDOMEvents
Generic DOM events. Please refer to W3Schools for further details.
classified
Is fired when a widget is classified.
destroy
Is fired when a widget is destroyed.
doubleclick
Is fired after a double click appeared. Set dblclick to 0 to
disable click event handling.
hide
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 TK.Pager.
initialized
Is fired when a widget is initialized.
redraw
Is fired when a redraw is executed.
resize
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 TK.Widget#resized event can
be used, instead.
resized
The resized event is emitted after each rendering frame, which was triggered by
a resize event.
set
The set event is emitted when an option was set using the TK.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.
show
The show event is emitted when a widget is shown and is being rendered. This is the
counterpart to TK.Widget#hide.
stylized
Is fired when a widget is stylized.
visibility
Is fired when the visibility state changes. The first argument
is the visibility state, which is either true
or false.
widgetize
Is fired when a widget is widgetized.
Events inherited from TK.Base
delegated
Is fired when an element is delegated.
set_[option]
Is fired when an option is set.