Current Version: 1.0.0
A reusable gauge directive for Angular 1.x apps and dashboards. It provides many configuration options to customize according to your project needs.
npm install angularjs-gauge
bower install angularjs-gauge
git clone https://github.com/ashish-chopra/angular-gauge.git
Copy the files from dist/
manually into your project folder.Then, add the script to your code (after adding the dependency of Angular 1.5) and resolving the paths as given below:
<head>
...
<head>
<body>
...
</body>
<script src="vendor/angular/angular.min.js"></script>
<script src="vendor/angular-gauge/dist/angularjs-gauge.min.js"></script>
Add as dependency in your module
angular.module('yourApp', ['angularjs-gauge']);
Use it in your HTML markup like this
<ng-gauge size="200" type="full" thick="5" value="68.2" cap="round" label="Speed" foreground-color="#ffcc66" background-color="rgba(255,255,255, 0.4)" append="mph"></ng-gauge>
If you face any problem, then raise an issue here.
There are plenty of configurable options available to tune the Gauge
as per your needs.
Name | Description | Required | Default value | Possible values |
---|---|---|---|---|
size |
Specifies the size of the canvas in which Gauge will be drawn. It is used as width and height both. |
No | 200 |
Positive Integer |
value |
Specifies the current value of the Gauge as a percentage. It is required attribute. | Yes | undefined |
A numeric value between 0 - 100 . |
used |
Specifies the absolute value which has been consumed out of total . The percentage usage (used/total) will be displayed by the Gauge. When this attribute is specified with total , value attribute is not used. |
No | undefined |
Any numeric value |
total |
specifies the total value that represents the whole rim of the Gauge. It is used along with used attribute. used and total attributes are specified together. When these attributes are specified, do not use value attribute. |
No | undefined |
Any numeric value |
cap |
The style of line ending at the gauge's end. | No | "butt" |
"round" , "butt" |
thick |
Specified the thickness of the gauge's bar. | No | 5 |
Any Positive Integer |
type |
Specifies the gauge's type. | No | "full" |
"full" , "semi" , "arch" |
label |
Specifies the text to display below the Gauge's reading. | No | undefined |
Any String |
foreground-color |
Specifies the foreground color of the Gauge's bar. It will be overriden if theme attribute is specified. |
No | "#FFCC66" |
Any color value string |
background-color |
Specifies the background color of the Gauge's bar. | No | "#CCC" |
Any color value string |
append |
Specifies a string appended to the Gauge's reading. For example "%" most commonly used. |
No | undefined |
Any string |
prepend |
Specifies a string prepended to the Gauge's reading. For example "$" in case of financial data displayed in Gauge. |
No | undefined |
Any String |
text |
Not supported yet | - | - | - |
theme |
Not supported yet | - | - | - |
The project is continously evovling with every new release. Give it a star, if you like it.
For contribution setup the development environment as follows:
# clone and setup the project dependencies
git clone https://github.com/ashish-chopra/angular-gauge.git
npm install
npm install -g gulp
# builds the source code
gulp build
# runs a web server at port 3000 (default) and host the /examples directory
gulp
# runs test suite once and exit
gulp test
# runs the test suite and wait for code changes (useful while development)
gulp tdd
gulp
command will run a development server at port 3000
on your machine, then you can browse the bundled examples
at http://localhost:3000
.
First thing first, explore the issue tracker to find something to contribute. There are tons of other project setup related issues and activities in which you can help. Your feedback could also be a great contribution.
If you face any problem, then raise an issue here.