Mercurial > hg > NetworkVis
comparison d3s_examples/python-neo4jrestclient/static/platin/lib/slider/api.html @ 8:18ef6948d689
new d3s examples
author | Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> |
---|---|
date | Thu, 01 Oct 2015 17:17:27 +0200 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
7:45dad9e38c82 | 8:18ef6948d689 |
---|---|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" | |
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> | |
3 | |
4 <html> | |
5 <head> | |
6 <title>Slider API (WebFX)</title> | |
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | |
8 <script type="text/javascript" src="local/webfxlayout.js"></script> | |
9 <script type="text/javascript" src="local/webfxapi.js"></script> | |
10 </head> | |
11 <body> | |
12 <!-- WebFX Layout Include --> | |
13 <script type="text/javascript"> | |
14 | |
15 var articleMenu= new WebFXMenu; | |
16 articleMenu.left = 384; | |
17 articleMenu.top = 86; | |
18 articleMenu.width = 140; | |
19 articleMenu.add(new WebFXMenuItem("Slider", "slider.html")); | |
20 articleMenu.add(new WebFXMenuItem("Implementation", "implementation.html")); | |
21 articleMenu.add(new WebFXMenuItem("API", "api.html")); | |
22 articleMenu.add(new WebFXMenuItem("Demo", "demo.html")); | |
23 articleMenu.add(new WebFXMenuSeparator); | |
24 articleMenu.add(new WebFXMenuItem("Download", "http://webfx.eae.net/download/slider102.zip")); | |
25 webfxMenuBar.add(new WebFXMenuButton("Article Menu", null, null, articleMenu)); | |
26 | |
27 webfxLayout.writeTitle("Slider API"); | |
28 webfxLayout.writeMenu(); | |
29 webfxLayout.writeDesignedByEdger(); | |
30 | |
31 </script> | |
32 <div class="webfx-main-body"> | |
33 <!-- end WebFX Layout Includes --> | |
34 | |
35 | |
36 <!-- | |
37 Generated using api.xsl version 020528 | |
38 --><!-- Start main output --><h2 id="Timer">Timer</h2><p> | |
39 Object Oriented Encapsulation of setTimeout | |
40 </p><h3>Syntax</h3><p><code> | |
41 | |
42 new Timer([<span class="methodArgument">nPauseTime</span>])</code></p><h3>Parameters</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nPauseTime</code></td><td><code>Number</code></td><td><span class="optional">Optional.</span> | |
43 The time (in milliseconds) before the timer should be triggered once started. | |
44 <span class="defaultSentence"> | |
45 The default value is <code>1000</code>. | |
46 </span></td></tr></tbody></table><h3>Static Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td colspan="2">None.</td></tr></tbody></table><h3>Static Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td colspan="3">None.</td></tr></tbody></table><h3>Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getPauseTime</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getPauseTime()</code></p><h4>Arguments</h4><p>No Arguments.</p><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the pause time (in milliseconds) used to wait once started before triggering the event</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">isStarted</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.isStarted()</code></p><h4>Arguments</h4><p>No Arguments.</p><h4>Return Type</h4><p><code>Boolean</code></p></div></div></td><td>Returns whether the timer is started</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setPauseTime</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setPauseTime(<span class="methodArgument">nPauseTime</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nPauseTime</code></td><td><code>Number</code></td><td>The time to pause</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the time (in milliseconds) to pause before triggering the event</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">start</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.start()</code></p><h4>Arguments</h4><p>No Arguments.</p><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Starts the timer</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">stop</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.stop()</code></p><h4>Arguments</h4><p>No Arguments.</p><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Stops the timer if previously started</td></tr></tbody></table><h3>Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td colspan="3">None.</td></tr></tbody></table><h3>Events</h3><table><thead><tr><td>Name</td><td>Descripton</td></tr></thead><tbody><tr><td><code>ontimer</code></td><td>Fires nPauseTime milliseconds after started</td></tr></tbody></table><h3>Remarks</h3><p> | |
47 None. | |
48 </p><h2 id="Range">Range</h2><p> | |
49 Used to model the data used when working with sliders, scrollbars and progress bars. | |
50 Based on the ideas of the javax.swing.BoundedRangeModel interface defined by Sun for Java | |
51 (<a href="http://java.sun.com/products/jfc/swingdoc-api-1.0.3/com/sun/java/swing/BoundedRangeModel.html">http://java.sun.com/products/jfc/swingdoc-api-1.0.3/com/sun/java/swing/BoundedRangeModel.html</a>). | |
52 </p><h3>Syntax</h3><p><code> | |
53 | |
54 new Range()</code></p><h3>Parameters</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td>No parameters.</td></tr></tbody></table><h3>Static Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td colspan="2">None.</td></tr></tbody></table><h3>Static Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td colspan="3">None.</td></tr></tbody></table><h3>Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getExtent</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getExtent()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the extent of the range</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getMaximum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getMaximum()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the maximum allowed value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getMinimum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getMinimum()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the minimum value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getValue</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getValue()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the current value of the range</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setExtent</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setExtent(<span class="methodArgument">nExtent</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nExtent</code></td><td><code>Number</code></td><td>The extent of the value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the extent of the range</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setMaximum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setMaximum(<span class="methodArgument">nMaximum</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nMaximum</code></td><td><code>Number</code></td><td>The maximum value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the maximum allowed value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setMinimum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setMinimum(<span class="methodArgument">nMinimum</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nMinimum</code></td><td><code>Number</code></td><td>The minimum value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the minimum allowed value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setValue</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setValue(<span class="methodArgument">nValue</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nValue</code></td><td><code>Number</code></td><td>The value for the range</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the value for the range</td></tr></tbody></table><h3>Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td colspan="3">None.</td></tr></tbody></table><h3>Events</h3><table><thead><tr><td>Name</td><td>Descripton</td></tr></thead><tbody><tr><td><code>ontimer</code></td><td>Fires on the object nPauseTime milliseconds after started</td></tr></tbody></table><h3>Remarks</h3><p> | |
55 None. | |
56 </p><h2 id="Slider">Slider</h2><p> | |
57 A slider control that allows the user to drag a handle to change the value that | |
58 is limited by a maximum value and a minimum value. | |
59 </p><h3>Syntax</h3><p><code> | |
60 | |
61 new Slider(<span class="methodArgument">oElement</span>, <span class="methodArgument">oInput</span> [, <span class="methodArgument">sOrientation</span>])</code></p><h3>Parameters</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>oElement</code></td><td><code>HTMLElement</code></td><td>The element acting as a slider</td></tr><tr><td><code>oInput</code></td><td><code>HTMLInputElement</code></td><td>The input element used for backward compatibility and posting</td></tr><tr><td><code>sOrientation</code></td><td><code>String</code></td><td><span class="optional">Optional.</span> | |
62 The orientation of the slider. Valid values are "horizontal" and "vertical" | |
63 <span class="defaultSentence"> | |
64 The default value is <code>horizontal</code>. | |
65 </span></td></tr></tbody></table><h3>Static Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td colspan="2">None.</td></tr></tbody></table><h3>Static Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>isSupported</code></td><td><code>Boolean</code></td><td><span class="readOnly">Read only.</span> This value is true if the browser supports dynamic sliders</td></tr></tbody></table><h3>Methods</h3><table><thead><tr><td>Name</td><td>Description</td></tr></thead><tbody><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getBlockIncrement</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getBlockIncrement()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the amount used for large increments</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getMaximum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getMaximum()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the maximum value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getMinimum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getMinimum()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the minimum value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getOrientation</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getOrientation()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>String</code></p></div></div></td><td>Returns the orientation of the slider. Valid values are "horizontal" and | |
66 "vertical".</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getUnitIncrement</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getUnitIncrement()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the amount used to do small increments</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">getValue</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.getValue()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>Number</code></p></div></div></td><td>Returns the value of the slider</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">ontimer</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.ontimer()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Called when the timer used when holding down the mouse button is fired</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">recalculate</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.recalculate()</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td></td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Recalculates the position and size of the sub elements to make ensure the | |
67 layout is correct. Use this message after the slider has been resized.</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setBlockIncrement</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setBlockIncrement(<span class="methodArgument">nBlockIncrement</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nBlockIncrement</code></td><td><code>Number</code></td><td>The block increment value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the amounf to increment the value for large increments. This value is | |
68 used when using the page up and page down keys to change the value as well as when | |
69 holding down the mouse on the slider (but not dragging the handle).</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setMaximum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setMaximum(<span class="methodArgument">nMaximum</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nMaximum</code></td><td><code>Number</code></td><td>The maximum value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the maximum allowed value for the slider</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setMinimum</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setMinimum(<span class="methodArgument">nMinimum</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nMinimum</code></td><td><code>Number</code></td><td>The minimum value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the minimum allowed value for the slider</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setOrientation</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setOrientation(<span class="methodArgument">sOrientation</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>sOrientation</code></td><td><code>String</code></td><td>The orientation to use</td></tr></tbody></table><h4>Return Type</h4><p><code>EDIT_THIS</code></p></div></div></td><td>Sets the orientation of the slider. Valid values are "horizontal" and | |
70 "vertical".</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setUnitIncrement</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setUnitIncrement(<span class="methodArgument">nUnitIncrement</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nUnitIncrement</code></td><td><code>Number</code></td><td>The unit increment value</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the amount to increment the value for small increments. This value is | |
71 used when using the arrow keys to change the value</td></tr><tr><td><a class="helpLink" href="javascript://" onclick="toggleMethodArguments( event, this ); return false;">setValue</a><div class="methodContainer"><div class="methodInfo"><h4>Syntax</h4><p><code><span class="object">object</span>.setValue(<span class="methodArgument">nValue</span>)</code></p><h4>Arguments</h4><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>nValue</code></td><td><code>Number</code></td><td>The value to set</td></tr></tbody></table><h4>Return Type</h4><p><code>void</code></p></div></div></td><td>Sets the value of the slider</td></tr></tbody></table><h3>Fields</h3><table><thead><tr><td>Name</td><td>Type</td><td>Descripton</td></tr></thead><tbody><tr><td><code>classNameTag</code></td><td><code>String</code></td><td>The extra string to add to the class name for a dynamic slider. This property | |
72 is used to allow specific CSS rules to distinguish between static sliders and dynamic. | |
73 This property should not be changed after any sliders have been created.</td></tr></tbody></table><h3>Events</h3><table><thead><tr><td>Name</td><td>Descripton</td></tr></thead><tbody><tr><td><code>onchange</code></td><td>This event is fired when the value of the slider has changed</td></tr></tbody></table><h3>Remarks</h3><p> | |
74 None. | |
75 </p><!-- end main output --> | |
76 | |
77 <p> | |
78 <a href="slider.html">Slider</a><br /> | |
79 <a href="implementation.html">Implementation</a><br /> | |
80 <a href="api.html">API</a><br /> | |
81 <a href="demo.html">Demo</a><br /> | |
82 <a href="http://webfx.eae.net/download/slider102.zip">Download</a> | |
83 </p> | |
84 | |
85 <p class="author">Author: Erik Arvidsson</p> | |
86 | |
87 <!-- end webfx-main-body --> | |
88 </div> | |
89 | |
90 </body> | |
91 </html> |