TK.Clock

new Clock(options)

TK.Clock shows a customized clock with circulars displaying hours, minutes and seconds. It has three free formatable labels.

Parameters:
Name Type Description
options Object
Properties:
Name Type Attributes Default Description
options.thickness integer <optional>
10

Thickness of the rings in percent of the maximum dimension.

options.margin integer <optional>
0

Margin between the TK.Circular in percent of the maximum dimension.

options.size integer <optional>
200

Width and height of the widget.

options.show_seconds boolean <optional>
true

Show seconds ring.

options.show_minutes boolean <optional>
true

Show minutes ring.

options.show_hours boolean <optional>
true

Show hours ring.

options.timeout integer <optional>
1000

The timeout of the redraw trigger.

options.timeadd integer <optional>
10

Set additional milliseconds to add to the timeout target system clock regulary.

options.offset integer <optional>
0

If a timeout is set offset the system time in milliseconds.

options.fps integer <optional>
25

Framerate for calculating SMTP frames

options.months Array.<String> <optional>
["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"]

Array containing all months names.

options.days Array.<String> <optional>
["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]

Array containing all days names.

options.label function <optional>
function (_date, year, month, date, day, hour, minute, second, millisecond, frame, months, days) { return ((hour < 10) ? ("0" + hour) : hour) + ":" + ((minute < 10) ? ("0" + minute) : minute) + ":" + ((second < 10) ? ("0" + second) : second);

Callback to format the main label.

options.label_upper function <optional>
function (_date, year, month, date, day, hour, minute, second, millisecond, frame, months, days) { return days[day]; }

Callback to format the upper label.

options.label_lower function <optional>
function (_date, year, month, date, day, hour, minute, second, millisecond, frame, months, days) { return ((date < 10) ? ("0" + date) : date) + ". " + months[month] + " " + year; }

Callback to format the lower label.

options.label_scale number <optional>
0.33

test

options.time Date <optional>
10

test

Source:

Extends

Members

_label :SVGText

The center label showing the time. Has classtoolkit-label

Source:

_label_lower :SVGText

The lower label showing the date. Has classtoolkit-label-lower

Source:

_label_upper :SVGText

The upper label showing the day. Has classtoolkit-label-upper

Source:

circulars :Object

An object holding all three TK.Circular as members seconds, minutes and hours.

Source:

element :HTMLDivElement

The main DIV element. Has class toolkit-clock

Source:

svg :SVGImage

The main SVG image.

Source:

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, func)

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.

Events

timedrawn

Is fired when the time was drawn.

Parameters:
Name Type Description
time Date

The time which was drawn.

Source:

Events inherited from TK.Widget

classified

Is fired when a widget is classified.

destroy

Is fired when a widget is destroyed.

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.

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.