Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wavesoft/jquery-wheel-gauge
A jQuery plugin for displaying a values in a more retro way.
https://github.com/wavesoft/jquery-wheel-gauge
Last synced: 13 days ago
JSON representation
A jQuery plugin for displaying a values in a more retro way.
- Host: GitHub
- URL: https://github.com/wavesoft/jquery-wheel-gauge
- Owner: wavesoft
- License: mit
- Created: 2014-10-13T12:33:06.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-23T10:31:55.000Z (almost 10 years ago)
- Last Synced: 2024-11-13T04:48:45.055Z (2 months ago)
- Language: CSS
- Size: 168 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jquery-wheel-gauge
A jQuery plugin for displaying a values in a more retro way.
## How to use
This plug-in works on input elements. To use it in your project, just include the `rundial.min.js` and `rundial.css`:
```html
```
Put an input element where you want your dial to appear:
```html
```
And call `.rundial()` on that element:
```javascript
$("#mydial").rundial({ .. options .. });
```
## Options Reference
The rundial function accelts a javascript object with the following basic properties:
* __min__ : The minimum value range. _(default: 0)_
* __max__ : The maximum value range. _(default: 100)_
* __width__ : The width of the gauge. _(default: 'auto')_
* __height__ : The height of the gauge. _(default: 'auto')_
* __step__ : The interval between displayed values. _(default: 1)_
* __value__ : The default value for the dial. _(default: [min])_
And the following advanced properties:
* __dampValue__ : The damping value for the easing animation. The bigger this value, the longer the animation will be. _(default: 10)_
* __updateDelay__ : How frequently to poll the value of the input element for changes. Set to 0 to disable polling. _(default: 0)_
* __format__ : The formatter function to use for the displayed values. _(default: `function(v){ return String(v); }`)_
* __overflowText__ : The value to display when the text is overflowing. _(default: '(!)')_
* __overflowElmClass__ : The class to append to the value element that displays the `overflowText`. _(default: 'rundial-warn')_
* __overflowClass__ : The class to append to the whole rundial element when an overflow occurs. _(default: 'rundial-overrun')_
* __underflowText__ : The value to display when the text is underflowing. _(default: '(!)')_
* __underflowElmClass__ : The class to append to the value element that displays the `underflowText`. _(default: 'rundial-warn')_
* __underflowClass__ : The class to append to the whole rundial element when an underflow occurs. _(default: 'rundial-underrun')_
* __adoptClasses__ : Set to `true` to adopt the classes the input element had before being replaced by the rundial. _(default: true)_
* __ascending__ : Switch order to ascending. _(default: false)_
# License
This library is licensed under the MIT License:
The MIT License (MIT)
Copyright (c) 2014 Ioannis Charalampidis
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.