<!-- saved from url=(0026)http://www.naturaldocs.org -->
<divid=Content><divclass="CClass"><divclass=CTopicid=MainTopic><divclass="CTitle logo"><divclass="nav"><aclass="nav"href="../../../index.php"><span>></span>Home</a><aclass="nav"href="../../../tests/"><span>></span>Examples</a><aclass="nav"href="../../../docs/"><span>></span>Docs</a><aclass="nav"href="http://bitbucket.org/cleonello/jqplot/downloads/"><span>></span>Download</a><aclass="nav"href="../../../info.php"><span>></span>Info</a><aclass="nav"href="../../../donate.php"><span>></span>Donate</a></div><aname="$.jqplot.MeterGaugeRenderer"></a>$.jqplot.<wbr>MeterGaugeRenderer</div><divclass=CBody><p>Plugin renderer to draw a meter gauge chart.</p><p>Data consists of a single series with 1 data point to position the gauge needle.</p><p>To use this renderer, you need to include the meter gauge renderer plugin, for example:</p><blockquote><pre><script type="text/javascript" src="plugins/jqplot.meterGaugeRenderer.js"></script></pre></blockquote><p>Properties described here are passed into the $.jqplot function as options on the series renderer. For example:</p><blockquote><pre>plot0 = $.jqplot('chart0',[[18]],{
title: 'Network Speed',
seriesDefaults: {
renderer: $.jqplot.MeterGaugeRenderer,
rendererOptions: {
label: 'MB/s'
}
}
});</pre></blockquote><p>A meterGauge plot does not support events.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer">$.jqplot.<wbr>MeterGaugeRenderer</a></td><tdclass=SDescription>Plugin renderer to draw a meter gauge chart.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.diameter"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">diameter</a></td><tdclass=SDescription>Outer diameter of the meterGauge, auto computed by default</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.padding"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">padding</a></td><tdclass=SDescription>padding between the meterGauge and plot edges, auto calculated by default.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.shadowOffset"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">shadowOffset</a></td><tdclass=SDescription>offset of the shadow from the gauge ring and offset of each succesive stroke of the shadow from the last.</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.shadowAlpha"id=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">shadowAlpha</a></td><tdclass=SDescription>transparency of the shadow (0 = transparent, 1 = opaque)</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.shadowDepth"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">shadowDepth</a></td><tdclass=SDescription>number of strokes to apply to the shadow, each stroke offset shadowOffset from the last.</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.background"id=link6onMouseOver="ShowTip(event, 'tt6', 'link6')"onMouseOut="HideTip('tt6')">background</a></td><tdclass=SDescription>background color of the inside of the gauge.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.ringColor"id=link7onMouseOver="ShowTip(event, 'tt7', 'link7')"onMouseOut="HideTip('tt7')">ringColor</a></td><tdclass=SDescription>color of the outer ring, hub, and needle of the gauge.</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.tickColor"id=link8onMouseOver="ShowTip(event, 'tt8', 'link8')"onMouseOut="HideTip('tt8')">tickColor</a></td><tdclass=SDescription>color of the tick marks around the gauge.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.ringWidth"id=link9onMouseOver="ShowTip(event, 'tt9', 'link9')"onMouseOut="HideTip('tt9')">ringWidth</a></td><tdclass=SDescription>width of the ring around the gauge. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.min"id=link10onMouseOver="ShowTip(event, 'tt10', 'link10')"onMouseOut="HideTip('tt10')">min</a></td><tdclass=SDescription>Minimum value on the gauge. </td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.max"id=link11onMouseOver="ShowTip(event, 'tt11', 'link11')"onMouseOut="HideTip('tt11')">max</a></td><tdclass=SDescription>Maximum value on the gauge. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.ticks"id=link12onMouseOver="ShowTip(event, 'tt12', 'link12')"onMouseOut="HideTip('tt12')">ticks</a></td><tdclass=SDescription>Array of tick values. </td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.MeterGaugeRenderer.showTick
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.diameter"></a>diameter</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.diameter = null</td></tr></table></blockquote><p>Outer diameter of the meterGauge, auto computed by default</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.padding"></a>padding</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.padding = null</td></tr></table></blockquote><p>padding between the meterGauge and plot edges, auto calculated by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.shadowOffset"></a>shadowOffset</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowOffset = 2</td></tr></table></blockquote><p>offset of the shadow from the gauge ring and offset of each succesive stroke of the shadow from the last.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.shadowAlpha"></a>shadowAlpha</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowAlpha = 0.07</td></tr></table></blockquote><p>transparency of the shadow (0 = transparent, 1 = opaque)</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.shadowDepth"></a>shadowDepth</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowDepth = 4</td></tr></table></blockquote><p>number of strokes to apply to the shadow, each stroke offset shadowOffset from the last.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.background"></a>background</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.background = "#efefef"</td></tr></table></blockquote><p>background color of the inside of the gauge.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.ringColor"></a>ringColor</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ringColor = "#BBC6D0"</td></tr></table></blockquote><p>color of the outer ring, hub, and needle of the gauge.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.tickColor"></a>tickColor</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.tickColor = "989898"</td></tr></table></blockquote><p>color of the tick marks around the gauge.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.ringWidth"></a>ringWidth</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ringWidth = null</td></tr></table></blockquote><p>width of the ring around the gauge. Auto computed by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.min"></a>min</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.min</td></tr></table></blockquote><p>Minimum value on the gauge. Auto computed by default</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.max"></a>max</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.max</td></tr></table></blockquote><p>Maximum value on the gauge. Auto computed by default</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.ticks"></a>ticks</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ticks = []</td></tr></table></blockquote><p>Array of tick values. Auto computed by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.showTicks"></a>showTicks</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.showTicks = true</td></tr></table></blockquote><p>true to show ticks around gauge.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.showTickLabels"></a>showTickLabels</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.showTickLabels = true</td></tr></table></blockquote><p>true to show tick labels next to ticks.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.label"></a>label</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.label = null</td></tr></table></blockquote><p>A gauge label like ‘kph’ or ‘Volts’</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.labelHeightAdjust"></a>labelHeightAdjust</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.labelHeightAdjust = 0</td></tr></table></blockquote><p>Number of Pixels to offset the label up (-) or down (+) from its default position.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.labelPosition"></a>labelPosition</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.labelPosition = 'inside'</td></tr></table></blockquote><p>Where to position the label, either ‘inside’ or ‘bottom’.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.intervals"></a>intervals</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.intervals = []</td></tr></table></blockquote><p>Array of ranges to be drawn around the gauge. Array of form:</p><blockquote><pre>[value1, value2, ...]</pre></blockquote><p>indicating the values for the first, second, ... intervals.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.intervalColors"></a>intervalColors</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.intervalColors = [ "#4bb2c5", "#EAA228", "#c5b47f", "#579575", "#839557", "#958c12", "#953579", "#4b5de4", "#d8b83f", "#ff5800", "#0085cc", "#c747a3", "#cddf54", "#FBD178", "#26B4E3", "#bd70c7"]</td></tr></table></blockquote><p>Array of colors to use for the intervals.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.intervalInnerRadius"></a>intervalInnerRadius</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.intervalInnerRadius = null</td></tr></table></blockquote><p>Radius of the inner circle of the interval ring.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.intervalOuterRadius"></a>intervalOuterRadius</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.intervalOuterRadius = null</td></tr></table></blockquote><p>Radius of the outer circle of the interval ring.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.tickSpacing"></a>tickSpacing</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.tickSpacing = 30</td></tr></table></blockquote><p>Degrees between ticks. This is a target number, if incompatible span and ticks are supplied, a suitable spacing close to this value will be computed.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.hubRadius"></a>hubRadius</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.hubRadius = null</td></tr></table></blockquote><p>Radius of the hub at the bottom center of gauge which the needle attaches to. Auto computed by default</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.tickPadding"></a>tickPadding</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.tickPadding = null</td></tr></table></blockquote><p>padding of the tick marks to the outer ring and the tick labels to marks. Auto computed by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.needleThickness"></a>needleThickness</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.needleThickness = null</td></tr></table></blockquote><p>Maximum thickness the needle. Auto computed by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.needlePad"></a>needlePad</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.needlePad = 6</td></tr></table></blockquote><p>Padding between needle and inner edge of the ring when the needle is at the min or max gauge value.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.MeterGaugeRenderer.pegNeedle"></a>pegNeedle</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.pegNeedle = true</td></tr></table></blockquote><p>True will stop needle just below/above the min/max values if data is below/above min/max, as if the meter is “pegged”.</p></div></div></div>
<divclass=CToolTipid="tt1"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.diameter = null</td></tr></table></blockquote>Outer diameter of the meterGauge, auto computed by default</div></div><divclass=CToolTipid="tt2"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.padding = null</td></tr></table></blockquote>padding between the meterGauge and plot edges, auto calculated by default.</div></div><divclass=CToolTipid="tt3"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowOffset = 2</td></tr></table></blockquote>offset of the shadow from the gauge ring and offset of each succesive stroke of the shadow from the last.</div></div><divclass=CToolTipid="tt4"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowAlpha = 0.07</td></tr></table></blockquote>transparency of the shadow (0 = transparent, 1 = opaque)</div></div><divclass=CToolTipid="tt5"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.shadowDepth = 4</td></tr></table></blockquote>number of strokes to apply to the shadow, each stroke offset shadowOffset from the last.</div></div><divclass=CToolTipid="tt6"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.background = "#efefef"</td></tr></table></blockquote>background color of the inside of the gauge.</div></div><divclass=CToolTipid="tt7"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ringColor = "#BBC6D0"</td></tr></table></blockquote>color of the outer ring, hub, and needle of the gauge.</div></div><divclass=CToolTipid="tt8"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.tickColor = "989898"</td></tr></table></blockquote>color of the tick marks around the gauge.</div></div><divclass=CToolTipid="tt9"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ringWidth = null</td></tr></table></blockquote>width of the ring around the gauge. </div></div><divclass=CToolTipid="tt10"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.min</td></tr></table></blockquote>Minimum value on the gauge. </div></div><divclass=CToolTipid="tt11"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.max</td></tr></table></blockquote>Maximum value on the gauge. </div></div><divclass=CToolTipid="tt12"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.ticks = []</td></tr></table></blockquote>Array of tick values. </div></div><divclass=CToolTipid="tt13"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.showTicks = true</td></tr></table></blockquote>true to show ticks around gauge.</div></div><divclass=CToolTipid="tt14"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.showTickLabels = true</td></tr></table></blockquote>true to show tick labels next to ticks.</div></div><divclass=CToolTipid="tt15"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.label = null</td></tr></table></blockquote>A gauge label like ‘kph’ or ‘Volts’</div></div><divclass=CToolTipid="tt16"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.labelHeightAdjust = 0</td></tr></table></blockquote>Number of Pixels to offset the label up (-) or down (+) from its default position.</div></div><divclass=CToolTipid="tt17"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototyp
