+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<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 - Dygraph</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>
-
-</ul>
-<hr />
- <!-- end publish.classesIndex -->
- </div>
-
- <div id="content">
-<!-- ============================== class title ============================ -->
- <h1 class="classTitle">
-
- Class Dygraph
- </h1>
-
-<!-- ============================== class summary ========================== -->
- <p class="description">
-
-
-
-
-
-
- <br /><i>Defined in: </i> <a href="../symbols/src/dygraph.js.html">dygraph.js</a>.
-
- </p>
-
-<!-- ============================== constructor summary ==================== -->
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Dygraph.">
- <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/Dygraph.html#constructor">Dygraph</a></b>(div, file, attrs)
- </div>
- <div class="description">Creates an interactive, zoomable chart.</div>
- </td>
- </tr>
- </tbody>
- </table>
-
-
-<!-- ============================== properties summary ===================== -->
-
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Dygraph.">
- <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"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">
- Dygraph.<b><a href="../symbols/Dygraph.html#.defaultInteractionModel">defaultInteractionModel</a></b>
- </div>
- <div class="description">Default interation model for dygraphs.</div>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
-
-<!-- ============================== methods summary ======================== -->
-
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Dygraph.">
- <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/Dygraph.html#adjustRoll">adjustRoll</a></b>(length)
- </div>
- <div class="description">Adjusts the number of points in the rolling average.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#annotations">annotations</a></b>()
- </div>
- <div class="description">Return the list of annotations.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#clearSelection">clearSelection</a></b>()
- </div>
- <div class="description">Clears the current selection (i.e.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.dateTicker">dateTicker</a></b>(startDate, endDate, self)
- </div>
- <div class="description">Add ticks to the x-axis based on a date range.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#destroy">destroy</a></b>()
- </div>
- <div class="description">Detach DOM elements in the dygraph and null out all data references.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.endPan">endPan</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-responds to an event that ends panning.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.endZoom">endZoom</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-responds to an event that performs a zoom based on previously defined
-bounds.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.floatFormat">floatFormat</a></b>(x, opt_precision)
- </div>
- <div class="description">Number formatting function which mimicks the behavior of %g in printf, i.e.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#getColors">getColors</a></b>()
- </div>
- <div class="description">Return the list of colors.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#getSelection">getSelection</a></b>()
- </div>
- <div class="description">Returns the number of the currently selected row.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#getValue">getValue</a></b>(row, col)
- </div>
- <div class="description">Returns the value in the given row and column.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.GVizChart">GVizChart</a></b>(container)
- </div>
- <div class="description">A wrapper around Dygraph that implements the gviz API.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#indexFromSetName">indexFromSetName</a></b>(name)
- </div>
- <div class="description">Get the index of a series (column) given its name.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#isZoomed">isZoomed</a></b>(axis)
- </div>
- <div class="description">Returns the zoomed status of the chart for one or both axes.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.movePan">movePan</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-responds to an event that pans the view.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.moveZoom">moveZoom</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-responds to an event that defines zoom boundaries.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#numAxes">numAxes</a></b>()
- </div>
- <div class="description">Returns the number of y-axes on the chart.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#numColumns">numColumns</a></b>()
- </div>
- <div class="description">Returns the number of columns (including the independent variable).</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.numericTicks">numericTicks</a></b>(minV, maxV, self, attribute, vals)
- </div>
- <div class="description">Add ticks when the x axis has numbers on it (instead of dates)</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#numRows">numRows</a></b>()
- </div>
- <div class="description">Returns the number of rows (excluding any header/label row).</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#resize">resize</a></b>(width, height)
- </div>
- <div class="description">Resizes the dygraph.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#rollPeriod">rollPeriod</a></b>()
- </div>
- <div class="description">Returns the current rolling period, as set by the user or an option.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#setAnnotations">setAnnotations</a></b>(ann, suppressDraw)
- </div>
- <div class="description">Update the list of annotations and redraw the chart.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#setSelection">setSelection</a></b>(row)
- </div>
- <div class="description">Manually set the selected points and display information about them in the
-legend.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#setVisibility">setVisibility</a></b>(num, value)
- </div>
- <div class="description">Changes the visiblity of a series.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.startPan">startPan</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-should start the default panning behavior.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.startZoom">startZoom</a></b>(event, g, context)
- </div>
- <div class="description">Called in response to an interaction model operation that
-responds to an event that starts zooming.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDataCoords">toDataCoords</a></b>(x, y, axis)
- </div>
- <div class="description">Convert from canvas/div coords to data coordinates.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDataXCoord">toDataXCoord</a></b>(x)
- </div>
- <div class="description">Convert from canvas/div x coordinate to data coordinate.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDataYCoord">toDataYCoord</a></b>(y, axis)
- </div>
- <div class="description">Convert from canvas/div y coord to value.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDomCoords">toDomCoords</a></b>(x, y, axis)
- </div>
- <div class="description">Convert from data coordinates to canvas/div X/Y coordinates.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDomXCoord">toDomXCoord</a></b>(x)
- </div>
- <div class="description">Convert from data x coordinates to canvas/div X coordinate.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toDomYCoord">toDomYCoord</a></b>(y, axis)
- </div>
- <div class="description">Convert from data x coordinates to canvas/div Y coordinate and optional
-axis.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toPercentXCoord">toPercentXCoord</a></b>(x)
- </div>
- <div class="description">Converts an x value to a percentage from the left to the right of
-the drawing area.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toPercentYCoord">toPercentYCoord</a></b>(y, axis)
- </div>
- <div class="description">Converts a y for an axis to a percentage from the top to the
-bottom of the drawing area.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#toString">toString</a></b>()
- </div>
- <div class="description">Returns information about the Dygraph object, including its containing ID.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">Dygraph.<b><a href="../symbols/Dygraph.html#.toString">toString</a></b>()
- </div>
- <div class="description">Returns information about the Dygraph class.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#updateOptions">updateOptions</a></b>(attrs)
- </div>
- <div class="description">Changes various properties of the graph.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#visibility">visibility</a></b>()
- </div>
- <div class="description">Returns a boolean array of visibility statuses.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#xAxisExtremes">xAxisExtremes</a></b>()
- </div>
- <div class="description">Returns the lower- and upper-bound x-axis values of the
-data set.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#xAxisRange">xAxisRange</a></b>()
- </div>
- <div class="description">Returns the currently-visible x-range.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#yAxisRange">yAxisRange</a></b>(idx)
- </div>
- <div class="description">Returns the currently-visible y-range for an axis.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/Dygraph.html#yAxisRanges">yAxisRanges</a></b>()
- </div>
- <div class="description">Returns the currently-visible y-ranges for each axis.</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>Dygraph</b>(div, file, attrs)
- </div>
-
- <div class="description">
- Creates an interactive, zoomable chart.
-
- </div>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{div | String}</span> <b>div</b>
-
- </dt>
- <dd>A div or the id of a div into which to construct
-the chart.</dd>
-
- <dt>
- <span class="light fixedFont">{String | Function}</span> <b>file</b>
-
- </dt>
- <dd>A file containing CSV data or a function
-that returns this data. The most basic expected format for each line is
-"YYYY/MM/DD,val1,val2,...". For more information, see
-http://dygraphs.com/data.html.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>attrs</b>
-
- </dt>
- <dd>Various other attributes, e.g. errorBars determines
-whether the input data contains error ranges. For a complete list of
-options, see http://dygraphs.com/options.html.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- </div>
-
-
-<!-- ============================== field details ========================== -->
-
- <div class="sectionTitle">
- Field Detail
- </div>
-
- <a name=".defaultInteractionModel"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>defaultInteractionModel</b>
-
- </div>
- <div class="description">
- Default interation model for dygraphs. You can refer to specific elements of
-this when constructing your own interaction model, e.g.:
-g.updateOptions( {
- interactionModel: {
- mousedown: Dygraph.defaultInteractionModel.mousedown
- }
-} );
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-<!-- ============================== method details ========================= -->
-
- <div class="sectionTitle">
- Method Detail
- </div>
-
- <a name="adjustRoll"> </a>
- <div class="fixedFont">
-
-
- <b>adjustRoll</b>(length)
-
- </div>
- <div class="description">
- Adjusts the number of points in the rolling average. Updates the graph to
-reflect the new averaging period.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>length</b>
-
- </dt>
- <dd>Number of points over which to average the data.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="annotations"> </a>
- <div class="fixedFont">
-
-
- <b>annotations</b>()
-
- </div>
- <div class="description">
- Return the list of annotations.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="clearSelection"> </a>
- <div class="fixedFont">
-
-
- <b>clearSelection</b>()
-
- </div>
- <div class="description">
- Clears the current selection (i.e. points that were highlighted by moving
-the mouse over the chart).
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".dateTicker"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{[Object]}</span>
- <span class="light">Dygraph.</span><b>dateTicker</b>(startDate, endDate, self)
-
- </div>
- <div class="description">
- Add ticks to the x-axis based on a date range.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>startDate</b>
-
- </dt>
- <dd>Start of the date window (millis since epoch)</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>endDate</b>
-
- </dt>
- <dd>End of the date window (millis since epoch)</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>self</b>
-
- </dt>
- <dd>The dygraph object</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{[Object]}</span> Array of {label, value} tuples.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="destroy"> </a>
- <div class="fixedFont">
-
-
- <b>destroy</b>()
-
- </div>
- <div class="description">
- Detach DOM elements in the dygraph and null out all data references.
-Calling this when you're done with a dygraph can dramatically reduce memory
-usage. See, e.g., the tests/perf.html example.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".endPan"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>endPan</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-responds to an event that ends panning.
-
-It's used in the default callback for "mouseup" operations.
-Custom interaction model builders can use it to provide the default
-panning behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the startZoom call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to act.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".endZoom"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>endZoom</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-responds to an event that performs a zoom based on previously defined
-bounds..
-
-It's used in the default callback for "mouseup" operations.
-Custom interaction model builders can use it to provide the default
-zooming behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the endZoom call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to end the zoom.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".floatFormat"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{String}</span>
- <span class="light">Dygraph.</span><b>floatFormat</b>(x, opt_precision)
-
- </div>
- <div class="description">
- Number formatting function which mimicks the behavior of %g in printf, i.e.
-either exponential or fixed format (without trailing 0s) is used depending on
-the length of the generated string. The advantage of this format is that
-there is a predictable upper bound on the resulting string length,
-significant figures are not dropped, and normal numbers are not displayed in
-exponential notation.
-
-NOTE: JavaScript's native toPrecision() is NOT a drop-in replacement for %g.
-It creates strings which are too long for absolute values between 10^-4 and
-10^-6, e.g. '0.00001' instead of '1e-5'. See tests/number-format.html for
-output examples.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd>The number to format</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>opt_precision</b>
-
- </dt>
- <dd>The precision to use, default 2.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{String}</span> A string formatted like %g in printf. The max generated
- string length should be precision + 6 (e.g 1.123e+300).</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="getColors"> </a>
- <div class="fixedFont">
-
- <span class="light">{Array<string>}</span>
- <b>getColors</b>()
-
- </div>
- <div class="description">
- Return the list of colors. This is either the list of colors passed in the
-attributes or the autogenerated list of rgb(r,g,b) strings.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Array<string>}</span> The list of colors.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="getSelection"> </a>
- <div class="fixedFont">
-
- <span class="light">{Integer}</span>
- <b>getSelection</b>()
-
- </div>
- <div class="description">
- Returns the number of the currently selected row. To get data for this row,
-you can use the getValue method.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Integer}</span> row number, or -1 if nothing is selected</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="getValue"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>getValue</b>(row, col)
-
- </div>
- <div class="description">
- Returns the value in the given row and column. If the row and column exceed
-the bounds on the data, returns null. Also returns null if the value is
-missing.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>row</b>
-
- </dt>
- <dd>The row number of the data (0-based). Row 0 is the
-first row of data, not a header row.</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>col</b>
-
- </dt>
- <dd>The column number of the data (0-based)</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> The value in the specified cell or null if the row/col
-were out of range.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name=".GVizChart"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>GVizChart</b>(container)
-
- </div>
- <div class="description">
- A wrapper around Dygraph that implements the gviz API.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>container</b>
-
- </dt>
- <dd>The DOM object the visualization should live in.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="indexFromSetName"> </a>
- <div class="fixedFont">
-
-
- <b>indexFromSetName</b>(name)
-
- </div>
- <div class="description">
- Get the index of a series (column) given its name. The first column is the
-x-axis, so the data series start with index 1.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>name</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="isZoomed"> </a>
- <div class="fixedFont">
-
-
- <b>isZoomed</b>(axis)
-
- </div>
- <div class="description">
- Returns the zoomed status of the chart for one or both axes.
-
-Axis is an optional parameter. Can be set to 'x' or 'y'.
-
-The zoomed status for an axis is set whenever a user zooms using the mouse
-or when the dateWindow or valueRange are updated (unless the isZoomedIgnoreProgrammaticZoom
-option is also specified).
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>axis</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".movePan"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>movePan</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-responds to an event that pans the view.
-
-It's used in the default callback for "mousemove" operations.
-Custom interaction model builders can use it to provide the default
-panning behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the movePan call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to act.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".moveZoom"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>moveZoom</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-responds to an event that defines zoom boundaries.
-
-It's used in the default callback for "mousemove" operations.
-Custom interaction model builders can use it to provide the default
-zooming behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the moveZoom call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to act.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="numAxes"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>numAxes</b>()
-
- </div>
- <div class="description">
- Returns the number of y-axes on the chart.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> the number of axes.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="numColumns"> </a>
- <div class="fixedFont">
-
- <span class="light">{Integer}</span>
- <b>numColumns</b>()
-
- </div>
- <div class="description">
- Returns the number of columns (including the independent variable).
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Integer}</span> The number of columns.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name=".numericTicks"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{[Object]}</span>
- <span class="light">Dygraph.</span><b>numericTicks</b>(minV, maxV, self, attribute, vals)
-
- </div>
- <div class="description">
- Add ticks when the x axis has numbers on it (instead of dates)
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>minV</b>
-
- </dt>
- <dd>minimum value</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>maxV</b>
-
- </dt>
- <dd>maximum value</dd>
-
- <dt>
- <b>self</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{function}</span> <b>attribute</b>
-
- </dt>
- <dd>accessor function.</dd>
-
- <dt>
- <b>vals</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{[Object]}</span> Array of {label, value} tuples.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="numRows"> </a>
- <div class="fixedFont">
-
- <span class="light">{Integer}</span>
- <b>numRows</b>()
-
- </div>
- <div class="description">
- Returns the number of rows (excluding any header/label row).
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Integer}</span> The number of rows, less any header.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="resize"> </a>
- <div class="fixedFont">
-
-
- <b>resize</b>(width, height)
-
- </div>
- <div class="description">
- Resizes the dygraph. If no parameters are specified, resizes to fill the
-containing div (which has presumably changed size since the dygraph was
-instantiated. If the width/height are specified, the div will be resized.
-
-This is far more efficient than destroying and re-instantiating a
-Dygraph, since it doesn't have to reparse the underlying data.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>width</b>
- <i>Optional</i>
- </dt>
- <dd>Width (in pixels)</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>height</b>
- <i>Optional</i>
- </dt>
- <dd>Height (in pixels)</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="rollPeriod"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>rollPeriod</b>()
-
- </div>
- <div class="description">
- Returns the current rolling period, as set by the user or an option.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> The number of points in the rolling window</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="setAnnotations"> </a>
- <div class="fixedFont">
-
-
- <b>setAnnotations</b>(ann, suppressDraw)
-
- </div>
- <div class="description">
- Update the list of annotations and redraw the chart.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>ann</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>suppressDraw</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="setSelection"> </a>
- <div class="fixedFont">
-
-
- <b>setSelection</b>(row)
-
- </div>
- <div class="description">
- Manually set the selected points and display information about them in the
-legend. The selection can be cleared using clearSelection() and queried
-using getSelection().
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Integer}</span> <b>row</b>
-
- </dt>
- <dd>number that should be highlighted (i.e. appear with
-hover dots on the chart). Set to false to clear any selection.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="setVisibility"> </a>
- <div class="fixedFont">
-
-
- <b>setVisibility</b>(num, value)
-
- </div>
- <div class="description">
- Changes the visiblity of a series.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>num</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>value</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".startPan"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>startPan</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-should start the default panning behavior.
-
-It's used in the default callback for "mousedown" operations.
-Custom interaction model builders can use it to provide the default
-panning behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the startPan call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to act.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".startZoom"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>startZoom</b>(event, g, context)
-
- </div>
- <div class="description">
- Called in response to an interaction model operation that
-responds to an event that starts zooming.
-
-It's used in the default callback for "mousedown" operations.
-Custom interaction model builders can use it to provide the default
-zooming behavior.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Event}</span> <b>event</b>
-
- </dt>
- <dd>the event object which led to the startZoom call.</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Dygraph.html">Dygraph</a>}</span> <b>g</b>
-
- </dt>
- <dd>The dygraph on which to act.</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>context</b>
-
- </dt>
- <dd>The dragging context object (with
-dragStartX/dragStartY/etc. properties). This function modifies the context.</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDataCoords"> </a>
- <div class="fixedFont">
-
-
- <b>toDataCoords</b>(x, y, axis)
-
- </div>
- <div class="description">
- Convert from canvas/div coords to data coordinates.
-If specified, do this conversion for the coordinate system of a particular
-axis. Uses the first axis by default.
-Returns a two-element array: [X, Y].
-
-Note: use toDataXCoord instead of toDataCoords(x, null) and use toDataYCoord
-instead of toDataCoords(null, y, axis).
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>x</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>y</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>axis</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDataXCoord"> </a>
- <div class="fixedFont">
-
-
- <b>toDataXCoord</b>(x)
-
- </div>
- <div class="description">
- Convert from canvas/div x coordinate to data coordinate.
-
-If x is null, this returns null.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>x</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDataYCoord"> </a>
- <div class="fixedFont">
-
-
- <b>toDataYCoord</b>(y, axis)
-
- </div>
- <div class="description">
- Convert from canvas/div y coord to value.
-
-If y is null, this returns null.
-if axis is null, this uses the first axis.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>y</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>axis</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDomCoords"> </a>
- <div class="fixedFont">
-
-
- <b>toDomCoords</b>(x, y, axis)
-
- </div>
- <div class="description">
- Convert from data coordinates to canvas/div X/Y coordinates.
-If specified, do this conversion for the coordinate system of a particular
-axis. Uses the first axis by default.
-Returns a two-element array: [X, Y]
-
-Note: use toDomXCoord instead of toDomCoords(x, null) and use toDomYCoord
-instead of toDomCoords(null, y, axis).
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>x</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>y</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>axis</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDomXCoord"> </a>
- <div class="fixedFont">
-
-
- <b>toDomXCoord</b>(x)
-
- </div>
- <div class="description">
- Convert from data x coordinates to canvas/div X coordinate.
-If specified, do this conversion for the coordinate system of a particular
-axis.
-Returns a single value or null if x is null.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>x</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toDomYCoord"> </a>
- <div class="fixedFont">
-
-
- <b>toDomYCoord</b>(y, axis)
-
- </div>
- <div class="description">
- Convert from data x coordinates to canvas/div Y coordinate and optional
-axis. Uses the first axis by default.
-
-returns a single value or null if y is null.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>y</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <b>axis</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="toPercentXCoord"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>toPercentXCoord</b>(x)
-
- </div>
- <div class="description">
- Converts an x value to a percentage from the left to the right of
-the drawing area.
-
-If the coordinate represents a value visible on the canvas, then
-the value will be between 0 and 1, where 0 is the left of the canvas.
-However, this method will return values outside the range, as
-values can fall outside the canvas.
-
-If x is null, this returns null.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd>The data x-coordinate.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> A fraction in [0, 1] where 0 = the left edge.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="toPercentYCoord"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>toPercentYCoord</b>(y, axis)
-
- </div>
- <div class="description">
- Converts a y for an axis to a percentage from the top to the
-bottom of the drawing area.
-
-If the coordinate represents a value visible on the canvas, then
-the value will be between 0 and 1, where 0 is the top of the canvas.
-However, this method will return values outside the range, as
-values can fall outside the canvas.
-
-If y is null, this returns null.
-if axis is null, this uses the first axis.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>y</b>
-
- </dt>
- <dd>The data y-coordinate.</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>axis</b>
- <i>Optional</i>
- </dt>
- <dd>The axis number on which the data coordinate lives.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> A fraction in [0, 1] where 0 = the top edge.</dd>
-
- </dl>
-
-
-
-
- <hr />
-
- <a name="toString"> </a>
- <div class="fixedFont">
-
-
- <b>toString</b>()
-
- </div>
- <div class="description">
- Returns information about the Dygraph object, including its containing ID.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".toString"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">Dygraph.</span><b>toString</b>()
-
- </div>
- <div class="description">
- Returns information about the Dygraph class.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="updateOptions"> </a>
- <div class="fixedFont">
-
-
- <b>updateOptions</b>(attrs)
-
- </div>
- <div class="description">
- Changes various properties of the graph. These can include:
-<ul>
-<li>file: changes the source data for the graph</li>
-<li>errorBars: changes whether the data contains stddev</li>
-</ul>
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>attrs</b>
-
- </dt>
- <dd>The new properties and values</dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="visibility"> </a>
- <div class="fixedFont">
-
-
- <b>visibility</b>()
-
- </div>
- <div class="description">
- Returns a boolean array of visibility statuses.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="xAxisExtremes"> </a>
- <div class="fixedFont">
-
-
- <b>xAxisExtremes</b>()
-
- </div>
- <div class="description">
- Returns the lower- and upper-bound x-axis values of the
-data set.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="xAxisRange"> </a>
- <div class="fixedFont">
-
-
- <b>xAxisRange</b>()
-
- </div>
- <div class="description">
- Returns the currently-visible x-range. This can be affected by zooming,
-panning or a call to updateOptions.
-Returns a two-element array: [left, right].
-If the Dygraph has dates on the x-axis, these will be millis since epoch.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="yAxisRange"> </a>
- <div class="fixedFont">
-
-
- <b>yAxisRange</b>(idx)
-
- </div>
- <div class="description">
- Returns the currently-visible y-range for an axis. This can be affected by
-zooming, panning or a call to updateOptions. Axis indices are zero-based. If
-called with no arguments, returns the range of the first axis.
-Returns a two-element array: [bottom, top].
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>idx</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="yAxisRanges"> </a>
- <div class="fixedFont">
-
-
- <b>yAxisRanges</b>()
-
- </div>
- <div class="description">
- Returns the currently-visible y-ranges for each axis. This can be affected by
-zooming, panning, calls to updateOptions, etc.
-Returns an array of [bottom, top] pairs, one for each y-axis.
-
-
- </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 on Mon May 09 2011 07:12:49 GMT-0700 (PDT)
- </div>
- </body>
-</html>
projects / dygraphs.git / blobdiff