carbon-components-angular

<!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"> </head> <body> <div class="navbar navbar-default navbar-fixed-top d-block d-sm-none"> <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>  <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> <div><pre class="line-numbers"><code class="language-html"> <thead cdsTableHead [model]="model"></thead></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"><ng-container *ngIf="model"> <tr> <th cdsTableHeadExpand *ngIf="model.hasExpandableRows()" scope="col" [ngClass]="{'cds--table-expand-v2': stickyHeader}" [id]="model.getId('expand')"> </th> <th *ngIf="!skeleton && showSelectionColumn && enableSingleSelect" scope="col" [id]="model.getId('select')">  </th> <th cdsTableHeadCheckbox *ngIf="!skeleton && showSelectionColumn && !enableSingleSelect" scope="col" [checked]="selectAllCheckbox" [indeterminate]="selectAllCheckboxSomeSelected" [ariaLabel]="getCheckboxHeaderLabel()" [skeleton]="skeleton" [name]="model.getHeaderId('select')" (change)="onSelectAllCheckboxChange()" [id]="model.getId('select')"> </th> <ng-container *ngFor="let column of model.header; let i = index"> <th *ngIf="column && column.visible" [ngStyle]="column.style" cdsTableHeadCell scope="col" [class]="column.className" [sortable]="sortable" [skeleton]="skeleton" [id]="model.getId(i)" [column]="column" [filterTitle]="getFilterTitle()" [attr.colspan]="column.colSpan" [attr.rowspan]="column.rowSpan" (sort)="sort.emit(i)"> </th> </ng-container> <th *ngIf="!skeleton && stickyHeader && scrollbarWidth" scope="col" [ngStyle]="{'width': scrollbarWidth + 'px', 'padding': 0, 'border': 0}">  </th> </tr> </ng-container> <ng-content></ng-content> </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="#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="#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="#deselectAll" >deselectAll</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="169" class="link-to-prism">src/table/head/table-head.component.ts:169</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="112" class="link-to-prism">src/table/head/table-head.component.ts:112</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="95" class="link-to-prism">src/table/head/table-head.component.ts:95</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="139" class="link-to-prism">src/table/head/table-head.component.ts:139</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="91" class="link-to-prism">src/table/head/table-head.component.ts:91</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="99" class="link-to-prism">src/table/head/table-head.component.ts:99</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="97" class="link-to-prism">src/table/head/table-head.component.ts:97</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="93" class="link-to-prism">src/table/head/table-head.component.ts:93</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="101" class="link-to-prism">src/table/head/table-head.component.ts:101</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="109" class="link-to-prism">src/table/head/table-head.component.ts:109</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="130" class="link-to-prism">src/table/head/table-head.component.ts:130</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="121" class="link-to-prism">src/table/head/table-head.component.ts:121</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="103" class="link-to-prism">src/table/head/table-head.component.ts:103</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="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="162" class="link-to-prism">src/table/head/table-head.component.ts:162</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="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="156" class="link-to-prism">src/table/head/table-head.component.ts:156</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="150" class="link-to-prism">src/table/head/table-head.component.ts:150</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="187" class="link-to-prism">src/table/head/table-head.component.ts:187</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable<string></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="199" class="link-to-prism">src/table/head/table-head.component.ts:199</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable<string></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="195" class="link-to-prism">src/table/head/table-head.component.ts:195</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable<string></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="191" class="link-to-prism">src/table/head/table-head.component.ts:191</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"> <b>Returns : </b> <code>Observable<string></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="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"> <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="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="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"> <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("TABLE.CHECKBOX_HEADER")</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="166" class="link-to-prism">src/table/head/table-head.component.ts:166</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("TABLE.FILTER")</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="169" class="link-to-prism">src/table/head/table-head.component.ts:169</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_sortAscendingLabel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_sortAscendingLabel</b></span> <a href="#_sortAscendingLabel"><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("TABLE.SORT_ASCENDING")</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="168" class="link-to-prism">src/table/head/table-head.component.ts:168</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="_sortDescendingLabel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_sortDescendingLabel</b></span> <a href="#_sortDescendingLabel"><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("TABLE.SORT_DESCENDING")</code> </td> </tr> <tr> <td class="col-md-4"> <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> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="scrollbarWidth"></a> <span class="name"> <span class="modifier">Public</span> <span ><b>scrollbarWidth</b></span> <a href="#scrollbarWidth"><span class="icon ion-ios-link"></span></a> </span> </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/number" target="_blank" >number</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>0</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="164" class="link-to-prism">src/table/head/table-head.component.ts:164</a></div> </td> </tr> </tbody> </table> </section> <section data-compodoc="block-accessors"> <h3 id="accessors"> Accessors </h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="checkboxHeaderLabel"></a> <span class="name"><b>checkboxHeaderLabel</b><a href="#checkboxHeaderLabel"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>checkboxHeaderLabel()</code></span> </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/head/table-head.component.ts:116</a></div> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>set</b><code>checkboxHeaderLabel(value: string | Observable<string>)</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="112" class="link-to-prism">src/table/head/table-head.component.ts:112</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>value</td> <td> <code>string | Observable<string></code> </td> <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> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="sortDescendingLabel"></a> <span class="name"><b>sortDescendingLabel</b><a href="#sortDescendingLabel"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>sortDescendingLabel()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="125" class="link-to-prism">src/table/head/table-head.component.ts:125</a></div> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>set</b><code>sortDescendingLabel(value: string | Observable<string>)</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="121" class="link-to-prism">src/table/head/table-head.component.ts:121</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>