<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<h1>Modules</h1>
<ul>
<li>
<a href="../modules/awesome.html">awesome</a>
</li>
<li>
<a href="../modules/awful.html">awful</a>
</li>
<li>
<a href="../modules/awful.autofocus.html">awful.autofocus</a>
</li>
<li>
<a href="../modules/awful.button.html">awful.button</a>
</li>
<li>
<a href="../modules/awful.client.html">awful.client</a>
</li>
<li>
<a href="../modules/awful.completion.html">awful.completion</a>
</li>
<li>
<a href="../modules/awful.dbus.html">awful.dbus</a>
</li>
<li>
<a href="../modules/awful.hooks.html">awful.hooks</a>
</li>
<li>
<a href="../modules/awful.key.html">awful.key</a>
</li>
<li>
<a href="../modules/awful.layout.html">awful.layout</a>
</li>
<li>
<a href="../modules/awful.layout.suit.html">awful.layout.suit</a>
</li>
<li>
<a href="../modules/awful.layout.suit.fair.html">awful.layout.suit.fair</a>
</li>
<li>
<a href="../modules/awful.layout.suit.floating.html">awful.layout.suit.floating</a>
</li>
<li>
<a href="../modules/awful.layout.suit.magnifier.html">awful.layout.suit.magnifier</a>
</li>
<li>
<a href="../modules/awful.layout.suit.max.html">awful.layout.suit.max</a>
</li>
<li>
<a href="../modules/awful.layout.suit.spiral.html">awful.layout.suit.spiral</a>
</li>
<li>
<a href="../modules/awful.layout.suit.tile.html">awful.layout.suit.tile</a>
</li>
<li>
<a href="../modules/awful.menu.html">awful.menu</a>
</li>
<li>
<a href="../modules/awful.mouse.html">awful.mouse</a>
</li>
<li>
<a href="../modules/awful.mouse.finder.html">awful.mouse.finder</a>
</li>
<li>
<a href="../modules/awful.placement.html">awful.placement</a>
</li>
<li>
<a href="../modules/awful.prompt.html">awful.prompt</a>
</li>
<li>
<a href="../modules/awful.remote.html">awful.remote</a>
</li>
<li>
<a href="../modules/awful.rules.html">awful.rules</a>
</li>
<li>
<a href="../modules/awful.screen.html">awful.screen</a>
</li>
<li>
<a href="../modules/awful.startup_notification.html">awful.startup_notification</a>
</li>
<li>
<a href="../modules/awful.tag.html">awful.tag</a>
</li>
<li>
<a href="../modules/awful.titlebar.html">awful.titlebar</a>
</li>
<li>
<a href="../modules/awful.tooltip.html">awful.tooltip</a>
</li>
<li>
<a href="../modules/awful.util.html">awful.util</a>
</li>
<li>
<a href="../modules/awful.wibox.html">awful.wibox</a>
</li>
<li>
<a href="../modules/awful.widget.html">awful.widget</a>
</li>
<li>
<a href="../modules/awful.widget.button.html">awful.widget.button</a>
</li>
<li>
<a href="../modules/awful.widget.common.html">awful.widget.common</a>
</li>
<li><strong>awful.widget.graph</strong></li>
<li>
<a href="../modules/awful.widget.launcher.html">awful.widget.launcher</a>
</li>
<li>
<a href="../modules/awful.widget.layout.html">awful.widget.layout</a>
</li>
<li>
<a href="../modules/awful.widget.layout.default.html">awful.widget.layout.default</a>
</li>
<li>
<a href="../modules/awful.widget.layout.horizontal.html">awful.widget.layout.horizontal</a>
</li>
<li>
<a href="../modules/awful.widget.layout.vertical.html">awful.widget.layout.vertical</a>
</li>
<li>
<a href="../modules/awful.widget.layoutbox.html">awful.widget.layoutbox</a>
</li>
<li>
<a href="../modules/awful.widget.progressbar.html">awful.widget.progressbar</a>
</li>
<li>
<a href="../modules/awful.widget.prompt.html">awful.widget.prompt</a>
</li>
<li>
<a href="../modules/awful.widget.taglist.html">awful.widget.taglist</a>
</li>
<li>
<a href="../modules/awful.widget.tasklist.html">awful.widget.tasklist</a>
</li>
<li>
<a href="../modules/awful.widget.textclock.html">awful.widget.textclock</a>
</li>
<li>
<a href="../modules/beautiful.html">beautiful</a>
</li>
<li>
<a href="../modules/button.html">button</a>
</li>
<li>
<a href="../modules/client.html">client</a>
</li>
<li>
<a href="../modules/dbus.html">dbus</a>
</li>
<li>
<a href="../modules/image.html">image</a>
</li>
<li>
<a href="../modules/key.html">key</a>
</li>
<li>
<a href="../modules/keygrabber.html">keygrabber</a>
</li>
<li>
<a href="../modules/mouse.html">mouse</a>
</li>
<li>
<a href="../modules/mousegrabber.html">mousegrabber</a>
</li>
<li>
<a href="../modules/naughty.html">naughty</a>
</li>
<li>
<a href="../modules/root.html">root</a>
</li>
<li>
<a href="../modules/screen.html">screen</a>
</li>
<li>
<a href="../modules/selection.html">selection</a>
</li>
<li>
<a href="../modules/tag.html">tag</a>
</li>
<li>
<a href="../modules/timer.html">timer</a>
</li>
<li>
<a href="../modules/wibox.html">wibox</a>
</li>
<li>
<a href="../modules/widget.html">widget</a>
</li>
</ul>
<!-- File list -->
</div><!-- id="navigation" -->
<div id="content">
<h1>Module <code>awful.widget.graph</code></h1>
<p>A graph widget.</p>
<p><b>Author:</b>
<table class="authors_list">
<tr><td class="name">Julien Danjou <julien@danjou.info></td></tr>
</table>
</p>
<p>Copyright© 2009 Julien Danjou</p>
<p><small><b>Release:</b> v3.4.15 </small></p>
<h2>Functions</h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#add_value">add_value</a> (graph, value, group)</td>
<td class="summary">Add a value to the graph </td>
</tr>
<tr>
<td class="name" nowrap><a href="#new">new</a> (args)</td>
<td class="summary">Create a graph widget.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_background_color">set_background_color</a> (graph, color)</td>
<td class="summary">Set the graph background color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_border_color">set_border_color</a> (graph, color)</td>
<td class="summary">Set the graph border color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_color">set_color</a> (graph, color)</td>
<td class="summary">Set the graph foreground color.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_gradient_angle">set_gradient_angle</a> (graph, gradient_angle)</td>
<td class="summary">Set the graph foreground colors gradient angle.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_gradient_colors">set_gradient_colors</a> (graph, gradient_colors)</td>
<td class="summary">Set the graph foreground color as a gradient.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_height">set_height</a> (graph, height)</td>
<td class="summary">Set the graph height.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_max_value">set_max_value</a> (graph, value)</td>
<td class="summary">Set the maximum value the graph should handle.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_scale">set_scale</a> (graph, scale)</td>
<td class="summary">Set the graph to automatically scale its values.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_stack">set_stack</a> (graph, stack)</td>
<td class="summary">Set the graph to draw stacks.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_stack_colors">set_stack_colors</a> (graph, stack_colors)</td>
<td class="summary">Set the graph stacking colors.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#set_width">set_width</a> (graph, width)</td>
<td class="summary">Set the graph width.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="functions"></a>Functions</h2>
<dl class="function">
<dt><a name="add_value"></a><strong>add_value</strong> (graph, value, group)</dt>
<dd>
Add a value to the graph
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
value: The value between 0 and 1.
</li>
<li>
group: The stack color group index.
</li>
</ul>
</dd>
<dt><a name="new"></a><strong>new</strong> (args)</dt>
<dd>
Create a graph widget.
<h3>Parameters</h3>
<ul>
<li>
args: Standard widget() arguments. You should add width and height key to set graph geometry.
</li>
</ul>
<h3>Return value:</h3>
A graph widget.
</dd>
<dt><a name="set_background_color"></a><strong>set_background_color</strong> (graph, color)</dt>
<dd>
Set the graph background color.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
color: The graph background color.
</li>
</ul>
</dd>
<dt><a name="set_border_color"></a><strong>set_border_color</strong> (graph, color)</dt>
<dd>
Set the graph border color. If the value is nil, no border will be drawn.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
color: The border color to set.
</li>
</ul>
</dd>
<dt><a name="set_color"></a><strong>set_color</strong> (graph, color)</dt>
<dd>
Set the graph foreground color.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
color: The graph color.
</li>
</ul>
</dd>
<dt><a name="set_gradient_angle"></a><strong>set_gradient_angle</strong> (graph, gradient_angle)</dt>
<dd>
Set the graph foreground colors gradient angle. Default is 270 degrees (horizontal).
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
gradient_angle: Angle of gradient in degrees.
</li>
</ul>
</dd>
<dt><a name="set_gradient_colors"></a><strong>set_gradient_colors</strong> (graph, gradient_colors)</dt>
<dd>
Set the graph foreground color as a gradient.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
gradient_colors: A table with gradients colors. The distance between each color can also be specified. Example: { "red", "blue" } or { "red", "green", "blue", blue = 10 } to specify blue distance from other colors.
</li>
</ul>
</dd>
<dt><a name="set_height"></a><strong>set_height</strong> (graph, height)</dt>
<dd>
Set the graph height.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
height: The height to set.
</li>
</ul>
</dd>
<dt><a name="set_max_value"></a><strong>set_max_value</strong> (graph, value)</dt>
<dd>
Set the maximum value the graph should handle. If "scale" is also set, the graph never scales up below this value, but it automatically scales down to make all data fit.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
value: The value.
</li>
</ul>
</dd>
<dt><a name="set_scale"></a><strong>set_scale</strong> (graph, scale)</dt>
<dd>
Set the graph to automatically scale its values. Default is false.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
scale: A boolean value
</li>
</ul>
</dd>
<dt><a name="set_stack"></a><strong>set_stack</strong> (graph, stack)</dt>
<dd>
Set the graph to draw stacks. Default is false.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
stack: A boolean value.
</li>
</ul>
</dd>
<dt><a name="set_stack_colors"></a><strong>set_stack_colors</strong> (graph, stack_colors)</dt>
<dd>
Set the graph stacking colors. Order matters.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
stack_colors: A table with stacking colors.
</li>
</ul>
</dd>
<dt><a name="set_width"></a><strong>set_width</strong> (graph, width)</dt>
<dd>
Set the graph width.
<h3>Parameters</h3>
<ul>
<li>
graph: The graph.
</li>
<li>
width: The width to set.
</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
