UNPKG

carbon-components-angular

Version:
1,294 lines (1,160 loc) 94.9 kB
<!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"> <link rel="stylesheet" href="../styles/dark.css"> <style> footer.carbon { position: absolute; bottom: 0; width: 100%; z-index: 9999; } #root > div { /* * Subtracting the height of the footer to prevent * overlaying the footer ontop of content */ height: calc(100vh - 48px); } </style> </head> <body> <script> // Blocking script to avoid flickering dark mode // Dark mode toggle button var useDark = window.matchMedia('(prefers-color-scheme: dark)'); var darkModeState = useDark.matches; var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input'); var $darkModeToggles = document.querySelectorAll('.dark-mode-switch'); var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state'); function checkToggle(check) { for (var i = 0; i < $darkModeToggleSwitchers.length; i++) { $darkModeToggleSwitchers[i].checked = check; } } function toggleDarkMode(state) { if (window.localStorage) { localStorage.setItem('compodoc_darkmode-state', state); } checkToggle(state); const hasClass = document.body.classList.contains('dark'); if (state) { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.add('dark'); } if (!hasClass) { document.body.classList.add('dark'); } } else { for (var i = 0; i < $darkModeToggles.length; i++) { $darkModeToggles[i].classList.remove('dark'); } if (hasClass) { document.body.classList.remove('dark'); } } } useDark.addEventListener('change', function (evt) { toggleDarkMode(evt.matches); }); if (darkModeStateLocal) { darkModeState = darkModeStateLocal === 'true'; } toggleDarkMode(darkModeState); </script> <div class="navbar navbar-default navbar-fixed-top d-md-none p-0"> <div class="d-flex"> <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> <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="d-none d-md-block menu"> <compodoc-menu mode="normal"></compodoc-menu> </div> <!-- START CONTENT --> <div class="content component"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Components</li> <li class="breadcrumb-item" > TableHead</li> </ol> <ul class="nav nav-tabs" role="tablist"> <li class="nav-item"> <a href="#info" class="nav-link active" role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a> </li> <li class="nav-item"> <a href="#source" class="nav-link" role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a> </li> <li class="nav-item"> <a href="#styleData" class="nav-link" role="tab" id="styleData-tab" data-bs-toggle="tab" data-link="style">Styles</a> </li> <li class="nav-item"> <a href="#tree" class="nav-link" role="tab" id="tree-tab" data-bs-toggle="tab" data-link="dom-tree">DOM Tree</a> </li> </ul> <div class="tab-content"> <div class="tab-pane fade active in" id="info"><p class="comment"> <h3>File</h3> </p> <p class="comment"> <code>src/table/head/table-head.component.ts</code> </p> <p class="comment"> <h3>Description</h3> </p> <p class="comment"> <p>A subcomponent that creates the thead of the table</p> <h2>Basic usage</h2> <b>Example :</b><div><pre class="line-numbers"><code class="language-html"> &lt;thead cdsTableHead [model]=&quot;model&quot;&gt;&lt;/thead&gt;</code></pre></div> </p> <p class="comment"> <h3>Implements</h3> </p> <p class="comment"> <code>AfterViewInit</code> </p> <section data-compodoc="block-metadata"> <h3>Metadata</h3> <table class="table table-sm table-hover metadata"> <tbody> <tr> <td class="col-md-3">selector</td> <td class="col-md-9"><code>[cdsTableHead], [ibmTableHead]</code></td> </tr> <tr> <td class="col-md-3">styles</td> <td class="col-md-9"><code> .cds--table-expand-v2 { padding-left: 2.5rem; } </code></td> </tr> <tr> <td class="col-md-3">template</td> <td class="col-md-9"><pre class="line-numbers"><code class="language-html">&lt;ng-container *ngIf&#x3D;&quot;model&quot;&gt; &lt;tr&gt; &lt;th cdsTableHeadExpand *ngIf&#x3D;&quot;model.hasExpandableRows()&quot; scope&#x3D;&quot;col&quot; [showExpandAllToggle]&#x3D;&quot;showExpandAllToggle&quot; [ngClass]&#x3D;&quot;{&#x27;cds--table-expand-v2&#x27;: stickyHeader}&quot; [id]&#x3D;&quot;model.getId(&#x27;expand&#x27;)&quot; [expanded]&#x3D;&quot;model.expandableRowsCount() &#x3D;&#x3D;&#x3D; model.expandedRowsCount()&quot; (expandedChange)&#x3D;&quot;onExpandAllRowsChange($event)&quot;&gt; &lt;/th&gt; &lt;th *ngIf&#x3D;&quot;!skeleton &amp;&amp; showSelectionColumn &amp;&amp; enableSingleSelect&quot; scope&#x3D;&quot;col&quot; [id]&#x3D;&quot;model.getId(&#x27;select&#x27;)&quot;&gt; &lt;!-- add width 0; since the carbon styles don&#x27;t seem to constrain this headers width --&gt; &lt;/th&gt; &lt;th cdsTableHeadCheckbox *ngIf&#x3D;&quot;!skeleton &amp;&amp; showSelectionColumn &amp;&amp; !enableSingleSelect&quot; scope&#x3D;&quot;col&quot; [checked]&#x3D;&quot;selectAllCheckbox&quot; [indeterminate]&#x3D;&quot;selectAllCheckboxSomeSelected&quot; [ariaLabel]&#x3D;&quot;getCheckboxHeaderLabel()&quot; [skeleton]&#x3D;&quot;skeleton&quot; [name]&#x3D;&quot;model.getHeaderId(&#x27;select&#x27;)&quot; (change)&#x3D;&quot;onSelectAllCheckboxChange()&quot; [id]&#x3D;&quot;model.getId(&#x27;select&#x27;)&quot;&gt; &lt;/th&gt; &lt;ng-container *ngFor&#x3D;&quot;let column of model.header; let i &#x3D; index&quot;&gt; &lt;th *ngIf&#x3D;&quot;column &amp;&amp; column.visible&quot; [ngStyle]&#x3D;&quot;column.style&quot; cdsTableHeadCell scope&#x3D;&quot;col&quot; [class]&#x3D;&quot;column.className&quot; [sortable]&#x3D;&quot;sortable&quot; [skeleton]&#x3D;&quot;skeleton&quot; [id]&#x3D;&quot;model.getId(i)&quot; [column]&#x3D;&quot;column&quot; [filterTitle]&#x3D;&quot;getFilterTitle()&quot; [attr.colspan]&#x3D;&quot;column.colSpan&quot; [attr.rowspan]&#x3D;&quot;column.rowSpan&quot; (sort)&#x3D;&quot;sort.emit(i)&quot;&gt; &lt;/th&gt; &lt;/ng-container&gt; &lt;th *ngIf&#x3D;&quot;!skeleton &amp;&amp; stickyHeader &amp;&amp; scrollbarWidth&quot; scope&#x3D;&quot;col&quot; [ngStyle]&#x3D;&quot;{&#x27;width&#x27;: scrollbarWidth + &#x27;px&#x27;, &#x27;padding&#x27;: 0, &#x27;border&#x27;: 0}&quot;&gt; &lt;!-- Scrollbar pushes body to the left so this header column is added to push the title bar the same amount and keep the header and body columns aligned. --&gt; &lt;/th&gt; &lt;/tr&gt; &lt;/ng-container&gt; &lt;ng-content&gt;&lt;/ng-content&gt; </code></pre></td> </tr> </tbody> </table> </section> <section data-compodoc="block-index"> <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">Protected</span> <a href="#_checkboxHeaderLabel" >_checkboxHeaderLabel</a> </li> <li> <span class="modifier">Protected</span> <a href="#_filterTitle" >_filterTitle</a> </li> <li> <span class="modifier">Protected</span> <a href="#_sortAscendingLabel" >_sortAscendingLabel</a> </li> <li> <span class="modifier">Protected</span> <a href="#_sortDescendingLabel" >_sortDescendingLabel</a> </li> <li> <span class="modifier">Public</span> <a href="#scrollbarWidth" >scrollbarWidth</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="#getCheckboxHeaderLabel" >getCheckboxHeaderLabel</a> </li> <li> <a href="#getFilterTitle" >getFilterTitle</a> </li> <li> <a href="#getSortAscendingLabel" >getSortAscendingLabel</a> </li> <li> <a href="#getSortDescendingLabel" >getSortDescendingLabel</a> </li> <li> <a href="#ngAfterViewInit" >ngAfterViewInit</a> </li> <li> <a href="#onExpandAllRowsChange" >onExpandAllRowsChange</a> </li> <li> <a href="#onSelectAllCheckboxChange" >onSelectAllCheckboxChange</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Inputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#checkboxHeaderLabel" >checkboxHeaderLabel</a> </li> <li> <a href="#enableSingleSelect" >enableSingleSelect</a> </li> <li> <a href="#filterTitle" >filterTitle</a> </li> <li> <a href="#model" >model</a> </li> <li> <a href="#selectAllCheckbox" >selectAllCheckbox</a> </li> <li> <a href="#selectAllCheckboxSomeSelected" >selectAllCheckboxSomeSelected</a> </li> <li> <a href="#showExpandAllToggle" >showExpandAllToggle</a> </li> <li> <a href="#showSelectionColumn" >showSelectionColumn</a> </li> <li> <a href="#skeleton" >skeleton</a> </li> <li> <a href="#sortable" >sortable</a> </li> <li> <a href="#sortAscendingLabel" >sortAscendingLabel</a> </li> <li> <a href="#sortDescendingLabel" >sortDescendingLabel</a> </li> <li> <a href="#stickyHeader" >stickyHeader</a> </li> </ul> </td> </tr> <tr> <td class="col-md-4"> <h6><b>Outputs</b></h6> </td> </tr> <tr> <td class="col-md-4"> <ul class="index-list"> <li> <a href="#collapseAllRows" >collapseAllRows</a> </li> <li> <a href="#deselectAll" >deselectAll</a> </li> <li> <a href="#expandAllRows" >expandAllRows</a> </li> <li> <a href="#selectAll" >selectAll</a> </li> <li> <a href="#sort" >sort</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="#checkboxHeaderLabel" >checkboxHeaderLabel</a> </li> <li> <a href="#sortDescendingLabel" >sortDescendingLabel</a> </li> <li> <a href="#sortAscendingLabel" >sortAscendingLabel</a> </li> <li> <a href="#filterTitle" >filterTitle</a> </li> </ul> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-constructor"> <h3 id="constructor">Constructor</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <code>constructor(i18n: <a href="../injectables/I18n.html" target="_self">I18n</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="186" class="link-to-prism">src/table/head/table-head.component.ts:186</a></div> </td> </tr> <tr> <td class="col-md-4"> <div> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>i18n</td> <td> <code><a href="../injectables/I18n.html" target="_self" >I18n</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-inputs"> <h3 id="inputs">Inputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="checkboxHeaderLabel"></a> <b>checkboxHeaderLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="117" class="link-to-prism">src/table/head/table-head.component.ts:117</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="enableSingleSelect"></a> <b>enableSingleSelect</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="98" class="link-to-prism">src/table/head/table-head.component.ts:98</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="filterTitle"></a> <b>filterTitle</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="144" class="link-to-prism">src/table/head/table-head.component.ts:144</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="model"></a> <b>model</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../classes/TableModel.html" target="_self" >TableModel</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="94" class="link-to-prism">src/table/head/table-head.component.ts:94</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectAllCheckbox"></a> <b>selectAllCheckbox</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="102" class="link-to-prism">src/table/head/table-head.component.ts:102</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectAllCheckboxSomeSelected"></a> <b>selectAllCheckboxSomeSelected</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="100" class="link-to-prism">src/table/head/table-head.component.ts:100</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="showExpandAllToggle"></a> <b>showExpandAllToggle</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="108" class="link-to-prism">src/table/head/table-head.component.ts:108</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="showSelectionColumn"></a> <b>showSelectionColumn</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>true</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="96" class="link-to-prism">src/table/head/table-head.component.ts:96</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="skeleton"></a> <b>skeleton</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="104" class="link-to-prism">src/table/head/table-head.component.ts:104</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sortable"></a> <b>sortable</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>true</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="114" class="link-to-prism">src/table/head/table-head.component.ts:114</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Setting sortable to false will disable all headers including headers which are sortable. Is is possible to set the sortable state on the header item to disable/enable sorting for only some headers.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sortAscendingLabel"></a> <b>sortAscendingLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="135" class="link-to-prism">src/table/head/table-head.component.ts:135</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sortDescendingLabel"></a> <b>sortDescendingLabel</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>string | Observable</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="126" class="link-to-prism">src/table/head/table-head.component.ts:126</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="stickyHeader"></a> <b>stickyHeader</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>false</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="106" class="link-to-prism">src/table/head/table-head.component.ts:106</a></div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-outputs"> <h3 id="outputs">Outputs</h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="collapseAllRows"></a> <b>collapseAllRows</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="179" class="link-to-prism">src/table/head/table-head.component.ts:179</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if all rows are collapsed.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="deselectAll"></a> <b>deselectAll</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="167" class="link-to-prism">src/table/head/table-head.component.ts:167</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if all rows are deselected.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="expandAllRows"></a> <b>expandAllRows</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="173" class="link-to-prism">src/table/head/table-head.component.ts:173</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if all rows are expanded.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectAll"></a> <b>selectAll</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="161" class="link-to-prism">src/table/head/table-head.component.ts:161</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if all rows are selected.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sort"></a> <b>sort</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code>EventEmitter</code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="155" class="link-to-prism">src/table/head/table-head.component.ts:155</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits an index of the column that wants to be sorted.</p> </div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-methods"> <h3 id="methods"> Methods </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getCheckboxHeaderLabel"></a> <span class="name"> <span ><b>getCheckboxHeaderLabel</b></span> <a href="#getCheckboxHeaderLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getCheckboxHeaderLabel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="212" class="link-to-prism">src/table/head/table-head.component.ts:212</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable&lt;string&gt;</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getFilterTitle"></a> <span class="name"> <span ><b>getFilterTitle</b></span> <a href="#getFilterTitle"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getFilterTitle()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="224" class="link-to-prism">src/table/head/table-head.component.ts:224</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable&lt;string&gt;</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getSortAscendingLabel"></a> <span class="name"> <span ><b>getSortAscendingLabel</b></span> <a href="#getSortAscendingLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getSortAscendingLabel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="220" class="link-to-prism">src/table/head/table-head.component.ts:220</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable&lt;string&gt;</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getSortDescendingLabel"></a> <span class="name"> <span ><b>getSortDescendingLabel</b></span> <a href="#getSortDescendingLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getSortDescendingLabel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="216" class="link-to-prism">src/table/head/table-head.component.ts:216</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable&lt;string&gt;</code> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="ngAfterViewInit"></a> <span class="name"> <span ><b>ngAfterViewInit</b></span> <a href="#ngAfterViewInit"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>ngAfterViewInit()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="190" class="link-to-prism">src/table/head/table-head.component.ts:190</a></div> </td> </tr> <tr> <td class="col-md-4"> <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="onExpandAllRowsChange"></a> <span class="name"> <span ><b>onExpandAllRowsChange</b></span> <a href="#onExpandAllRowsChange"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>onExpandAllRowsChange(expand: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank">boolean</a>)</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/head/table-head.component.ts:204</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Parameters :</b> <table class="params"> <thead> <tr> <td>Name</td> <td>Type</td> <td>Optional</td> </tr> </thead> <tbody> <tr> <td>expand</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</a></code> </td> <td> No </td> </tr> </tbody> </table> </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="onSelectAllCheckboxChange"></a> <span class="name"> <span ><b>onSelectAllCheckboxChange</b></span> <a href="#onSelectAllCheckboxChange"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>onSelectAllCheckboxChange()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="196" class="link-to-prism">src/table/head/table-head.component.ts:196</a></div> </td> </tr> <tr> <td class="col-md-4"> <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> </section> <section data-compodoc="block-properties"> <h3 id="inputs"> Properties </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_checkboxHeaderLabel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_checkboxHeaderLabel</b></span> <a href="#_checkboxHeaderLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;TABLE.CHECKBOX_HEADER&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="183" class="link-to-prism">src/table/head/table-head.component.ts:183</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_filterTitle"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_filterTitle</b></span> <a href="#_filterTitle"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>this.i18n.getOverridable(&quot;TABLE.FILTER&quot;)</code>