egroupware/phpgwapi/js/jquery/jqplot/docs/files/plugins/jqplot-bubbleRenderer-js.html

71 lines
23 KiB
HTML
Raw Normal View History

2011-08-10 01:10:50 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>$.jqplot.BubbleRenderer</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><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.4 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<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>&gt;</span>Home</a><a class="nav" href="../../../tests/"><span>&gt;</span>Examples</a><a class="nav" href="../../../docs/"><span>&gt;</span>Docs</a><a class="nav" href="http://bitbucket.org/cleonello/jqplot/downloads/"><span>&gt;</span>Download</a><a class="nav" href="../../../info.php"><span>&gt;</span>Info</a><a class="nav" href="../../../donate.php"><span>&gt;</span>Donate</a></div><a name="$.jqplot.BubbleRenderer"></a>$.jqplot.<wbr>BubbleRenderer</div><div class=CBody><p>Plugin renderer to draw a bubble chart.&nbsp; A Bubble chart has data points displayed as colored circles with an optional text label inside.&nbsp; To use the bubble renderer, you must include the bubble renderer like:</p><blockquote><pre>&lt;script language=&quot;javascript&quot; type=&quot;text/javascript&quot; src=&quot;../src/plugins/jqplot.bubbleRenderer.js&quot;&gt;&lt;/script&gt;</pre></blockquote><p>Data must be supplied in the form:</p><blockquote><pre>[[x1, y1, r1, &lt;label or {label:'text', color:color}&gt;], ...]</pre></blockquote><p>where the label or options object is optional.</p><p>Note that all bubble colors will be the same unless the &ldquo;varyBubbleColors&rdquo; option is set to true.&nbsp; Colors can be specified in the data array or in the seriesColors array option on the series.&nbsp; If no colors are defined, the default jqPlot series of 16 colors are used.&nbsp; Colors are automatically cycled around again if there are more bubbles than colors.</p><p>Bubbles are autoscaled by default to fit within the chart area while maintaining relative sizes.&nbsp; If the &ldquo;autoscaleBubbles&rdquo; option is set to false, the r(adius) values in the data array a treated as literal pixel values for the radii of the bubbles.</p><p>Properties are passed into the bubble renderer in the rendererOptions object of the series options like:</p><blockquote><pre>seriesDefaults: {
renderer: $.jqplot.BubbleRenderer,
rendererOptions: {
bubbleAlpha: 0.7,
varyBubbleColors: false
}
}</pre></blockquote><!--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.BubbleRenderer" >$.jqplot.<wbr>BubbleRenderer</a></td><td class=SDescription>Plugin renderer to draw a bubble chart. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.varyBubbleColors" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">varyBubbleColors</a></td><td class=SDescription>True to vary the color of each bubble in this series according to the seriesColors array. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.autoscaleBubbles" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">autoscaleBubbles</a></td><td class=SDescription>True to scale the bubble radius based on plot size. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.autoscaleMultiplier" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">autoscaleMultiplier</a></td><td class=SDescription>Multiplier the bubble size if autoscaleBubbles is true.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.autoscalePointsFactor" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">autoscalePointsFactor</a></td><td class=SDescription>Factor which decreases bubble size based on how many bubbles on on the chart. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.escapeHtml" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">escapeHtml</a></td><td class=SDescription>True to escape html in bubble label text.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.highlightMouseOver" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">highlightMouseOver</a></td><td class=SDescription>True to highlight bubbles when moused over. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.highlightMouseDown" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">highlightMouseDown</a></td><td class=SDescription>True to highlight when a mouse button is pressed over a bubble. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.highlightColors" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">highlightColors</a></td><td class=SDescription>An array of colors to use when highlighting a slice. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.bubbleAlpha" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">bubbleAlpha</a></td><td class=SDescription>Alpha transparency to apply to all bubbles in this series.</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.highlightAlpha" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">highlightAlpha</a></td><td class=SDescription>Alpha transparency to apply when highlighting bubble. </td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.bubbleGradients" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">bubbleGradients</a></td><td class=SDescription>True to color the bubbles with gradient fills instead of flat colors. </td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#$.jqplot.BubbleRenderer.showLabels" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">showLabels</a></td><td class=SDescription>True to show labels on bubbles
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.Properties"></a>Properties</h3></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.varyBubbleColors"></a>varyBubbleColors</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.varyBubbleColors = true</td></tr></table></blockquote><p>True to vary the color of each bubble in this series according to the seriesColors array.&nbsp; False to set each bubble to the color specified on this series.&nbsp; This has no effect if a css background color option is specified in the renderer css options.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.autoscaleBubbles"></a>autoscaleBubbles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscaleBubbles = true</td></tr></table></blockquote><p>True to scale the bubble radius based on plot size.&nbsp; False will use the radius value as provided as a raw pixel value for bubble radius.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.autoscaleMultiplier"></a>autoscaleMultiplier</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscaleMultiplier = 1.0</td></tr></table></blockquote><p>Multiplier the bubble size if autoscaleBubbles is true.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.autoscalePointsFactor"></a>autoscalePointsFactor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscalePointsFactor = -0.07</td></tr></table></blockquote><p>Factor which decreases bubble size based on how many bubbles on on the chart.&nbsp; 0 means no adjustment for number of bubbles.&nbsp; Negative values will decrease size of bubbles as more bubbles are added.&nbsp; Values between 0 and -0.2 should work well.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.escapeHtml"></a>escapeHtml</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.escapeHtml = true</td></tr></table></blockquote><p>True to escape html in bubble label text.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.highlightMouseOver"></a>highlightMouseOver</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightMouseOver = true</td></tr></table></blockquote><p>True to highlight bubbles when moused over.&nbsp; This must be false to enable highlightMouseDown to highlight when clicking on a slice.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.highlightMouseDown"></a>highlightMouseDown</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightMouseDown = false</td></tr></table></blockquote><p>True to highlight when a mouse button is pressed over a bubble.&nbsp; This will be disabled if highlightMouseOver is true.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.highlightColors"></a>highlightColors</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightColors = []</td></tr></table></blockquote><p>An array of colors to use when highlighting a slice.&nbsp; Calculated automatically if not supplied.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.bubbleAlpha"></a>bubbleAlpha</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.bubbleAlpha = 1.0</td></tr></table></blockquote><p>Alpha transparency to apply to all bubbles in this series.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.highlightAlpha"></a>highlightAlpha</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightAlpha = null</td></tr></table></blockquote><p>Alpha transparency to apply when highlighting bubble.&nbsp; Set to value of bubbleAlpha by default.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.bubbleGradients"></a>bubbleGradients</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.bubbleGradients = false</td></tr></table></blockquote><p>True to color the bubbles with gradient fills instead of flat colors.&nbsp; NOT AVAILABLE IN IE due to lack of excanvas support for radial gradient fills. will be ignored in IE.</p></div></div></div>
<div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="$.jqplot.BubbleRenderer.showLabels"></a>showLabels</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.showLabels = true</td></tr></table></blockquote><p>True to show labels on bubbles (if any), false to not show.</p></div></div></div>
</div><!--Content-->
<div id=Footer>Copyright &copy; 2009 - 2010 Chris Leonello&nbsp; &middot;&nbsp; Updated October 13th, 2011&nbsp; &middot;&nbsp; <a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2011-08-10 01:10:50 +02:00
<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 id=MSelected>jqplot.<wbr>BubbleRenderer</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><a href="jqplot-cursor-js.html">jqplot.<wbr>Cursor</a></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-j
2011-08-10 01:10:50 +02:00
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></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><!--
HideAllBut([3, 4], 6);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.varyBubbleColors = true</td></tr></table></blockquote>True to vary the color of each bubble in this series according to the seriesColors array. </div></div><div class=CToolTip id="tt2"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscaleBubbles = true</td></tr></table></blockquote>True to scale the bubble radius based on plot size. </div></div><div class=CToolTip id="tt3"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscaleMultiplier = 1.0</td></tr></table></blockquote>Multiplier the bubble size if autoscaleBubbles is true.</div></div><div class=CToolTip id="tt4"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.autoscalePointsFactor = -0.07</td></tr></table></blockquote>Factor which decreases bubble size based on how many bubbles on on the chart. </div></div><div class=CToolTip id="tt5"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.escapeHtml = true</td></tr></table></blockquote>True to escape html in bubble label text.</div></div><div class=CToolTip id="tt6"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightMouseOver = true</td></tr></table></blockquote>True to highlight bubbles when moused over. </div></div><div class=CToolTip id="tt7"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightMouseDown = false</td></tr></table></blockquote>True to highlight when a mouse button is pressed over a bubble. </div></div><div class=CToolTip id="tt8"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightColors = []</td></tr></table></blockquote>An array of colors to use when highlighting a slice. </div></div><div class=CToolTip id="tt9"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.bubbleAlpha = 1.0</td></tr></table></blockquote>Alpha transparency to apply to all bubbles in this series.</div></div><div class=CToolTip id="tt10"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.highlightAlpha = null</td></tr></table></blockquote>Alpha transparency to apply when highlighting bubble. </div></div><div class=CToolTip id="tt11"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.bubbleGradients = false</td></tr></table></blockquote>True to color the bubbles with gradient fills instead of flat colors. </div></div><div class=CToolTip id="tt12"><div class=CProperty><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>this.showLabels = true</td></tr></table></blockquote>True to show labels on bubbles (if any), false to not show.</div></div><!--END_ND_TOOLTIPS-->
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>