generate docs

britecharts · Oct 25, 2017 · 422d96e · 422d96e
1 parent 0488b08
commit 422d96e
Show file tree

Hide file tree

Showing 10 changed files with 366 additions and 6 deletions.
diff --git a/docs/legend.js.html b/docs/legend.js.html
@@ -651,6 +651,22 @@ <h1 class="page-title">Source: legend.js</h1>
             return this;
         };
 
+        /**
+         * Gets or Sets the margin ratio of the legend chart.
+         * Used to determine spacing between legend elements.
+         * @param  {number} _x Margin Ratio to get/set
+         * @return {number | module} Current marginRatio or Legend module to chain calls
+         * @public
+         */
+        exports.marginRatio = function(_x) {
+            if (!arguments.length) {
+                return marginRatio;
+            }
+            marginRatio = _x;
+
+            return this;
+        };
+
         /**
          * Gets or Sets the markerSize of the legend chart.
          * This markerSize will determine the horizontal and vertical size of the colored marks

diff --git a/docs/module-Legend.html b/docs/module-Legend.html
@@ -1184,6 +1184,171 @@ <h5>Returns:</h5>
 
 
 
+</dd>
+
+
+
+<hr>
+<dt>
+    <h4 class="name" id=".marginRatio"><span class="type-signature">&lt;static> </span>marginRatio(_x)</h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        Gets or Sets the margin ratio of the legend chart.
+Used to determine spacing between legend elements.
+    </div>
+
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>_x</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">number</span>
+
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">Margin Ratio to get/set</td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
+	<dd class="tag-source">
+		<ul class="dummy">
+			<li>
+				<a href="legend.js.html">legend.js</a>
+			</li>
+		</ul>
+	</dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Returns:</h5>
+
+
+<div class="param-desc">
+    Current marginRatio or Legend module to chain calls
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+
+<span class="param-type">number</span>
+|
+
+<span class="param-type">module</span>
+
+
+
+    </dd>
+</dl>
+
+
+
+
+
 </dd>
 
 

diff --git a/docs/module-Tooltip.html b/docs/module-Tooltip.html
@@ -2009,6 +2009,170 @@ <h5>Returns:</h5>
 
 
 
+</dd>
+
+
+
+<hr>
+<dt>
+    <h4 class="name" id=".tooltipOffset"><span class="type-signature">&lt;static> </span>tooltipOffset(tooltipOffset)</h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        Pass an override for the offset of your tooltip
+    </div>
+
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+
+        <th>Name</th>
+
+
+        <th>Type</th>
+
+
+
+
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+
+
+        <tr>
+
+                <td class="name"><code>tooltipOffset</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">Object</span>
+
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">Object representing the X and Y offsets</td>
+        </tr>
+
+
+    </tbody>
+</table>
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+	<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
+	<dd class="tag-source">
+		<ul class="dummy">
+			<li>
+				<a href="tooltip.js.html">tooltip.js</a>
+			</li>
+		</ul>
+	</dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Returns:</h5>
+
+
+<div class="param-desc">
+    Current tooltipOffset
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+
+<span class="param-type">Object</span>
+|
+
+<span class="param-type">module</span>
+
+
+
+    </dd>
+</dl>
+
+
+
+
+
 </dd>
 
 

diff --git a/docs/quicksearch.html b/docs/quicksearch.html
diff --git a/docs/scripts/demo-donut.js b/docs/scripts/demo-donut.js
diff --git a/docs/scripts/demo-grouped-bar.js b/docs/scripts/demo-grouped-bar.js
diff --git a/docs/scripts/demo-line.js b/docs/scripts/demo-line.js
diff --git a/docs/scripts/demo-stacked-area.js b/docs/scripts/demo-stacked-area.js
diff --git a/docs/scripts/demo-stacked-bar.js b/docs/scripts/demo-stacked-bar.js
diff --git a/docs/tooltip.js.html b/docs/tooltip.js.html
@@ -906,6 +906,21 @@ <h1 class="page-title">Source: tooltip.js</h1>
             return this;
         };
 
+        /**
+         * Pass an override for the offset of your tooltip
+         * @param  {Object} tooltipOffset  Object representing the X and Y offsets
+         * @return {Object | module}       Current tooltipOffset
+         * @public
+         */
+        exports.tooltipOffset = function(_x) {
+            if (!arguments.length) {
+                return tooltipOffset;
+            }
+            tooltipOffset = _x;
+
+            return this;
+        };
+
         /**
          * Pass an override for the ordering of your tooltip
          * @param  {String[]} _x           Array of the names of your tooltip items