npm - carbon-components-angular - Versions diffs - 3.16.3 → 3.17.3 - Mend

carbon-components-angular 3.16.3 → 3.17.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (322) hide show

package/docs/documentation/classes/DataGridInteractionModel.html ADDED Viewed

@@ -0,0 +1,1462 @@
+<!doctype html>
+<html class="no-js" lang="">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="x-ua-compatible" content="ie=edge">
+        <title>carbon-components-angular documentation</title>
+        <meta name="description" content="">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <link rel="icon" type="image/x-icon" href="../images/favicon.ico">
+	      <link rel="stylesheet" href="../styles/style.css">
+    </head>
+    <body>
+        <div class="navbar navbar-default navbar-fixed-top visible-xs">
+            <a href="../" class="navbar-brand">carbon-components-angular documentation</a>
+            <button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
+        </div>
+        <div class="xs-menu menu" id="mobile-menu">
+                <div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div>            <compodoc-menu></compodoc-menu>
+        </div>
+        <div class="container-fluid main">
+           <div class="row main">
+               <div class="hidden-xs menu">
+                   <compodoc-menu mode="normal"></compodoc-menu>
+               </div>
+               <!-- START CONTENT -->
+               <div class="content class">
+                   <div class="content-data">
+<ol class="breadcrumb">
+  <li>Classes</li>
+  <li>DataGridInteractionModel</li>
+</ol>
+<ul class="nav nav-tabs" role="tablist">
+        <li class="active">
+            <a href="#info" role="tab" id="info-tab" data-toggle="tab" data-link="info">Info</a>
+        </li>
+        <li >
+            <a href="#source" role="tab" id="source-tab" data-toggle="tab" data-link="source">Source</a>
+        </li>
+</ul>
+<div class="tab-content">
+    <div class="tab-pane fade active in" id="c-info">
+        <p class="comment">
+            <h3>File</h3>
+        </p>
+        <p class="comment">
+            <code>src/table/data-grid-interaction-model.class.ts</code>
+        </p>
+            <p class="comment">
+                <h3>Description</h3>
+            </p>
+            <p class="comment">
+                <p><code>DataGridInteractionModel</code> provides centralized control over arbitrary 2d grids, following the w3 specs.</p>
+<p>Refs:</p>
+<ul>
+<li><a href="https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html">https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html</a></li>
+<li><a href="https://www.w3.org/TR/wai-aria-practices/#grid">https://www.w3.org/TR/wai-aria-practices/#grid</a></li>
+</ul>
+<p>Example usage (taken from <code>table.component</code>):</p>
+<div><pre class="line-numbers"><code class="language-typescript">// a standard HTML table
+const table = this.elementRef.nativeElement.querySelector(&quot;table&quot;) as HTMLTableElement;
+// `TableDomAdapter` implements `TableAdapter` and provides a consistent interface to query rows and columns in a table
+const tableAdapter = new TableDomAdapter(table);
+// the keydown events that we&#39;ll use for keyboard navigation of the table
+const keydownEventStream = fromEvent&lt;KeyboardEvent&gt;(table, &quot;keydown&quot;);
+// the click events we&#39;ll use to ensure focus is updated correctly on click
+const clickEventStream = fromEvent&lt;MouseEvent&gt;(table, &quot;click&quot;);
+// the `DataGridInteractionModel` instance!
+this.interactionModel = new DataGridInteractionModel(keydownEventStream, clickEventStream, tableAdapter);
+// subscribe to the combined position updates
+this.interactionModel.position.subscribe(event =&gt; {
+    const [currentRow, currentColumn] = event.current;
+    const [previousRow, previousColumn] = event.previous;
+    // query the TableAdapter for the cell at the current row and column ...
+    const currentElement = tableAdapter.getCell(currentRow, currentColumn);
+    // ... and make it focusable it
+    Table.setTabIndex(currentElement, 0);
+    // if the model has just initialized don&#39;t focus or reset anything
+    if (previousRow === -1 || previousColumn === -1) { return; }
+    // query the TableAdapter for the cell at the previous row and column ...
+    const previousElement = tableAdapter.getCell(previousRow, previousColumn);
+    // ... and make it unfocusable (now there is only a single focusable cell)
+    Table.setTabIndex(previousElement, -1);
+    // finally, focus the current cell (skipped during initilzation)
+    Table.focus(currentElement);
+});</code></pre></div>
+            </p>
+            <section>
+    <h3 id="index">Index</h3>
+    <table class="table table-sm table-bordered index-table">
+        <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <h6><b>Properties</b></h6>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <ul class="index-list">
+                            <li>
+                                    <span class="modifier">Readonly</span>
+                                <a href="#columnIndex">columnIndex</a>
+                            </li>
+                            <li>
+                                    <span class="modifier">Protected</span>
+                                <a href="#columnSubject">columnSubject</a>
+                            </li>
+                            <li>
+                                    <span class="modifier">Readonly</span>
+                                <a href="#position">position</a>
+                            </li>
+                            <li>
+                                    <span class="modifier">Readonly</span>
+                                <a href="#rowIndex">rowIndex</a>
+                            </li>
+                            <li>
+                                    <span class="modifier">Protected</span>
+                                <a href="#rowSubject">rowSubject</a>
+                            </li>
+                        </ul>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <h6><b>Methods</b></h6>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <ul class="index-list">
+                            <li>
+                                <a href="#goTo">goTo</a>
+                            </li>
+                            <li>
+                                <a href="#goToColumn">goToColumn</a>
+                            </li>
+                            <li>
+                                <a href="#goToRow">goToRow</a>
+                            </li>
+                            <li>
+                                <a href="#handleClickEvent">handleClickEvent</a>
+                            </li>
+                            <li>
+                                <a href="#handleKeyboardEvent">handleKeyboardEvent</a>
+                            </li>
+                            <li>
+                                <a href="#reset">reset</a>
+                            </li>
+                            <li>
+                                <a href="#resetTabIndexes">resetTabIndexes</a>
+                            </li>
+                        </ul>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <h6><b>Accessors</b></h6>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <ul class="index-list">
+                                <li>
+                                    <a href="#currentRow">currentRow</a>
+                                </li>
+                                <li>
+                                    <a href="#currentColumn">currentColumn</a>
+                                </li>
+                                <li>
+                                    <a href="#lastColumn">lastColumn</a>
+                                </li>
+                                <li>
+                                    <a href="#lastRow">lastRow</a>
+                                </li>
+                            </ul>
+                        </td>
+                    </tr>
+        </tbody>
+    </table>
+</section>
+            <section>
+    <h3 id="constructor">Constructor</h3>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+<code>constructor(keyboardEventStream: Observable<KeyboardEvent>, clickEventStream: Observable<MouseEvent>, tableAdapter: <a href="../classes/TableAdapter.html">TableAdapter</a>)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                <div class="io-line">Defined in <a href="" data-line="116" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:116</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p><code>DataGridInteractionModel</code> requires knowledge of events, and a representation of your table/grid to be useful.</p>
+</div>
+                            <div>
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                    <td>Type</td>
+                                                <td>Optional</td>
+                                                    <td>Description</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>keyboardEventStream</td>
+                                                        <td>
+                                                                    <code>Observable&lt;KeyboardEvent&gt;</code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>an Observable of KeyboardEvents. Should be scoped to the table container.</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                                <tr>
+                                                        <td>clickEventStream</td>
+                                                        <td>
+                                                                    <code>Observable&lt;MouseEvent&gt;</code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>an Observable of ClickEvents. should only include clicks that take action on items known by the TableAdapter</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                                <tr>
+                                                        <td>tableAdapter</td>
+                                                        <td>
+                                                                    <code><a href="../classes/TableAdapter.html" target="_self" >TableAdapter</a></code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>an instance of a concrete class that implements TableAdapter. The standard carbon table uses TableDomAdapter</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+</section>
+            <section>
+        <h3 id="inputs">
+            Properties
+        </h3>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="columnIndex"></a>
+                        <span class="name">
+                            <b>
+                                <span class="modifier">Readonly</span>
+                            columnIndex
+                            </b>
+                            <a href="#columnIndex"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="modifier-icon icon ion-ios-reset"></span><code>columnIndex:     <code>Observable&lt;literal type&gt;</code>
+</code>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <i>Type : </i>    <code>Observable&lt;literal type&gt;</code>
+                        </td>
+                    </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="79" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:79</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <div class="io-description"><p>An Observable that provides the current and previous column indexes.</p>
+</div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="columnSubject"></a>
+                        <span class="name">
+                            <b>
+                                <span class="modifier">Protected</span>
+                            columnSubject
+                            </b>
+                            <a href="#columnSubject"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="modifier-icon icon ion-ios-reset"></span><code>columnSubject:     <code></code>
+</code>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <i>Default value : </i><code>new BehaviorSubject({ current: 0, previous: -1 })</code>
+                        </td>
+                    </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="88" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:88</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <div class="io-description"><p>Internal subject to handle changes in column</p>
+</div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="position"></a>
+                        <span class="name">
+                            <b>
+                                <span class="modifier">Readonly</span>
+                            position
+                            </b>
+                            <a href="#position"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="modifier-icon icon ion-ios-reset"></span><code>position:     <code><a href="../interfaces/DataGridPosition.html" target="_self" >Observable&lt;DataGridPosition&gt;</a></code>
+</code>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <i>Type : </i>    <code><a href="../interfaces/DataGridPosition.html" target="_self" >Observable&lt;DataGridPosition&gt;</a></code>
+                        </td>
+                    </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="71" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:71</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <div class="io-description"><p>An Observable that provides an aggregated view of the <code>rowIndex</code> and <code>columnIndex</code> Observables</p>
+</div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="rowIndex"></a>
+                        <span class="name">
+                            <b>
+                                <span class="modifier">Readonly</span>
+                            rowIndex
+                            </b>
+                            <a href="#rowIndex"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="modifier-icon icon ion-ios-reset"></span><code>rowIndex:     <code>Observable&lt;literal type&gt;</code>
+</code>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <i>Type : </i>    <code>Observable&lt;literal type&gt;</code>
+                        </td>
+                    </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="75" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:75</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <div class="io-description"><p>An Observable that provides the current and previous row indexes.</p>
+</div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="rowSubject"></a>
+                        <span class="name">
+                            <b>
+                                <span class="modifier">Protected</span>
+                            rowSubject
+                            </b>
+                            <a href="#rowSubject"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="modifier-icon icon ion-ios-reset"></span><code>rowSubject:     <code></code>
+</code>
+                    </td>
+                </tr>
+                    <tr>
+                        <td class="col-md-4">
+                            <i>Default value : </i><code>new BehaviorSubject({ current: 0, previous: -1 })</code>
+                        </td>
+                    </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="84" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:84</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <div class="io-description"><p>Internal subject to handle changes in row</p>
+</div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+</section>
+            <section>
+        <h3 id="methods">
+            Methods
+        </h3>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="goTo"></a>
+                        <span class="name">
+                            <b>
+                            goTo
+                            </b>
+                            <a href="#goTo"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>goTo(undefined)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="235" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:235</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Jump to the specified row and column</p>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                <td>Optional</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="goToColumn"></a>
+                        <span class="name">
+                            <b>
+                            goToColumn
+                            </b>
+                            <a href="#goToColumn"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>goToColumn(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="215" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:215</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Jump to a specific column without changing the row</p>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                    <td>Type</td>
+                                                <td>Optional</td>
+                                                    <td>Description</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>index</td>
+                                                        <td>
+                                                                    <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>column to jump to</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="goToRow"></a>
+                        <span class="name">
+                            <b>
+                            goToRow
+                            </b>
+                            <a href="#goToRow"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>goToRow(index: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank">number</a>)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="225" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:225</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Jump to a specific row without chaning the column</p>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                    <td>Type</td>
+                                                <td>Optional</td>
+                                                    <td>Description</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>index</td>
+                                                        <td>
+                                                                    <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number" target="_blank" >number</a></code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>row to jump to</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="handleClickEvent"></a>
+                        <span class="name">
+                            <b>
+                            handleClickEvent
+                            </b>
+                            <a href="#handleClickEvent"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>handleClickEvent(event: MouseEvent)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="204" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:204</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Handles moving the position to the clicked cell</p>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                    <td>Type</td>
+                                                <td>Optional</td>
+                                                    <td>Description</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>event</td>
+                                                        <td>
+                                                                    <code>MouseEvent</code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>the MouseEvent to handle</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="handleKeyboardEvent"></a>
+                        <span class="name">
+                            <b>
+                            handleKeyboardEvent
+                            </b>
+                            <a href="#handleKeyboardEvent"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>handleKeyboardEvent(event: KeyboardEvent)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="152" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:152</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Handles moving the position according to the w3 datagrid navigation specs</p>
+<p>Refs:</p>
+<ul>
+<li><a href="https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html">https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html</a></li>
+<li><a href="https://www.w3.org/TR/wai-aria-practices/#grid">https://www.w3.org/TR/wai-aria-practices/#grid</a></li>
+</ul>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                    <td>Type</td>
+                                                <td>Optional</td>
+                                                    <td>Description</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>event</td>
+                                                        <td>
+                                                                    <code>KeyboardEvent</code>
+                                                        </td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code><p>the KeyboardEvent to handle</p>
+</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="reset"></a>
+                        <span class="name">
+                            <b>
+                            reset
+                            </b>
+                            <a href="#reset"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>reset()</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="260" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:260</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Resets the models focus position</p>
+</div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="resetTabIndexes"></a>
+                        <span class="name">
+                            <b>
+                            resetTabIndexes
+                            </b>
+                            <a href="#resetTabIndexes"><span class="icon ion-ios-link"></span></a>
+                        </span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+<code>resetTabIndexes(newTabIndex)</code>
+                    </td>
+                </tr>
+                        <tr>
+                            <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="244" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:244</a></div>
+                            </td>
+                        </tr>
+                <tr>
+                    <td class="col-md-4">
+                            <div class="io-description"><p>Convenience method to reset the tab indexes on a standard carbon table.
+For custom tables you may want to reset the indexes manually and simply call <code>.reset()</code></p>
+</div>
+                            <div class="io-description">
+                                    <b>Parameters :</b>
+                                    <table class="params">
+                                        <thead>
+                                            <tr>
+                                                <td>Name</td>
+                                                <td>Optional</td>
+                                                    <td>Default value</td>
+                                            </tr>
+                                        </thead>
+                                        <tbody>
+                                                <tr>
+                                                        <td>newTabIndex</td>
+                                                    <td>
+                                                            No
+                                                    </td>
+                                                        <td>
+                                                                <code>-1</code>
+                                                        </td>
+                                                </tr>
+                                        </tbody>
+                                    </table>
+                            </div>
+                            <div>
+                            </div>
+                            <div class="io-description">
+                                <b>Returns : </b>    <code><a href="https://www.typescriptlang.org/docs/handbook/basic-types.html" target="_blank" >void</a></code>
+                            </div>
+                                <div class="io-description">
+                                </div>
+                    </td>
+                </tr>
+            </tbody>
+        </table>
+</section>
+            <section>
+    <h3 id="accessors">
+        Accessors
+    </h3>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="currentRow"></a>
+                        <span class="name"><b>currentRow</b><a href="#currentRow"><span class="icon ion-ios-link"></span></a></span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="accessor"><b>get</b><code>currentRow()</code></span>
+                    </td>
+                </tr>
+                            <tr>
+                                <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="93" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:93</a></div>
+                                </td>
+                            </tr>
+                    <tr>
+                        <td class="col-md-4">
+                                <div class="io-description"><p>The latest value emitted by the rowSubject</p>
+</div>
+                        </td>
+                    </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="currentColumn"></a>
+                        <span class="name"><b>currentColumn</b><a href="#currentColumn"><span class="icon ion-ios-link"></span></a></span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="accessor"><b>get</b><code>currentColumn()</code></span>
+                    </td>
+                </tr>
+                            <tr>
+                                <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="100" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:100</a></div>
+                                </td>
+                            </tr>
+                    <tr>
+                        <td class="col-md-4">
+                                <div class="io-description"><p>The latest value emitted by the columnSubject</p>
+</div>
+                        </td>
+                    </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="lastColumn"></a>
+                        <span class="name"><b>lastColumn</b><a href="#lastColumn"><span class="icon ion-ios-link"></span></a></span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="accessor"><b>get</b><code>lastColumn()</code></span>
+                    </td>
+                </tr>
+                            <tr>
+                                <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="107" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:107</a></div>
+                                </td>
+                            </tr>
+                    <tr>
+                        <td class="col-md-4">
+                                <div class="io-description"><p>The last column as reported by the adapter</p>
+</div>
+                        </td>
+                    </tr>
+            </tbody>
+        </table>
+        <table class="table table-sm table-bordered">
+            <tbody>
+                <tr>
+                    <td class="col-md-4">
+                        <a name="lastRow"></a>
+                        <span class="name"><b>lastRow</b><a href="#lastRow"><span class="icon ion-ios-link"></span></a></span>
+                    </td>
+                </tr>
+                <tr>
+                    <td class="col-md-4">
+                        <span class="accessor"><b>get</b><code>lastRow()</code></span>
+                    </td>
+                </tr>
+                            <tr>
+                                <td class="col-md-4">
+                                    <div class="io-line">Defined in <a href="" data-line="114" class="link-to-prism">src/table/data-grid-interaction-model.class.ts:114</a></div>
+                                </td>
+                            </tr>
+                    <tr>
+                        <td class="col-md-4">
+                                <div class="io-description"><p>The last row as reported by the adapter</p>
+</div>
+                        </td>
+                    </tr>
+            </tbody>
+        </table>
+</section>
+    </div>
+    <div class="tab-pane fade  tab-source-code" id="c-source">
+        <pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import {
+	BehaviorSubject,
+	Observable,
+	combineLatest
+} from &quot;rxjs&quot;;
+import { map } from &quot;rxjs/operators&quot;;
+import { TableAdapter } from &quot;./table-adapter.class&quot;;
+import { tabbableSelectorIgnoreTabIndex, getFocusElementList } from &quot;./../common/tab.service&quot;;
+/**
+ * The current and previous position in the grid.
+ *
+ * &#x60;current&#x60; and &#x60;previous&#x60; are tuples that follow the &#x60;[row, column]&#x60; convention.
+ */
+export interface DataGridPosition {
+	current: [number, number];
+	previous: [number, number];
+}
+/**
+ * &#x60;DataGridInteractionModel&#x60; provides centralized control over arbitrary 2d grids, following the w3 specs.
+ *
+ * Refs:
+ *  - https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html
+ *  - https://www.w3.org/TR/wai-aria-practices/#grid
+ *
+ * Example usage (taken from &#x60;table.component&#x60;):
+&#x60;&#x60;&#x60;typescript
+// a standard HTML table
+const table &#x3D; this.elementRef.nativeElement.querySelector(&quot;table&quot;) as HTMLTableElement;
+// &#x60;TableDomAdapter&#x60; implements &#x60;TableAdapter&#x60; and provides a consistent interface to query rows and columns in a table
+const tableAdapter &#x3D; new TableDomAdapter(table);
+// the keydown events that we&#x27;ll use for keyboard navigation of the table
+const keydownEventStream &#x3D; fromEvent&lt;KeyboardEvent&gt;(table, &quot;keydown&quot;);
+// the click events we&#x27;ll use to ensure focus is updated correctly on click
+const clickEventStream &#x3D; fromEvent&lt;MouseEvent&gt;(table, &quot;click&quot;);
+// the &#x60;DataGridInteractionModel&#x60; instance!
+this.interactionModel &#x3D; new DataGridInteractionModel(keydownEventStream, clickEventStream, tableAdapter);
+// subscribe to the combined position updates
+this.interactionModel.position.subscribe(event &#x3D;&gt; {
+	const [currentRow, currentColumn] &#x3D; event.current;
+	const [previousRow, previousColumn] &#x3D; event.previous;
+	// query the TableAdapter for the cell at the current row and column ...
+	const currentElement &#x3D; tableAdapter.getCell(currentRow, currentColumn);
+	// ... and make it focusable it
+	Table.setTabIndex(currentElement, 0);
+	// if the model has just initialized don&#x27;t focus or reset anything
+	if (previousRow &#x3D;&#x3D;&#x3D; -1 || previousColumn &#x3D;&#x3D;&#x3D; -1) { return; }
+	// query the TableAdapter for the cell at the previous row and column ...
+	const previousElement &#x3D; tableAdapter.getCell(previousRow, previousColumn);
+	// ... and make it unfocusable (now there is only a single focusable cell)
+	Table.setTabIndex(previousElement, -1);
+	// finally, focus the current cell (skipped during initilzation)
+	Table.focus(currentElement);
+});
+&#x60;&#x60;&#x60;
+ */
+export class DataGridInteractionModel {
+	/**
+	 * An Observable that provides an aggregated view of the &#x60;rowIndex&#x60; and &#x60;columnIndex&#x60; Observables
+	 */
+	readonly position: Observable&lt;DataGridPosition&gt;;
+	/**
+	 * An Observable that provides the current and previous row indexes.
+	 */
+	readonly rowIndex: Observable&lt;{ current: number, previous: number }&gt;;
+	/**
+	 * An Observable that provides the current and previous column indexes.
+	 */
+	readonly columnIndex: Observable&lt;{ current: number, previous: number }&gt;;
+	/**
+	 * Internal subject to handle changes in row
+	 */
+	protected rowSubject &#x3D; new BehaviorSubject({ current: 0, previous: -1 });
+	/**
+	 * Internal subject to handle changes in column
+	 */
+	protected columnSubject &#x3D; new BehaviorSubject({ current: 0, previous: -1 });
+	/**
+	 * The latest value emitted by the rowSubject
+	 */
+	protected get currentRow() {
+		return this.rowSubject.getValue().current;
+	}
+	/**
+	 * The latest value emitted by the columnSubject
+	 */
+	protected get currentColumn() {
+		return this.columnSubject.getValue().current;
+	}
+	/**
+	 * The last column as reported by the adapter
+	 */
+	protected get lastColumn() {
+		return this.tableAdapter.lastColumnIndex;
+	}
+	/**
+	 * The last row as reported by the adapter
+	 */
+	protected get lastRow() {
+		return this.tableAdapter.lastRowIndex;
+	}
+	/**
+	 * &#x60;DataGridInteractionModel&#x60; requires knowledge of events, and a representation of your table/grid to be useful.
+	 *
+	 * @param keyboardEventStream an Observable of KeyboardEvents. Should be scoped to the table container.
+	 * @param clickEventStream an Observable of ClickEvents. should only include clicks that take action on items known by the TableAdapter
+	 * @param tableAdapter an instance of a concrete class that implements TableAdapter. The standard carbon table uses TableDomAdapter
+	 */
+	constructor(
+		protected keyboardEventStream: Observable&lt;KeyboardEvent&gt;,
+		protected clickEventStream: Observable&lt;MouseEvent&gt;,
+		protected tableAdapter: TableAdapter
+	) {
+		this.rowIndex &#x3D; this.rowSubject.asObservable();
+		this.columnIndex &#x3D; this.columnSubject.asObservable();
+		this.position &#x3D; combineLatest(this.rowIndex, this.columnIndex).pipe(map(positions &#x3D;&gt; {
+			const [row, column] &#x3D; positions;
+			return {
+				current: [row.current, column.current],
+				previous: [row.previous, column.previous]
+			};
+		})) as Observable&lt;DataGridPosition&gt;;
+		this.keyboardEventStream.subscribe(this.handleKeyboardEvent.bind(this));
+		this.clickEventStream.subscribe(this.handleClickEvent.bind(this));
+	}
+	/**
+	 * Handles moving the position according to the w3 datagrid navigation specs
+	 *
+	 * Refs:
+	 *  - https://www.w3.org/TR/wai-aria-practices/examples/grid/dataGrids.html
+	 *  - https://www.w3.org/TR/wai-aria-practices/#grid
+	 *
+	 * @param event the KeyboardEvent to handle
+	 */
+	handleKeyboardEvent(event: KeyboardEvent) {
+		const currentCell &#x3D; this.tableAdapter.getCell(this.currentRow, this.currentColumn);
+		switch (event.key) {
+			case &quot;Right&quot;: // IE specific value
+			case &quot;ArrowRight&quot;:
+				event.preventDefault();
+				// add the colspan since getColumnFromCell will return the
+				// first column containing the cell (of N columns it may span)
+				// and we want to navigate to the next &quot;real&quot; column
+				this.goToColumn(this.tableAdapter.findColumnIndex(currentCell) + currentCell.colSpan);
+				break;
+			case &quot;Left&quot;: // IE specific value
+			case &quot;ArrowLeft&quot;:
+				event.preventDefault();
+				// we only ever need to subtract 1 from the column, since getColumnFromCell returns the
+				// first of N columns containing the cell
+				this.goToColumn(this.tableAdapter.findColumnIndex(currentCell) - 1);
+				break;
+			case &quot;Down&quot;: // IE specific value
+			case &quot;ArrowDown&quot;:
+				event.preventDefault();
+				this.goToRow(this.currentRow + 1);
+				break;
+			case &quot;Up&quot;: // IE specific value
+			case &quot;ArrowUp&quot;:
+				event.preventDefault();
+				this.goToRow(this.currentRow - 1);
+				break;
+			case &quot;Home&quot;:
+				event.preventDefault();
+				if (event.ctrlKey) {
+					this.goTo({row: 0, column: 0});
+				} else {
+					this.goToColumn(0);
+				}
+				break;
+			case &quot;End&quot;:
+				event.preventDefault();
+				if (event.ctrlKey) {
+					this.goTo({ row: this.lastRow, column: this.lastColumn });
+				} else {
+					this.goToColumn(this.lastColumn);
+				}
+				break;
+		}
+	}
+	/**
+	 * Handles moving the position to the clicked cell
+	 *
+	 * @param event the MouseEvent to handle
+	 */
+	handleClickEvent(event: MouseEvent) {
+		const cell &#x3D; (event.target as HTMLElement).closest(&quot;td, th&quot;) as HTMLTableCellElement;
+		const [rowIndex, cellIndex] &#x3D; this.tableAdapter.findIndex(cell);
+		this.goTo({ row: rowIndex, column: cellIndex });
+	}
+	/**
+	 * Jump to a specific column without changing the row
+	 *
+	 * @param index column to jump to
+	 */
+	goToColumn(index: number) {
+		if (index &gt; this.lastColumn || index &lt; 0) { return; }
+		this.goTo({ row: this.currentRow, column: index});
+	}
+	/**
+	 * Jump to a specific row without chaning the column
+	 *
+	 * @param index row to jump to
+	 */
+	goToRow(index: number) {
+		if (index &gt; this.lastRow || index &lt; 0) { return; }
+		this.goTo({row: index, column: this.currentColumn});
+	}
+	/**
+	 * Jump to the specified row and column
+	 *
+	 * @param param0 an object that contains &#x60;row&#x60; and &#x60;column&#x60; properties
+	 */
+	goTo({row, column}) {
+		this.rowSubject.next({ current: row, previous: this.currentRow });
+		this.columnSubject.next({ current: column, previous: this.currentColumn });
+	}
+	/**
+	 * Convenience method to reset the tab indexes on a standard carbon table.
+	 * For custom tables you may want to reset the indexes manually and simply call &#x60;.reset()&#x60;
+	 */
+	resetTabIndexes(newTabIndex &#x3D; -1) {
+		for (let i &#x3D; 0; i &lt; this.tableAdapter.lastRowIndex; i++) {
+			const row &#x3D; this.tableAdapter.getRow(i) as HTMLTableRowElement;
+			for (const cell of Array.from(row.cells)) {
+				const tabbableElements &#x3D; getFocusElementList(cell, tabbableSelectorIgnoreTabIndex);
+				tabbableElements.forEach((node: HTMLElement) &#x3D;&gt; node.tabIndex &#x3D; newTabIndex);
+				cell.tabIndex &#x3D; newTabIndex;
+			}
+		}
+		this.reset();
+	}
+	/**
+	 * Resets the models focus position
+	 */
+	reset() {
+		this.rowSubject.next({ current: 0, previous: -1 });
+		this.columnSubject.next({ current: 0, previous: -1 });
+	}
+}
+</code></pre>
+    </div>
+</div>
+                   </div><div class="search-results">
+    <div class="has-results">
+        <h1 class="search-results-title"><span class='search-results-count'></span> result-matching "<span class='search-query'></span>"</h1>
+        <ul class="search-results-list"></ul>
+    </div>
+    <div class="no-results">
+        <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
+    </div>
+</div>
+</div>
+               <!-- END CONTENT -->
+           </div>
+       </div>
+       <script>
+            var COMPODOC_CURRENT_PAGE_DEPTH = 1;
+            var COMPODOC_CURRENT_PAGE_CONTEXT = 'class';
+            var COMPODOC_CURRENT_PAGE_URL = 'DataGridInteractionModel.html';
+       </script>
+       <script src="../js/libs/custom-elements.min.js"></script>
+       <script src="../js/libs/lit-html.js"></script>
+       <!-- Required to polyfill modern browsers as code is ES5 for IE... -->
+       <script src="../js/libs/custom-elements-es5-adapter.js" charset="utf-8" defer></script>
+       <script src="../js/menu-wc.js" defer></script>
+       <script src="../js/libs/bootstrap-native.js"></script>
+       <script src="../js/libs/es6-shim.min.js"></script>
+       <script src="../js/libs/EventDispatcher.js"></script>
+       <script src="../js/libs/promise.min.js"></script>
+       <script src="../js/libs/zepto.min.js"></script>
+       <script src="../js/compodoc.js"></script>
+       <script src="../js/tabs.js"></script>
+       <script src="../js/menu.js"></script>
+       <script src="../js/libs/clipboard.min.js"></script>
+       <script src="../js/libs/prism.js"></script>
+       <script src="../js/sourceCode.js"></script>
+          <script src="../js/search/search.js"></script>
+          <script src="../js/search/lunr.min.js"></script>
+          <script src="../js/search/search-lunr.js"></script>
+          <script src="../js/search/search_index.js"></script>
+       <script src="../js/lazy-load-graphs.js"></script>
+    </body>
+</html>