javascript
/
tentone.escher.js
mirror of https://github.com/tentone/escher.js.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: objects/chart/Gauge.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: objects/chart/Gauge.js</h1>

    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>import {Object2D} from "../../Object2D.js";
import {ColorStyle} from "../style/ColorStyle";
import {LinearGradientStyle} from "../style/LinearGradientStyle";

/**
 * Gauge object is used to draw gauge like graphic.
 *
 * It has a defined range, start angle, end angle and style controls.
 *
 * @class
 * @extends {Object2D}
 */
function Gauge()
{
	Object2D.call(this);

	/**
	 * Value displayed by this gauge. It is displayed based on min and max values.
	 *
	 * @type {number}
	 */
	this.value = 50;

	/**
	 * Minimum value of the gauge. Necessary to display the value correctly to scale.
	 *
	 * @type {number}
	 */
	this.min = 0;

	/**
	 * Maximum value of the gauge. Necessary to display the value correctly to scale.
	 *
	 * @type {number}
	 */
	this.max = 100;

	/**
	 * Radius of the gauge object.
	 *
	 * @type {number}
	 */
	this.radius = 80;

	/**
	 * The line width of the gauge semi-circle.
	 *
	 * @type {number}
	 */
	this.lineWidth = 10;

	/**
	 * Start angle of the gauge.
	 *
	 * @type {number}
	 */
	this.startAngle = Math.PI;

	/**
	 * End angle of the gauge.
	 *
	 * @type {number}
	 */
	this.endAngle = 2 * Math.PI;

	/**
	 * If true draw a circular dial at the end of the gauge bar.
	 *
	 * @type {boolean}
	 */
	this.dial = false;

	/**
	 * Style of the base of the gauge object, (the background of the gauge bar).
	 *
	 * @type {Style}
	 */
	this.baseStyle = new ColorStyle("#e9ecf1");

	/**
	 * Style of the gauge bar.
	 *
	 * @type {Style}
	 */
	this.barStyle = new LinearGradientStyle();
	this.barStyle.start.set(-100, 0);
	this.barStyle.end.set(100, 0);
	this.barStyle.addColorStop(0, "#e5ff50");
	this.barStyle.addColorStop(0.5, "#50ff67");
	this.barStyle.addColorStop(1, "#32adff");
}

Gauge.prototype = Object.create(Object2D.prototype);
Gauge.prototype.constructor = Gauge;
Gauge.prototype.type = "Gauge";
Object2D.register(Gauge, "Gauge");

Gauge.prototype.isInside = function(point)
{
	return point.length() &lt;= this.radius;
};

Gauge.prototype.draw = function(context, viewport, canvas)
{
	var percentage = this.value / (this.max - this.min);

	var range = [this.startAngle, this.endAngle];
	var diff = range[1] - range[0];
	var angle = range[0] + diff * percentage;
	var center = [0, 0];

	//Back
	context.lineWidth = this.lineWidth;
	context.lineCap = "round";
	context.strokeStyle = this.baseStyle.get(context);
	context.beginPath();
	context.arc(center[0], center[1], this.radius, range[0], range[1]);
	context.stroke();

	// Fill gradient
	var gradient = context.createLinearGradient(-this.radius, 0, this.radius, 0);

	context.strokeStyle = this.barStyle.get(context);

	context.lineWidth = this.lineWidth;
	context.beginPath();
	context.arc(center[0], center[1], this.radius, range[0], angle);
	context.stroke();

	if(this.dial)
	{
		var dialAngle = (this.startAngle - this.endAngle) * percentage;
		var dialCenter = [Math.cos(dialAngle) * this.radius, Math.sin(dialAngle) * this.radius];
		dialCenter[0] = dialCenter[0] - center[0];
		dialCenter[1] = dialCenter[1] - center[1];

		context.fillStyle = "#FFFFFF";
		context.beginPath();
		context.arc(dialCenter[0], dialCenter[1], this.lineWidth / 2, 0, 2 * Math.PI);
		context.fill();

		context.fillStyle = gradient;
		context.beginPath();
		context.arc(dialCenter[0], dialCenter[1], this.lineWidth / 3, 0, 2 * Math.PI);
		context.fill();
	}
};

