new ResponseHandle(optionsopt)
Class which represents a draggable SVG element, which can be used to represent and change a value inside of a TK.ResponseHandler and is drawn inside of a chart.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ } | An object containing initial options. |
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options.range_x |
function | Object | Callback returning a TK.Range
for the x-axis or an object with options for a TK.Range. This is usually
the |
||
options.range_y |
function | Object | Callback returning a TK.Range
for the y-axis or an object with options for a TK.Range. This is usually
the |
||
options.range_z |
function | Object | Callback returning a TK.Range for the z-axis or an object with options for a TK.Range. |
||
options.mode |
String |
<optional> |
"circular" | Type of the handle. Can be one out of
|
options.x |
Number |
<optional> |
Value of the x-coordinate. |
|
options.y |
Number |
<optional> |
Value of the y-coordinate. |
|
options.z |
Number |
<optional> |
Value of the z-coordinate. |
|
options.min_size |
Number |
<optional> |
24 | Minimum size of the handle in px. |
options.max_size |
Number |
<optional> |
100 | Maximum size of the handle in px. |
options.label |
function | Boolean | Label formatting function. Arguments are
|
||
options.preferences |
Array.<String> |
<optional> |
["left", "top", "right", "bottom"] | Possible label
positions by order of preference. Depending on the selected |
options.margin |
Number |
<optional> |
3 | Margin in px between the handle and the label. |
options.z_handle |
Boolean | String |
<optional> |
false | If not false, a small handle is drawn at the given position ( |
options.z_handle_size |
Number |
<optional> |
6 | Size in px of the z-handle. |
options.z_handle_centered |
Number |
<optional> |
0.1 | Size of the z-handle in center positions. If this options is between 0 and 1, it is interpreted as a ratio, otherwise as a px size. |
options.z_handle_below |
Number |
<optional> |
false | Render the z-handle below the normal handle in the DOM. SVG doesn't know CSS attribute z-index, so this workaround is needed from time to time. |
options.x_min |
Number |
<optional> |
Minimum value of the x-coordinate. |
|
options.x_max |
Number |
<optional> |
Maximum value of the x-coordinate. |
|
options.y_min |
Number |
<optional> |
Minimum value of the y-coordinate. |
|
options.y_max |
Number |
<optional> |
Maximum value of the y-coordinate. |
|
options.z_min |
Number |
<optional> |
Minimum value of the z-coordinate. |
|
options.z_max |
Number |
<optional> |
Maximum value of the z-coordinate. |
|
options.show_axis |
Boolean |
<optional> |
false | If set to true, additional lines are drawn at the coordinate values. |
Mixes In: | |
Source: |
Extends
Members
_handle :SVGCircular
The main handle.
Has class toolkit-handle
.
Source: |
_label :SVGText
The label. Has class toolkit-label
.
Source: |
_line1 :SVGPath
The first line. Has class toolkit-line toolkit-line-1
.
Source: |
_line2 :SVGPath
The second line. Has class toolkit-line toolkit-line-2
.
Source: |
_zhandle :SVGCircular
The handle for manipulating z axis.
Has class toolkit-z-handle
.
Source: |
element :SVGGroup
The main SVG group containing all handle elements. Has class toolkit-response-handle
.
Source: |
range_x :TK.Range
The TK.Range for the x axis.
Source: |
range_y :TK.Range
The TK.Range for the y axis.
Source: |
range_z :TK.Range
The TK.Range for the z axis.
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, 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
handlegrabbed
Is fired when the main handle is grabbed by the user. The argument is an object with the following members:
- x: the actual value on the x axis
- y: the actual value on the y axis
- pos_x: the position in pixels on the x axis
- pos_y: the position in pixels on the y axis
Parameters:
Name | Type | Description |
---|---|---|
positions |
Object | An object containing all relevant positions of the pointer. |
Source: |
handlereleased
Is fired when the user releases the main handle. The argument is an object with the following members:
- x: the actual value on the x axis
- y: the actual value on the y axis
- pos_x: the position in pixels on the x axis
- pos_y: the position in pixels on the y axis
Parameters:
Name | Type | Description |
---|---|---|
positions |
Object | An object containing all relevant positions of the pointer. |
Source: |
useraction
The useraction
event is emitted when a widget gets modified by user interaction.
The event is emitted for the options x
, y
and z
.
Parameters:
Name | Type | Description |
---|---|---|
name |
string | The name of the option which was changed due to the users action. |
value |
mixed | The new value of the option. |
Source: |
zchangeended
Is fired when the user releases the z-handle. The argument is the actual z value.
Parameters:
Name | Type | Description |
---|---|---|
z |
number | The z value. |
Source: |
zchangestarted
Is fired when the user grabs the z-handle. The argument is the actual z value.
Parameters:
Name | Type | Description |
---|---|---|
z |
number | The z value. |
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.