readme/doc

Author: farfromrefug

docs/assets/search.js

@@ -78,7 +78,7 @@
 <a href="utils_ViewPortHandler.ViewPortHandler.html#zoomIn" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>zoom<wbr/>In</span></a>
 <a href="utils_ViewPortHandler.ViewPortHandler.html#zoomOut" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>zoom<wbr/>Out</span></a>
 </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ViewPortHandler" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>View<wbr/>Port<wbr/>Handler</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="utils_ViewPortHandler.ViewPortHandler.html" class="tsd-signature-type tsd-kind-class">ViewPortHandler</a><a href="#constructor.new_ViewPortHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="utils_ViewPortHandler.ViewPortHandler.html" class="tsd-signature-type tsd-kind-class">ViewPortHandler</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="chartHeight" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>chart<wbr/>Height</span><a href="#chartHeight" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">chart<wbr/>Height</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:20</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="chartRect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>chart<wbr/>Rect</span><a href="#chartRect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">chart<wbr/>Rect</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RectF</span></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:18</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="chartWidth" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>chart<wbr/>Width</span><a href="#chartWidth" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">chart<wbr/>Width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:19</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="contentRect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>content<wbr/>Rect</span><a href="#contentRect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">content<wbr/>Rect</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RectF</span></div><div class="tsd-comment tsd-typography"><p>this rectangle defines the area in which graph values can be drawn</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="mMatrixBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>m<wbr/>Matrix<wbr/>Buffer</span><a href="#mMatrixBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">m<wbr/>Matrix<wbr/>Buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">TypedArray</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>buffer for storing the 9 matrix values of a 3x3 matrix</p>
+</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:17</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="mMatrixBuffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>m<wbr/>Matrix<wbr/>Buffer</span><a href="#mMatrixBuffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">m<wbr/>Matrix<wbr/>Buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TypedArray</span></div><div class="tsd-comment tsd-typography"><p>buffer for storing the 9 matrix values of a 3x3 matrix</p>
 </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:24</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="mMatrixTouch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>m<wbr/>Matrix<wbr/>Touch</span><a href="#mMatrixTouch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">m<wbr/>Matrix<wbr/>Touch</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Matrix</span></div><div class="tsd-comment tsd-typography"><p>matrix used for touch events</p>
 </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:13</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="mMaxScaleX" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>m<wbr/>Max<wbr/>ScaleX</span><a href="#mMaxScaleX" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">m<wbr/>Max<wbr/>ScaleX</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>maximum scale value on the x-axis</p>
 </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:40</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="mMaxScaleY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>m<wbr/>Max<wbr/>ScaleY</span><a href="#mMaxScaleY" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">m<wbr/>Max<wbr/>ScaleY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><div class="tsd-comment tsd-typography"><p>maximum scale value on the y-axis</p>
@@ -99,7 +99,7 @@
 in the chart. Centering the viewport outside the bounds of the chart is
 not possible. Makes most sense in combination with the
 setScaleMinima(...) method.</p>
-</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transformedPts</span>: <span class="tsd-signature-type">TypedArray</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>the position to center view viewport to</p>
+</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">transformedPts</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TypedArray</span></span><div class="tsd-comment tsd-typography"><p>the position to center view viewport to</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">view</span>: <span class="tsd-signature-type">CanvasView</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>save</p>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/ui-chart/utils/ViewPortHandler.d.ts:166</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="fitScreen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fit<wbr/>Screen</span><a href="#fitScreen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fitScreen.fitScreen-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fit<wbr/>Screen</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">outputMatrix</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#fitScreen.fitScreen-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Resets all zooming and dragging and makes the chart fit exactly it&#39;s
 bounds.  Output Matrix is available for those who wish to cache the object.</p>