Gauge.prototype.serialize = function(recursive)
{
	var data = Object2D.prototype.serialize.call(this, recursive);

	data.value = this.value;
	data.min = this.min;
	data.max = this.max;
	data.radius = this.radius;
	data.lineWidth = this.lineWidth;
	data.startAngle = this.startAngle;
	data.endAngle = this.endAngle;
	data.dial = this.dial;
	data.baseStyle = this.baseStyle !== null ? this.baseStyle.serialize() : null;
	data.barStyle = this.barStyle !== null ? this.barStyle.serialize() : null;

	return data;
};

Gauge.prototype.parse = function(data, root)
{
	Object2D.prototype.parse.call(this, data, root);

	this.value = data.value;
	this.min = data.min;
	this.max = data.max;
	this.radius = data.radius;
	this.lineWidth = data.lineWidth;
	this.startAngle = data.startAngle;
	this.endAngle = data.endAngle;
	this.dial = data.dial;
	this.baseStyle = data.baseStyle !== null ? Style.parse(data.baseStyle) : null;
	this.barStyle = data.barStyle !== null ? Style.parse(data.barStyle) : null;
};


export {Gauge};
</code></pre>
        </article>
    </section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnimationTimer.html">AnimationTimer</a></li><li><a href="BarGraph.html">BarGraph</a></li><li><a href="BezierCurve.html">BezierCurve</a></li><li><a href="Box.html">Box</a></li><li><a href="Box2.html">Box2</a></li><li><a href="BoxMask.html">BoxMask</a></li><li><a href="Circle.html">Circle</a></li><li><a href="ColorStyle.html">ColorStyle</a></li><li><a href="DOM.html">DOM</a></li><li><a href="EventManager.html">EventManager</a></li><li><a href="FileUtils.html">FileUtils</a></li><li><a href="Gauge.html">Gauge</a></li><li><a href="GradientColorStop.html">GradientColorStop</a></li><li><a href="GradientStyle.html">GradientStyle</a></li><li><a href="Graph.html">Graph</a></li><li><a href="Helpers.html">Helpers</a></li><li><a href="Image.html">Image</a></li><li><a href="Key.html">Key</a></li><li><a href="Line.html">Line</a></li><li><a href="LinearGradientStyle.html">LinearGradientStyle</a></li><li><a href="Mask.html">Mask</a></li><li><a href="Matrix.html">Matrix</a></li><li><a href="MultiLineText.html">MultiLineText</a></li><li><a href="Node.html">Node</a></li><li><a href="NodeConnector.html">NodeConnector</a></li><li><a href="NodeGraph.html">NodeGraph</a></li><li><a href="NodeSocket.html">NodeSocket</a></li><li><a href="Object2D.html">Object2D</a></li><li><a href="Path.html">Path</a></li><li><a href="Pattern.html">Pattern</a></li><li><a href="PatternStyle.html">PatternStyle</a></li><li><a href="PieChart.html">PieChart</a></li><li><a href="Pointer.html">Pointer</a></li><li><a href="QuadraticCurve.html">QuadraticCurve</a></li><li><a href="RadialGradientStyle.html">RadialGradientStyle</a></li><li><a href="Renderer.html">Renderer</a></li><li><a href="RoundedBox.html">RoundedBox</a></li><li><a href="ScatterGraph.html">ScatterGraph</a></li><li><a href="Style.html">Style</a></li><li><a href="Text.html">Text</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Vector2.html">Vector2</a></li><li><a href="Viewport.html">Viewport</a></li><li><a href="ViewportControls.html">ViewportControls</a></li></ul><h3>Global</h3><ul><li><a href="global.html#writeFile">writeFile</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Sat Sep 17 2022 14:24:36 GMT+0100 (Hora de verão da Europa Ocidental)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>