dygraphs
Version:
dygraphs is a fast, flexible open source JavaScript charting library.
613 lines (395 loc) • 12.8 kB
HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>JsDoc Reference - DygraphLayout</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
width: 800px;
}
.header
{
clear: both;
background-color: #ccc;
padding: 8px;
}
h1
{
font-size: 150%;
font-weight: bold;
padding: 0;
margin: 1em 0 0 .3em;
}
hr
{
border: none 0;
border-top: 1px solid #7F8FB1;
height: 1px;
}
pre.code
{
display: block;
padding: 8px;
border: 1px dashed #ccc;
}
#index
{
margin-top: 24px;
float: left;
width: 160px;
position: absolute;
left: 8px;
background-color: #F3F3F3;
padding: 8px;
}
#content
{
margin-left: 190px;
width: 600px;
}
.classList
{
list-style-type: none;
padding: 0;
margin: 0 0 0 8px;
font-family: arial, sans-serif;
font-size: 1em;
overflow: auto;
}
.classList li
{
padding: 0;
margin: 0 0 8px 0;
}
.summaryTable { width: 100%; }
h1.classTitle
{
font-size:170%;
line-height:130%;
}
h2 { font-size: 110%; }
caption, div.sectionTitle
{
background-color: #7F8FB1;
color: #fff;
font-size:130%;
text-align: left;
padding: 2px 6px 2px 6px;
border: 1px #7F8FB1 solid;
}
div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }
.summaryTable td
{
vertical-align: top;
padding: 4px;
border-bottom: 1px #7F8FB1 solid;
border-right: 1px #7F8FB1 solid;
}
/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
border-left: 1px #7F8FB1 solid;
width: 140px;
text-align: right;
}
td.attributes, .fixedFont
{
line-height: 15px;
color: #002EBE;
font-family: "Courier New",Courier,monospace;
font-size: 13px;
}
.summaryTable td.nameDescription
{
text-align: left;
font-size: 13px;
line-height: 15px;
}
.summaryTable td.nameDescription, .description
{
line-height: 15px;
padding: 4px;
padding-left: 4px;
}
.summaryTable { margin-bottom: 8px; }
ul.inheritsList
{
list-style: square;
margin-left: 20px;
padding-left: 0;
}
.detailList {
margin-left: 20px;
line-height: 15px;
}
.detailList dt { margin-left: 20px; }
.detailList .heading
{
font-weight: bold;
padding-bottom: 6px;
margin-left: 0;
}
.light, td.attributes, .light a:link, .light a:visited
{
color: #777;
font-style: italic;
}
.fineprint
{
text-align: right;
font-size: 10px;
}
</style>
</head>
<body>
<!-- ============================== header ================================= -->
<!-- begin static/header.html -->
<div id="header">
</div>
<!-- end static/header.html -->
<!-- ============================== classes index ============================ -->
<div id="index">
<!-- begin publish.classesIndex -->
<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
<li><a href="../symbols/Dygraph.html">Dygraph</a></li>
<li><a href="../symbols/DygraphCanvasRenderer.html">DygraphCanvasRenderer</a></li>
<li><a href="../symbols/DygraphInteraction.html">DygraphInteraction</a></li>
<li><a href="../symbols/DygraphLayout.html">DygraphLayout</a></li>
<li><a href="../symbols/DygraphOptions.html">DygraphOptions</a></li>
<li><a href="../symbols/grid.html">grid</a></li>
<li><a href="../symbols/GVizChart.html">GVizChart</a></li>
<li><a href="../symbols/GVizDataTable.html">GVizDataTable</a></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Class DygraphLayout
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
<br /><i>Defined in: </i> <a href="../symbols/src/src_dygraph-layout.js.html">dygraph-layout.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class DygraphLayout.">
<caption>Class Summary</caption>
<thead>
<tr>
<th scope="col">Constructor Attributes</th>
<th scope="col">Constructor Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/DygraphLayout.html#constructor">DygraphLayout</a></b>(dygraph)
</div>
<div class="description">Creates a new DygraphLayout object.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class DygraphLayout.">
<caption>Field Summary</caption>
<thead>
<tr>
<th scope="col">Field Attributes</th>
<th scope="col">Field Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont">
<b><a href="../symbols/DygraphLayout.html#points">points</a></b>
</div>
<div class="description">Array of points for each series.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class DygraphLayout.">
<caption>Method Summary</caption>
<thead>
<tr>
<th scope="col">Method Attributes</th>
<th scope="col">Method Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/DygraphLayout.html#addDataset">addDataset</a></b>(setname, set_xy)
</div>
<div class="description">Add points for a single series.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">DygraphLayout.<b><a href="../symbols/DygraphLayout.html#.calcYNormal_">calcYNormal_</a></b>(axis, value, logscale)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/DygraphLayout.html#getPlotArea">getPlotArea</a></b>()
</div>
<div class="description">Returns the box which the chart should be drawn in.</div>
</td>
</tr>
<tr>
<td class="attributes"> </td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/DygraphLayout.html#removeAllDatasets">removeAllDatasets</a></b>()
</div>
<div class="description">Convenience function to remove all the data sets from a graph</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Class Detail
</div>
<div class="fixedFont">
<b>DygraphLayout</b>(dygraph)
</div>
<div class="description">
Creates a new DygraphLayout object.
This class contains all the data to be charted.
It uses data coordinates, but also records the chart range (in data
coordinates) and hence is able to calculate percentage positions ('In this
view, Point A lies 25% down the x-axis.')
Two things that it does not do are:
1. Record pixel coordinates for anything.
2. (oddly) determine anything about the layout of chart elements.
The naming is a vestige of Dygraph's original PlotKit roots.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>dygraph</b>
</dt>
<dd></dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<div class="sectionTitle">
Field Detail
</div>
<a name="points"> </a>
<div class="fixedFont">
<b>points</b>
</div>
<div class="description">
Array of points for each series.
[series index][row index in series] = |Point| structure,
where series index refers to visible series only, and the
point index is for the reduced set of points for the current
zoom region (including one point just outside the window).
All points in the same row index share the same X value.
</div>
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="addDataset"> </a>
<div class="fixedFont">
<b>addDataset</b>(setname, set_xy)
</div>
<div class="description">
Add points for a single series.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string}</span> <b>setname</b>
</dt>
<dd>Name of the series.</dd>
<dt>
<span class="light fixedFont">{Array.<Dygraph.PointType>}</span> <b>set_xy</b>
</dt>
<dd>Points for the series.</dd>
</dl>
<hr />
<a name=".calcYNormal_"> </a>
<div class="fixedFont"><static>
<span class="light">{number}</span>
<span class="light">DygraphLayout.</span><b>calcYNormal_</b>(axis, value, logscale)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{DygraphAxisType}</span> <b>axis</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{number}</span> <b>value</b>
</dt>
<dd></dd>
<dt>
<span class="light fixedFont">{boolean}</span> <b>logscale</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{number}</span> </dd>
</dl>
<hr />
<a name="getPlotArea"> </a>
<div class="fixedFont">
<span class="light">{{x: number|y: number|w: number|h: number}}</span>
<b>getPlotArea</b>()
</div>
<div class="description">
Returns the box which the chart should be drawn in. This is the canvas's
box, less space needed for the axis and chart labels.
</div>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{{x: number|y: number|w: number|h: number}}</span> </dd>
</dl>
<hr />
<a name="removeAllDatasets"> </a>
<div class="fixedFont">
<b>removeAllDatasets</b>()
</div>
<div class="description">
Convenience function to remove all the data sets from a graph
</div>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 for dygraph 2.2.1
</div>
</body>
</html>