<!-- 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.LineRenderer"></a>$.jqplot.<wbr>LineRenderer</div><divclass=CBody><p>The default line renderer for jqPlot, this class has no options beyond the <ahref="jqplot-core-js.html#Series"class=LClassid=link9onMouseOver="ShowTip(event, 'tt1', 'link9')"onMouseOut="HideTip('tt1')">Series</a> class. Draws series as a line.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer">$.jqplot.<wbr>LineRenderer</a></td><tdclass=SDescription>The default line renderer for jqPlot, this class has no options beyond the <ahref="jqplot-core-js.html#Series"class=LClassid=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">Series</a> class. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.smooth"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">smooth</a></td><tdclass=SDescription>True to draw a smoothed (interpolated) line through the data points with automatically computed number of smoothing points. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.constrainSmoothing"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">constrainSmoothing</a></td><tdclass=SDescription>True to use a more accurate smoothing algorithm that will not overshoot any data points. </td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.bandData"id=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">bandData</a></td><tdclass=SDescription>Data used to draw error bands or confidence intervals above/below a line.</td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.bands">bands</a></td><tdclass=SDescription>Banding around line, e.g error bands or confidence intervals.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.show">show</a></td><tdclass=SDescription>true to show the bands. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.color">color</a></td><tdclass=SDescription>color of lines at top and bottom of bands [default: series color].</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.showLines">showLines</a></td><tdclass=SDescription>True to show lines at top and bottom of bands [default: false].</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.fill">fill</a></td><tdclass=SDescription>True to fill area between bands [default: true].</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.fillColor">fillColor</a></td><tdclass=SDescription>css color spec for filled area. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.interval"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">interval</a></td><tdclass=SDescription>User specified interval above and below line for bands [default: ‘3%’’]. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#$.jqplot.LineRenderer.Properties">Properties</a></td><tdclass=SDescripti
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.smooth"></a>smooth</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.smooth = false</td></tr></table></blockquote><p>True to draw a smoothed (interpolated) line through the data points with automatically computed number of smoothing points. Set to an integer number > 2 to specify number of smoothing points to use between each data point.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.constrainSmoothing"></a>constrainSmoothing</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.constrainSmoothing = true</td></tr></table></blockquote><p>True to use a more accurate smoothing algorithm that will not overshoot any data points. False to allow overshoot but produce a smoother looking line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.bandData"></a>bandData</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.bandData = []</td></tr></table></blockquote><p>Data used to draw error bands or confidence intervals above/below a line.</p><p>bandData can be input in 3 forms. jqPlot will figure out which is the low band line and which is the high band line for all forms:</p><p>A 2 dimensional array like [[yl1, yl2, ...], [yu1, yu2, ...]] where [yl1, yl2, ...] are y values of the lower line and [yu1, yu2, ...] are y values of the upper line. In this case there must be the same number of y data points as data points in the series and the bands will inherit the x values of the series.</p><p>A 2 dimensional array like [[[xl1, yl1], [xl2, yl2], ...], [[xh1, yh1], [xh2, yh2], ...]] where [xl1, yl1] are x,y data points for the lower line and [xh1, yh1] are x,y data points for the high line. x values do not have to correspond to the x values of the series and can be of any arbitrary length.</p><p>Can be of form [[yl1, yu1], [yl2, yu2], [yl3, yu3], ...] where there must be 3 or more arrays and there must be the same number of arrays as there are data points in the series. In this case, [yl1, yu1] specifies the lower and upper y values for the 1st data point and so on. The bands will inherit the x values from the series.</p></div></div></div>
<divclass="CGroup"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.bands"></a>bands</h3><divclass=CBody><p>Banding around line, e.g error bands or confidence intervals.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.show"></a>show</h3><divclass=CBody><p>true to show the bands. If bandData or interval is supplied, show will be set to true by default.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.color"></a>color</h3><divclass=CBody><p>color of lines at top and bottom of bands [default: series color].</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.showLines"></a>showLines</h3><divclass=CBody><p>True to show lines at top and bottom of bands [default: false].</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.fill"></a>fill</h3><divclass=CBody><p>True to fill area between bands [default: true].</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.fillColor"></a>fillColor</h3><divclass=CBody><p>css color spec for filled area. [default: series color].</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.interval"></a>interval</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>interval: '3%' }</td></tr></table></blockquote><p>User specified interval above and below line for bands [default: ‘3%’’]. Can be a value like 3 or a string like ‘3%’ or an upper/lower array like [1, -2] or [‘2%’, ‘-1.5%’]</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.highlightMouseOver"></a>highlightMouseOver</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightMouseOver = true</td></tr></table></blockquote><p>True to highlight area on a filled plot when moused over. This must be false to enable highlightMouseDown to highlight when clicking on an area on a filled plot.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.highlightMouseDown"></a>highlightMouseDown</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightMouseDown = false</td></tr></table></blockquote><p>True to highlight when a mouse button is pressed over an area on a filled plot. This will be disabled if highlightMouseOver is true.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.LineRenderer.highlightColor"></a>highlightColor</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightColor = null</td></tr></table></blockquote><p>color to use when highlighting an area on a filled plot.</p></div></div></div>
<divclass=CToolTipid="tt1"><divclass=CClass>An individual data series object. </div></div><divclass=CToolTipid="tt2"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.smooth = false</td></tr></table></blockquote>True to draw a smoothed (interpolated) line through the data points with automatically computed number of smoothing points. </div></div><divclass=CToolTipid="tt3"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.constrainSmoothing = true</td></tr></table></blockquote>True to use a more accurate smoothing algorithm that will not overshoot any data points. </div></div><divclass=CToolTipid="tt4"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.renderer.bandData = []</td></tr></table></blockquote>Data used to draw error bands or confidence intervals above/below a line.</div></div><divclass=CToolTipid="tt5"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>interval: '3%' }</td></tr></table></blockquote>User specified interval above and below line for bands [default: ‘3%’’]. </div></div><divclass=CToolTipid="tt6"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightMouseOver = true</td></tr></table></blockquote>True to highlight area on a filled plot when moused over. </div></div><divclass=CToolTipid="tt7"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightMouseDown = false</td></tr></table></blockquote>True to highlight when a mouse button is pressed over an area on a filled plot. </div></div><divclass=CToolTipid="tt8"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.highlightColor = null</td></tr></table></blockquote>color to use when highlighting an area on a filled plot.</div></div><!--END_ND_TOOLTIPS-->
