Skip to content

WoollyMittens/useful-dial

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dial.js: A Rotating Dial

A dial for setting a rotation property.

How to include the script

The stylesheet is best included in the header of the document.

<link rel="stylesheet" href="./css/dial.css"/>

This include can be added to the header or placed inline before the script is invoked.

<script src="lib/positions.js"></script>
<script src="js/dial.js"></script>

Or use Require.js.

requirejs([
	'lib/positions.js',
	'js/dial.js'
], function(positions, Dial) {
	...
});

Or import into an MVC framework.

var positions = require('lib/positions.js');
var Dial = require('js/dial.js');

How to start the script

var dial = new Dial({
	'element' : document.getElementById('exampleDial'),
	'offset' : 13,
	'invert' : true,
	'radius' : 0.77,
	'onrotate' : function (rotation) {}
});

offset : {integer} - An offset to fine-tune the animation frames to the dial.

invert : {boolean} - Controls if the rotation is clockwise or anti-clockwise.

radius : {float} - The distance of the hand of the dial to the centre the face.

onrotate : {function} - A function that is run whenever the control is rotated.

How to control the script

Update

dial.rotate(angle);

angle : {degrees} - The desired rotation in degrees.

Adjust the rotation frame.

How to build the script

This project uses node.js from http://nodejs.org/

This project uses gulp.js from http://gulpjs.com/

The following commands are available for development:

  • npm install - Installs the prerequisites.
  • gulp import - Re-imports libraries from supporting projects to ./src/libs/ if available under the same folder tree.
  • gulp dev - Builds the project for development purposes.
  • gulp dist - Builds the project for deployment purposes.
  • gulp watch - Continuously recompiles updated files during development sessions.
  • gulp serve - Serves the project on a temporary web server at http://localhost:8500/.
  • gulp php - Serves the project on a temporary php server at http://localhost:8500/.

License

This work is licensed under a MIT License. The latest version of this and other scripts by the same author can be found on Github and at WoollyMittens.nl.

About

A Rotating Dial

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published