1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <html><head><title>$.jqplot.Cursor
</title><link rel=
"stylesheet" type=
"text/css" href=
"../../styles/main.css"><script language=JavaScript
src=
"../../javascript/main.js"></script><script language=JavaScript
src=
"../../javascript/searchdata.js"></script></head><body class=
"ContentPage" onLoad=
"NDOnLoad()"><script language=JavaScript
><!--
4 if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
6 <!-- Generated by Natural Docs, version 1.4 -->
7 <!-- http://www.naturaldocs.org -->
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
14 <div id=Content
><div class=
"CClass"><div class=CTopic id=MainTopic
><div class=
"CTitle logo"><div class=
"nav"><a class=
"nav" href=
"../../../index.php"><span>></span>Home
</a><a class=
"nav" href=
"../../../tests/"><span>></span>Examples
</a><a class=
"nav" href=
"../../../docs/"><span>></span>Docs
</a><a class=
"nav" href=
"http://bitbucket.org/cleonello/jqplot/downloads/"><span>></span>Download
</a><a class=
"nav" href=
"../../../info.php"><span>></span>Info
</a><a class=
"nav" href=
"../../../donate.php"><span>></span>Donate
</a></div><a name=
"$.jqplot.Cursor"></a>$.jqplot.
<wbr>Cursor
</div><div class=CBody
><p>Plugin class representing the cursor as displayed on the plot.
</p><!--START_ND_SUMMARY--><div class=Summary
><div class=STitle
>Summary
</div><div class=SBorder
><table border=
0 cellspacing=
0 cellpadding=
0 class=STable
><tr class=
"SMain"><td class=SEntry
><a href=
"#$.jqplot.Cursor" >$.jqplot.
<wbr>Cursor
</a></td><td class=SDescription
>Plugin class representing the cursor as displayed on the plot.
</td></tr><tr class=
"SGroup SIndent1"><td class=SEntry
><a href=
"#$.jqplot.Cursor.Properties" >Properties
</a></td><td class=SDescription
></td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.style" id=link1
onMouseOver=
"ShowTip(event, 'tt1', 'link1')" onMouseOut=
"HideTip('tt1')">style
</a></td><td class=SDescription
>CSS spec for cursor style
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.show" id=link2
onMouseOver=
"ShowTip(event, 'tt2', 'link2')" onMouseOut=
"HideTip('tt2')">show
</a></td><td class=SDescription
>wether to show the cursor or not.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showTooltip" id=link3
onMouseOver=
"ShowTip(event, 'tt3', 'link3')" onMouseOut=
"HideTip('tt3')">showTooltip
</a></td><td class=SDescription
>show a cursor position tooltip.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.followMouse" id=link4
onMouseOver=
"ShowTip(event, 'tt4', 'link4')" onMouseOut=
"HideTip('tt4')">followMouse
</a></td><td class=SDescription
>Tooltip follows the mouse, it is not at a fixed location.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.tooltipLocation" id=link5
onMouseOver=
"ShowTip(event, 'tt5', 'link5')" onMouseOut=
"HideTip('tt5')">tooltipLocation
</a></td><td class=SDescription
>Where to position tooltip.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.tooltipOffset" id=link6
onMouseOver=
"ShowTip(event, 'tt6', 'link6')" onMouseOut=
"HideTip('tt6')">tooltipOffset
</a></td><td class=SDescription
>Pixel offset of tooltip from the grid boudaries or cursor center.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showTooltipGridPosition" id=link7
onMouseOver=
"ShowTip(event, 'tt7', 'link7')" onMouseOut=
"HideTip('tt7')">showTooltipGridPosition
</a></td><td class=SDescription
>show the grid pixel coordinates of the mouse.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showTooltipUnitPosition" id=link8
onMouseOver=
"ShowTip(event, 'tt8', 'link8')" onMouseOut=
"HideTip('tt8')">showTooltipUnitPosition
</a></td><td class=SDescription
>show the unit (data) coordinates of the mouse.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showTooltipDataPosition" id=link9
onMouseOver=
"ShowTip(event, 'tt9', 'link9')" onMouseOut=
"HideTip('tt9')">showTooltipDataPosition
</a></td><td class=SDescription
>Used with showVerticalLine to show intersecting data points in the tooltip.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.tooltipFormatString" id=link10
onMouseOver=
"ShowTip(event, 'tt10', 'link10')" onMouseOut=
"HideTip('tt10')">tooltipFormatString
</a></td><td class=SDescription
>sprintf format string for the tooltip.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.useAxesFormatters" id=link11
onMouseOver=
"ShowTip(event, 'tt11', 'link11')" onMouseOut=
"HideTip('tt11')">useAxesFormatters
</a></td><td class=SDescription
>Use the x and y axes formatters to format the text in the tooltip.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.tooltipAxisGroups" id=link12
onMouseOver=
"ShowTip(event, 'tt12', 'link12')" onMouseOut=
"HideTip('tt12')">tooltipAxisGroups
</a></td><td class=SDescription
>Show position for the specified axes.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.zoom" id=link13
onMouseOver=
"ShowTip(event, 'tt13', 'link13')" onMouseOut=
"HideTip('tt13')">zoom
</a></td><td class=SDescription
>Enable plot zooming.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.looseZoom" id=link14
onMouseOver=
"ShowTip(event, 'tt14', 'link14')" onMouseOut=
"HideTip('tt14')">looseZoom
</a></td><td class=SDescription
>Will expand zoom range to provide more rounded tick values.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.clickReset" id=link15
onMouseOver=
"ShowTip(event, 'tt15', 'link15')" onMouseOut=
"HideTip('tt15')">clickReset
</a></td><td class=SDescription
>Will reset plot zoom if single click on plot without drag.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.dblClickReset" id=link16
onMouseOver=
"ShowTip(event, 'tt16', 'link16')" onMouseOut=
"HideTip('tt16')">dblClickReset
</a></td><td class=SDescription
>Will reset plot zoom if double click on plot without drag.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showVerticalLine" id=link17
onMouseOver=
"ShowTip(event, 'tt17', 'link17')" onMouseOut=
"HideTip('tt17')">showVerticalLine
</a></td><td class=SDescription
>draw a vertical line across the plot which follows the cursor.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showHorizontalLine" id=link18
onMouseOver=
"ShowTip(event, 'tt18', 'link18')" onMouseOut=
"HideTip('tt18')">showHorizontalLine
</a></td><td class=SDescription
>draw a horizontal line across the plot which follows the cursor.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.constrainZoomTo" id=link19
onMouseOver=
"ShowTip(event, 'tt19', 'link19')" onMouseOut=
"HideTip('tt19')">constrainZoomTo
</a></td><td class=SDescription
>‘none
’,
‘x
’ or
‘y
’</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.intersectionThreshold" id=link20
onMouseOver=
"ShowTip(event, 'tt20', 'link20')" onMouseOut=
"HideTip('tt20')">intersectionThreshold
</a></td><td class=SDescription
>pixel distance from data point or marker to consider cursor lines intersecting with point.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showCursorLegend" id=link21
onMouseOver=
"ShowTip(event, 'tt21', 'link21')" onMouseOut=
"HideTip('tt21')">showCursorLegend
</a></td><td class=SDescription
>Replace the plot legend with an enhanced legend displaying intersection information.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.cursorLegendFormatString" id=link22
onMouseOver=
"ShowTip(event, 'tt22', 'link22')" onMouseOut=
"HideTip('tt22')">cursorLegendFormatString
</a></td><td class=SDescription
>Format string used in the cursor legend.
</td></tr><tr class=
"SProperty SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.constrainOutsideZoom" id=link23
onMouseOver=
"ShowTip(event, 'tt23', 'link23')" onMouseOut=
"HideTip('tt23')">constrainOutsideZoom
</a></td><td class=SDescription
>True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
</td></tr><tr class=
"SProperty SIndent2"><td class=SEntry
><a href=
"#$.jqplot.Cursor.showTooltipOutsideZoom" id=link24
onMouseOver=
"ShowTip(event, 'tt24', 'link24')" onMouseOut=
"HideTip('tt24')">showTooltipOutsideZoom
</a></td><td class=SDescription
>True will keep updating the tooltip when zooming of the grid.
</td></tr><tr class=
"SGroup SIndent1"><td class=SEntry
><a href=
"#$.jqplot.Cursor.methods" >methods
</a></td><td class=SDescription
></td></tr><tr class=
"SFunction SIndent2 SMarked"><td class=SEntry
><a href=
"#$.jqplot.Cursor.$.jqplot.Cursor.zoomProxy" id=link25
onMouseOver=
"ShowTip(event, 'tt25', 'link25')" onMouseOut=
"HideTip('tt25')">$.jqplot.
<wbr>Cursor.
<wbr>zoomProxy
</a></td><td class=SDescription
>links targetPlot to controllerPlot so that plot zooming of targetPlot will be controlled by zooming on the controllerPlot.
</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class=
"CGroup"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.Properties"></a>Properties
</h3></div></div>
18 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.style"></a>style
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.style = 'crosshair'
</td></tr></table></blockquote><p>CSS spec for cursor style
</p></div></div></div>
20 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.show"></a>show
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.show = $.jqplot.config.enablePlugins
</td></tr></table></blockquote><p>wether to show the cursor or not.
</p></div></div></div>
22 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showTooltip"></a>showTooltip
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltip = true
</td></tr></table></blockquote><p>show a cursor position tooltip.
Location of the tooltip will be controlled by followMouse and tooltipLocation.
</p></div></div></div>
24 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.followMouse"></a>followMouse
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.followMouse = false
</td></tr></table></blockquote><p>Tooltip follows the mouse, it is not at a fixed location.
Tooltip will show on the grid at the location given by tooltipLocation, offset from the grid edge by tooltipOffset.
</p></div></div></div>
26 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.tooltipLocation"></a>tooltipLocation
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipLocation = 'se'
</td></tr></table></blockquote><p>Where to position tooltip.
If followMouse is true, this is relative to the cursor, otherwise, it is relative to the grid.
One of
‘n
’,
‘ne
’,
‘e
’,
‘se
’,
‘s
’,
‘sw
’,
‘w
’,
‘nw
’</p></div></div></div>
28 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.tooltipOffset"></a>tooltipOffset
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipOffset =
6</td></tr></table></blockquote><p>Pixel offset of tooltip from the grid boudaries or cursor center.
</p></div></div></div>
30 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showTooltipGridPosition"></a>showTooltipGridPosition
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipGridPosition = false
</td></tr></table></blockquote><p>show the grid pixel coordinates of the mouse.
</p></div></div></div>
32 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showTooltipUnitPosition"></a>showTooltipUnitPosition
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipUnitPosition = true
</td></tr></table></blockquote><p>show the unit (data) coordinates of the mouse.
</p></div></div></div>
34 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showTooltipDataPosition"></a>showTooltipDataPosition
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipDataPosition = false
</td></tr></table></blockquote><p>Used with showVerticalLine to show intersecting data points in the tooltip.
</p></div></div></div>
36 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.tooltipFormatString"></a>tooltipFormatString
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipFormatString = '%
.4P, %
.4P'
</td></tr></table></blockquote><p>sprintf format string for the tooltip.
Uses Ash Searle
’s javascript sprintf implementation found here:
<a href=
"http://hexmen.com/blog/2007/03/printf-sprintf/" class=LURL target=_top
>http://hexmen.com/blog/
2007/
03/printf-sprintf/
</a> See
<a href=
"http://perldoc.perl.org/functions/sprintf.html" class=LURL target=_top
>http://perldoc.perl.org/functions/sprintf.html
</a> for reference Note, if showTooltipDataPosition is true, the default tooltipFormatString will be set to the cursorLegendFormatString, not the default given here.
</p></div></div></div>
38 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.useAxesFormatters"></a>useAxesFormatters
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.useAxesFormatters = true
</td></tr></table></blockquote><p>Use the x and y axes formatters to format the text in the tooltip.
</p></div></div></div>
40 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.tooltipAxisGroups"></a>tooltipAxisGroups
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipAxisGroups = []
</td></tr></table></blockquote><p>Show position for the specified axes.
This is an array like [[
‘xaxis
’,
‘yaxis
’], [
‘xaxis
’,
‘y2axis
’]] Default is to compute automatically for all visible axes.
</p></div></div></div>
42 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.zoom"></a>zoom
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.zoom = false
</td></tr></table></blockquote><p>Enable plot zooming.
</p></div></div></div>
44 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.looseZoom"></a>looseZoom
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.looseZoom = true
</td></tr></table></blockquote><p>Will expand zoom range to provide more rounded tick values.
Works only with linear, log and date axes.
</p></div></div></div>
46 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.clickReset"></a>clickReset
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.clickReset = false
</td></tr></table></blockquote><p>Will reset plot zoom if single click on plot without drag.
</p></div></div></div>
48 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.dblClickReset"></a>dblClickReset
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.dblClickReset = true
</td></tr></table></blockquote><p>Will reset plot zoom if double click on plot without drag.
</p></div></div></div>
50 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showVerticalLine"></a>showVerticalLine
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showVerticalLine = false
</td></tr></table></blockquote><p>draw a vertical line across the plot which follows the cursor.
When the line is near a data point, a special legend and/or tooltip can be updated with the data values.
</p></div></div></div>
52 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showHorizontalLine"></a>showHorizontalLine
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showHorizontalLine = false
</td></tr></table></blockquote><p>draw a horizontal line across the plot which follows the cursor.
</p></div></div></div>
54 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.constrainZoomTo"></a>constrainZoomTo
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.constrainZoomTo = 'none'
</td></tr></table></blockquote><p>’none
’,
‘x
’ or
‘y
’</p></div></div></div>
56 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.intersectionThreshold"></a>intersectionThreshold
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.intersectionThreshold =
2</td></tr></table></blockquote><p>pixel distance from data point or marker to consider cursor lines intersecting with point.
If data point markers are not shown, this should be
>=
1 or will often miss point intersections.
</p></div></div></div>
58 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showCursorLegend"></a>showCursorLegend
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showCursorLegend = false
</td></tr></table></blockquote><p>Replace the plot legend with an enhanced legend displaying intersection information.
</p></div></div></div>
60 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.cursorLegendFormatString"></a>cursorLegendFormatString
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.cursorLegendFormatString = $.jqplot.Cursor.cursorLegendFormatString
</td></tr></table></blockquote><p>Format string used in the cursor legend.
If showTooltipDataPosition is true, this will also be the default format string used by tooltipFormatString.
</p></div></div></div>
62 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.constrainOutsideZoom"></a>constrainOutsideZoom
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.constrainOutsideZoom = true
</td></tr></table></blockquote><p>True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
That is, can
’t zoom out by mousing outside plot.
</p></div></div></div>
64 <div class=
"CProperty"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.showTooltipOutsideZoom"></a>showTooltipOutsideZoom
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipOutsideZoom = false
</td></tr></table></blockquote><p>True will keep updating the tooltip when zooming of the grid.
</p></div></div></div>
66 <div class=
"CGroup"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.methods"></a>methods
</h3></div></div>
68 <div class=
"CFunction"><div class=CTopic
><h3 class=CTitle
><a name=
"$.jqplot.Cursor.$.jqplot.Cursor.zoomProxy"></a>$.jqplot.
<wbr>Cursor.
<wbr>zoomProxy
</h3><div class=CBody
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td><table border=
0 cellspacing=
0 cellpadding=
0><tr><td class=PBeforeParameters nowrap
>$.jqplot.Cursor.zoomProxy = function(
</td><td class=PParameter nowrap
>targetPlot,
</td></tr><tr><td></td><td class=PParameter nowrap
>controllerPlot
</td><td class=PAfterParameters nowrap
>)
</td></tr></table></td></tr></table></blockquote><p>links targetPlot to controllerPlot so that plot zooming of targetPlot will be controlled by zooming on the controllerPlot. controllerPlot will not actually zoom, but acts as an overview plot.
Note, the zoom options must be set to true for zoomProxy to work.
</p></div></div></div>
73 <div id=Footer
>Copyright
© 2009 -
2010 Chris Leonello
· Updated October
7th,
2012 · <a href=
"http://www.naturaldocs.org">Generated by Natural Docs
</a></div><!--Footer-->
76 <div id=Menu
><div class=MEntry
><div class=MGroup
><a href=
"javascript:ToggleMenu('MGroupContent1')">Usage and Options
</a><div class=MGroupContent id=MGroupContent1
><div class=MEntry
><div class=MFile
><a href=
"../usage-txt.html">Usage
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqPlotOptions-txt.html">jqPlot Options
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../optionsTutorial-txt.html">Options Tutorial
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqPlotCssStyling-txt.html">jqPlot CSS Customization
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../changes-txt.html">Change Log
</a></div></div><div class=MEntry
><div class=MLink
><a href=
"../../tests/">Examples
</a></div></div></div></div></div><div class=MEntry
><div class=MGroup
><a href=
"javascript:ToggleMenu('MGroupContent4')">API Documentation
</a><div class=MGroupContent id=MGroupContent4
><div class=MEntry
><div class=MFile
><a href=
"../jqplot-core-js.html">jqPlot Charts
</a></div></div><div class=MEntry
><div class=MGroup
><a href=
"javascript:ToggleMenu('MGroupContent2')">Core Renderers
</a><div class=MGroupContent id=MGroupContent2
><div class=MEntry
><div class=MFile
><a href=
"../jqplot-axisTickRenderer-js.html">Axis Tick Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-canvasGridRenderer-js.html">Canvas Grid Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-divTitleRenderer-js.html">Div Title Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-linearAxisRenderer-js.html">Linear Axis Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-markerRenderer-js.html">Marker Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-shapeRenderer-js.html">Shape Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-shadowRenderer-js.html">Shadow Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-lineRenderer-js.html">Line Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-axisLabelRenderer-js.html">Axis Label Renderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-themeEngine-js.html">Theme Engine
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../jqplot-toImage-js.html">fn
</a></div></div></div></div></div><div class=MEntry
><div class=MGroup
><a href=
"javascript:ToggleMenu('MGroupContent3')">Plugins
</a><div class=MGroupContent id=MGroupContent3
><div class=MEntry
><div class=MFile
><a href=
"jqplot-barRenderer-js.html">jqplot.
<wbr>BarRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-BezierCurveRenderer-js.html">jqplot.
<wbr>BezierCurveRenderer.js
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-blockRenderer-js.html">jqplot.
<wbr>BlockRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-bubbleRenderer-js.html">jqplot.
<wbr>BubbleRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-canvasAxisLabelRenderer-js.html">jqplot.
<wbr>CanvasAxisLabelRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-canvasAxisTickRenderer-js.html">jqplot.
<wbr>CanvasAxisTickRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-pyramidGridRenderer-js.html">jqplot.
<wbr>CanvasGridRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-canvasOverlay-js.html">jqplot.
<wbr>CanvasOverlay
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-categoryAxisRenderer-js.html">jqplot.
<wbr>CategoryAxisRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-ciParser-js.html">jqplot.
<wbr>ciParser
</a></div></div><div class=MEntry
><div class=MFile id=MSelected
>jqplot.
<wbr>Cursor
</div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-dateAxisRenderer-js.html">jqplot.
<wbr>DateAxisRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-donutRenderer-js.html">jqplot.
<wbr>DonutRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-dragable-js.html">jqplot.
<wbr>Dragable
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-enhancedLegendRenderer-js.html">jqplot.
<wbr>enhancedLegendRenderer.js
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-funnelRenderer-js.html">jqplot.
<wbr>FunnelRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-highlighter-js.html">jqplot.
<wbr>Highlighter
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-logAxisRenderer-js.html">jqplot.
<wbr>LogAxisRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-mekkoAxisRenderer-js.html">jqplot.
<wbr>MekkoAxisRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-mekkoRenderer-js.html">jqplot.
<wbr>MekkoRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-meterGaugeRenderer-js.html">jqplot.
<wbr>MeterGaugeRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-ohlcRenderer-js.html">jqplot.
<wbr>OHLCRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-pieRenderer-js.html">jqplot.
<wbr>PieRenderer
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-pointLabels-js.html">jqplot.
<wbr>PointLabels
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-pyramidAxisRenderer-js.html">jqplot.
<wbr>pyramidAxisRenderer.js
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-pyramidRenderer-js.html">jqplot.
<wbr>pyramidRenderer.js
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"jqplot-trendline-js.html">jqplot.
<wbr>Trendline
</a></div></div></div></div></div></div></div></div><div class=MEntry
><div class=MFile
><a href=
"../gpl-2-0-txt.html">GPL License
</a></div></div><div class=MEntry
><div class=MFile
><a href=
"../MIT-LICENSE-txt.html">MIT License
</a></div></div><div class=MEntry
><div class=MGroup
><a href=
"javascript:ToggleMenu('MGroupContent5')">Index
</a><div class=MGroupContent id=MGroupContent5
><div class=MEntry
><div class=MIndex
><a href=
"../../index/General.html">Everything
</a></div></div><div class=MEntry
><div class=MIndex
><a href=
"../../index/Classes.html">Classes
</a></div></div><div class=MEntry
><div class=MIndex
><a href=
"../../index/Properties.html">Properties
</a></div></div><div class=MEntry
><div class=MIndex
><a href=
"../../index/Functions.html">Functions
</a></div></div><div class=MEntry
><div class=MIndex
><a href=
"../../index/Hooks.html">Hooks
</a></div></div><div class=MEntry
><div class=MIndex
><a href=
"../../index/Files.html">Files
</a></div></div></div></div></div><script type=
"text/javascript"><!--
77 var searchPanel
= new SearchPanel("searchPanel", "HTML", "../../search");
78 --></script><div id=MSearchPanel class=MSearchPanelInactive
><input type=text id=MSearchField value=Search
onFocus=
"searchPanel.OnSearchFieldFocus(true)" onBlur=
"searchPanel.OnSearchFieldFocus(false)" onKeyUp=
"searchPanel.OnSearchFieldChange()"><select id=MSearchType
onFocus=
"searchPanel.OnSearchTypeFocus(true)" onBlur=
"searchPanel.OnSearchTypeFocus(false)" onChange=
"searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected
value=
"General">Everything
</option><option value=
"Classes">Classes
</option><option value=
"Files">Files
</option><option value=
"Functions">Functions
</option><option value=
"Hooks">Hooks
</option><option value=
"Properties">Properties
</option></select></div><script language=JavaScript
><!--
79 HideAllBut([3, 4], 6);// --></script></div><!--Menu-->
83 <!--START_ND_TOOLTIPS-->
84 <div class=CToolTip
id=
"tt1"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.style = 'crosshair'
</td></tr></table></blockquote>CSS spec for cursor style
</div></div><div class=CToolTip
id=
"tt2"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.show = $.jqplot.config.enablePlugins
</td></tr></table></blockquote>wether to show the cursor or not.
</div></div><div class=CToolTip
id=
"tt3"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltip = true
</td></tr></table></blockquote>show a cursor position tooltip.
</div></div><div class=CToolTip
id=
"tt4"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.followMouse = false
</td></tr></table></blockquote>Tooltip follows the mouse, it is not at a fixed location.
</div></div><div class=CToolTip
id=
"tt5"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipLocation = 'se'
</td></tr></table></blockquote>Where to position tooltip.
</div></div><div class=CToolTip
id=
"tt6"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipOffset =
6</td></tr></table></blockquote>Pixel offset of tooltip from the grid boudaries or cursor center.
</div></div><div class=CToolTip
id=
"tt7"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipGridPosition = false
</td></tr></table></blockquote>show the grid pixel coordinates of the mouse.
</div></div><div class=CToolTip
id=
"tt8"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipUnitPosition = true
</td></tr></table></blockquote>show the unit (data) coordinates of the mouse.
</div></div><div class=CToolTip
id=
"tt9"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipDataPosition = false
</td></tr></table></blockquote>Used with showVerticalLine to show intersecting data points in the tooltip.
</div></div><div class=CToolTip
id=
"tt10"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipFormatString = '%
.4P, %
.4P'
</td></tr></table></blockquote>sprintf format string for the tooltip.
</div></div><div class=CToolTip
id=
"tt11"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.useAxesFormatters = true
</td></tr></table></blockquote>Use the x and y axes formatters to format the text in the tooltip.
</div></div><div class=CToolTip
id=
"tt12"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.tooltipAxisGroups = []
</td></tr></table></blockquote>Show position for the specified axes.
</div></div><div class=CToolTip
id=
"tt13"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.zoom = false
</td></tr></table></blockquote>Enable plot zooming.
</div></div><div class=CToolTip
id=
"tt14"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.looseZoom = true
</td></tr></table></blockquote>Will expand zoom range to provide more rounded tick values.
</div></div><div class=CToolTip
id=
"tt15"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.clickReset = false
</td></tr></table></blockquote>Will reset plot zoom if single click on plot without drag.
</div></div><div class=CToolTip
id=
"tt16"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.dblClickReset = true
</td></tr></table></blockquote>Will reset plot zoom if double click on plot without drag.
</div></div><div class=CToolTip
id=
"tt17"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showVerticalLine = false
</td></tr></table></blockquote>draw a vertical line across the plot which follows the cursor.
</div></div><div class=CToolTip
id=
"tt18"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showHorizontalLine = false
</td></tr></table></blockquote>draw a horizontal line across the plot which follows the cursor.
</div></div><div class=CToolTip
id=
"tt19"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.constrainZoomTo = 'none'
</td></tr></table></blockquote>‘none
’,
‘x
’ or
‘y
’</div></div><div class=CToolTip
id=
"tt20"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.intersectionThreshold =
2</td></tr></table></blockquote>pixel distance from data point or marker to consider cursor lines intersecting with point.
</div></div><div class=CToolTip
id=
"tt21"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showCursorLegend = false
</td></tr></table></blockquote>Replace the plot legend with an enhanced legend displaying intersection information.
</div></div><div class=CToolTip
id=
"tt22"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.cursorLegendFormatString = $.jqplot.Cursor.cursorLegendFormatString
</td></tr></table></blockquote>Format string used in the cursor legend.
</div></div><div class=CToolTip
id=
"tt23"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.constrainOutsideZoom = true
</td></tr></table></blockquote>True to limit actual zoom area to edges of grid, even when zooming outside of plot area.
</div></div><div class=CToolTip
id=
"tt24"><div class=CProperty
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td>this.showTooltipOutsideZoom = false
</td></tr></table></blockquote>True will keep updating the tooltip when zooming of the grid.
</div></div><div class=CToolTip
id=
"tt25"><div class=CFunction
><blockquote><table border=
0 cellspacing=
0 cellpadding=
0 class=Prototype
><tr><td><table border=
0 cellspacing=
0 cellpadding=
0><tr><td class=PBeforeParameters nowrap
>$.jqplot.Cursor.zoomProxy = function(
</td><td class=PParameter nowrap
>targetPlot,
</td></tr><tr><td></td><td class=PParameter nowrap
>controllerPlot
</td><td class=PAfterParameters nowrap
>)
</td></tr></table></td></tr></table></blockquote>links targetPlot to controllerPlot so that plot zooming of targetPlot will be controlled by zooming on the controllerPlot.
</div></div><!--END_ND_TOOLTIPS-->
89 <div id=MSearchResultsWindow
><iframe src=
"" frameborder=
0 name=MSearchResults id=MSearchResults
></iframe><a href=
"javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose
>Close
</a></div>
92 <script language=JavaScript
><!--
93 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>