<!-- 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.CanvasOverlay"></a>$.jqplot.<wbr>CanvasOverlay</div><divclass=CBody><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay">$.jqplot.<wbr>CanvasOverlay</a></td><tdclass=SDescription></td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.objects"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">objects</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.name">name</a></td><tdclass=SDescription>Optional name for the overlay object. </td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.show">show</a></td><tdclass=SDescription>true to show (draw), false to not draw.</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.lineWidth">lineWidth</a></td><tdclass=SDescription>Width of the line.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.lineCap">lineCap</a></td><tdclass=SDescription>Type of ending placed on the line [‘round’, ‘butt’, ‘square’]</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.color">color</a></td><tdclass=SDescription>color of the line</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.shadow">shadow</a></td><tdclass=SDescription>whether or not to draw a shadow on the line</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.shadowAngle">shadowAngle</a></td><tdclass=SDescription>Shadow angle in degrees</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.shadowOffset">shadowOffset</a></td><tdclass=SDescription>Shadow offset from line in pixels</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.shadowDepth">shadowDepth</a></td><tdclass=SDescription>Number of times shadow is stroked, each stroke offset shadowOffset from the last.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.shadowAlpha">shadowAlpha</a></td><tdclass=SDescription>Alpha channel transparency of shadow. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.xaxis">xaxis</a></td><tdclass=SDescription>X axis to use for positioning/scaling the line.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.yaxis">yaxis</a></td><tdclass=SDescription>Y axis to use for positioning/scaling the line.</td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.showTooltip">showTooltip</a></td><tdclass=SDescription>Show a tooltip with data point values.</td></tr><trclass="SProperty SIndent2 SMarked"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.showTooltipPrecision">showTooltipPrecision</a></td><tdclass=SDescription>Controls how close to line cursor must be to show tooltip. </td></tr><trclass="SProperty SIndent2"><tdclass=SEntry><ahref="#$.jqplot.CanvasOverlay.tooltipLocation">tooltipLocation</a></
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.name"></a>name</h3><divclass=CBody><p>Optional name for the overlay object. Can be later used to retrieve the object by name.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.show"></a>show</h3><divclass=CBody><p>true to show (draw), false to not draw.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.lineWidth"></a>lineWidth</h3><divclass=CBody><p>Width of the line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.lineCap"></a>lineCap</h3><divclass=CBody><p>Type of ending placed on the line [‘round’, ‘butt’, ‘square’]</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.color"></a>color</h3><divclass=CBody><p>color of the line</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.shadow"></a>shadow</h3><divclass=CBody><p>whether or not to draw a shadow on the line</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.shadowAngle"></a>shadowAngle</h3><divclass=CBody><p>Shadow angle in degrees</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.shadowOffset"></a>shadowOffset</h3><divclass=CBody><p>Shadow offset from line in pixels</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.shadowDepth"></a>shadowDepth</h3><divclass=CBody><p>Number of times shadow is stroked, each stroke offset shadowOffset from the last.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.shadowAlpha"></a>shadowAlpha</h3><divclass=CBody><p>Alpha channel transparency of shadow. 0 = transparent.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.xaxis"></a>xaxis</h3><divclass=CBody><p>X axis to use for positioning/scaling the line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.yaxis"></a>yaxis</h3><divclass=CBody><p>Y axis to use for positioning/scaling the line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.showTooltip"></a>showTooltip</h3><divclass=CBody><p>Show a tooltip with data point values.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.showTooltipPrecision"></a>showTooltipPrecision</h3><divclass=CBody><p>Controls how close to line cursor must be to show tooltip. Higher number = closer to line, lower number = farther from line. 1.0 = cursor must be over line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.tooltipLocation"></a>tooltipLocation</h3><divclass=CBody><p>Where to position tooltip, ‘n’, ‘ne’, ‘e’, ‘se’, ‘s’, ‘sw’, ‘w’, ‘nw’</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.tooltipFadeSpeed"></a>tooltipFadeSpeed</h3><divclass=CBody><p>’slow’, ‘def’, ‘fast’, or number of milliseconds.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.tooltipOffset"></a>tooltipOffset</h3><divclass=CBody><p>Pixel offset of tooltip from the highlight.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.tooltipFormatString"></a>tooltipFormatString</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>tooltipFormatString: '%d, %d' }</td></tr></table></blockquote><p>Format string passed the x and y values of the cursor on the line. e.g., ‘Dogs: %.2f, Cats: %d’.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.xmin"></a>xmin</h3><divclass=CBody><p>x value for the start of the line, null to scale to axis min.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="$.jqplot.CanvasOverlay.xmax"></a>xmax</h3><divclass=CBody><p>x value for the end of the line, null to scale to axis max.</p></div></div></div>
<divclass="CClass"><divclass=CTopic><h2class=CTitle><aname="Line"></a>Line</h2><divclass=CBody><p>A straight line.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SGroup"><tdclass=SEntry><ahref="#Line.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent1 SMarked"><tdclass=SEntry><ahref="#Line.start">start</a></td><tdclass=SDescription>[x, y] coordinates for the start of the line.</td></tr><trclass="SProperty SIndent1"><tdclass=SEntry><ahref="#Line.stop"id=link6onMouseOver="ShowTip(event, 'tt3', 'link6')"onMouseOut="HideTip('tt3')">stop</a></td><tdclass=SDescription>[x, y] coordinates for the end of the line.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="Line.start"></a>start</h3><divclass=CBody><p>[x, y] coordinates for the start of the line.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="Line.stop"></a>stop</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>stop: [] }</td></tr></table></blockquote><p>[x, y] coordinates for the end of the line.</p></div></div></div>
<divclass="CClass"><divclass=CTopic><h2class=CTitle><aname="HorizontalLine"></a>HorizontalLine</h2><divclass=CBody><p>A straight horizontal line.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SGroup"><tdclass=SEntry><ahref="#HorizontalLine.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent1 SMarked"><tdclass=SEntry><ahref="#HorizontalLine.y">y</a></td><tdclass=SDescription>y value to position the line</td></tr><trclass="SProperty SIndent1"><tdclass=SEntry><ahref="#HorizontalLine.xmin">xmin</a></td><tdclass=SDescription>x value for the start of the line, null to scale to axis min.</td></tr><trclass="SProperty SIndent1 SMarked"><tdclass=SEntry><ahref="#HorizontalLine.xmax">xmax</a></td><tdclass=SDescription>x value for the end of the line, null to scale to axis max.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="HorizontalLine.y"></a>y</h3><divclass=CBody><p>y value to position the line</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="HorizontalLine.xmin"></a>xmin</h3><divclass=CBody><p>x value for the start of the line, null to scale to axis min.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="HorizontalLine.xmax"></a>xmax</h3><divclass=CBody><p>x value for the end of the line, null to scale to axis max.</p></div></div></div>
<divclass="CClass"><divclass=CTopic><h2class=CTitle><aname="DashedHorizontalLine"></a>DashedHorizontalLine</h2><divclass=CBody><p>A straight dashed horizontal line.</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SGroup"><tdclass=SEntry><ahref="#DashedHorizontalLine.Properties">Properties</a></td><tdclass=SDescription></td></tr><trclass="SProperty SIndent1 SMarked"><tdclass=SEntry><ahref="#DashedHorizontalLine.dashPattern"id=link7onMouseOver="ShowTip(event, 'tt4', 'link7')"onMouseOut="HideTip('tt4')">dashPattern</a></td><tdclass=SDescription>Array of line, space settings in pixels. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="DashedHorizontalLine.dashPattern"></a>dashPattern</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>dashPattern: [8,8] }</td></tr></table></blockquote><p>Array of line, space settings in pixels. Default is 8 pixel of line, 8 pixel of space. Note, limit to a 2 element array b/c of bug with higher order arrays.</p></div></div></div>
<divclass="CProperty"><divclass=CTopic><h3class=CTitle><aname="DashedVerticalLine.dashPattern"></a>dashPattern</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>dashPattern: [8,8] }</td></tr></table></blockquote><p>Array of line, space settings in pixels. Default is 8 pixel of line, 8 pixel of space. Note, limit to a 2 element array b/c of bug with higher order arrays.</p></div></div></div>
<divclass=CToolTipid="tt1"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>this.objects = []</td></tr></table></blockquote></div></div><divclass=CToolTipid="tt2"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>tooltipFormatString: '%d, %d' }</td></tr></table></blockquote>Format string passed the x and y values of the cursor on the line. </div></div><divclass=CToolTipid="tt3"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>stop: [] }</td></tr></table></blockquote>[x, y] coordinates for the end of the line.</div></div><divclass=CToolTipid="tt4"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>dashPattern: [8,8] }</td></tr></table></blockquote>Array of line, space settings in pixels. </div></div><divclass=CToolTipid="tt5"><divclass=CProperty><blockquote><tableborder=0cellspacing=0cellpadding=0class=Prototype><tr><td>dashPattern: [8,8] }</td></tr></table></blockquote>Array of line, space settings in pixels. </div></div><!--END_ND_TOOLTIPS-->
