UNPKG

carbon-components-angular

Version:
1,244 lines (1,095 loc) 76.6 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" > TableBody</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="#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/body/table-body.component.ts</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>[cdsTableBody], [ibmTableBody]</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;ng-container *ngFor&#x3D;&quot;let row of model.data; let i &#x3D; index&quot;&gt; &lt;tr cdsTableRow [model]&#x3D;&quot;model&quot; [row]&#x3D;&quot;row&quot; [size]&#x3D;&quot;size&quot; [selected]&#x3D;&quot;model.isRowSelected(i)&quot; [expandable]&#x3D;&quot;model.isRowExpandable(i)&quot; [expanded]&#x3D;&quot;model.isRowExpanded(i)&quot; [checkboxLabel]&#x3D;&quot;getCheckboxRowLabel()&quot; [expandButtonAriaLabel]&#x3D;&quot;getExpandButtonAriaLabel()&quot; [showSelectionColumn]&#x3D;&quot;showSelectionColumn&quot; [enableSingleSelect]&#x3D;&quot;enableSingleSelect&quot; [skeleton]&#x3D;&quot;skeleton&quot; (selectRow)&#x3D;&quot;onRowCheckboxChange(i)&quot; (deselectRow)&#x3D;&quot;onRowCheckboxChange(i)&quot; (expandRow)&#x3D;&quot;model.expandRow(i, !model.isRowExpanded(i))&quot; (rowClick)&#x3D;&quot;onRowClick(i)&quot; *ngIf&#x3D;&quot;!model.isRowFiltered(i)&quot; [class]&#x3D;&quot;(model.rowsClass[i] ? model.rowsClass[i] : null)&quot; [ngClass]&#x3D;&quot;{ &#x27;tbody_row--success&#x27;: !model.isRowSelected(i) &amp;&amp; model.getRowContext(i) &#x3D;&#x3D;&#x3D; &#x27;success&#x27;, &#x27;tbody_row--warning&#x27;: !model.isRowSelected(i) &amp;&amp; model.getRowContext(i) &#x3D;&#x3D;&#x3D; &#x27;warning&#x27;, &#x27;tbody_row--info&#x27;: !model.isRowSelected(i) &amp;&amp; model.getRowContext(i) &#x3D;&#x3D;&#x3D; &#x27;info&#x27;, &#x27;tbody_row--error&#x27;: !model.isRowSelected(i) &amp;&amp; model.getRowContext(i) &#x3D;&#x3D;&#x3D; &#x27;error&#x27; }&quot;&gt; &lt;/tr&gt; &lt;tr *ngIf&#x3D;&quot;model.isRowExpandable(i) &amp;&amp; !shouldExpandAsTable(row) &amp;&amp; !model.isRowFiltered(i)&quot; cdsTableExpandedRow cdsExpandedRowHover [row]&#x3D;&quot;row&quot; [expanded]&#x3D;&quot;model.isRowExpanded(i)&quot; [skeleton]&#x3D;&quot;skeleton&quot;&gt; &lt;/tr&gt; &lt;ng-container *ngIf&#x3D;&quot;model.isRowExpandable(i) &amp;&amp; shouldExpandAsTable(row) &amp;&amp; model.isRowExpanded(i) &amp;&amp; !model.isRowFiltered(i)&quot;&gt; &lt;tr *ngFor&#x3D;&quot;let expandedDataRow of firstExpandedDataInRow(row)&quot; cdsTableRow [model]&#x3D;&quot;model&quot; [showSelectionColumnCheckbox]&#x3D;&quot;false&quot; [showSelectionColumn]&#x3D;&quot;showSelectionColumn&quot; [row]&#x3D;&quot;expandedDataRow&quot; [size]&#x3D;&quot;size&quot; [skeleton]&#x3D;&quot;skeleton&quot;&gt; &lt;/tr&gt; &lt;/ng-container&gt; &lt;/ng-container&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="#_checkboxRowLabel" >_checkboxRowLabel</a> </li> <li> <span class="modifier">Protected</span> <a href="#_expandButtonAriaLabel" >_expandButtonAriaLabel</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="#firstExpandedDataInRow" >firstExpandedDataInRow</a> </li> <li> <a href="#getCheckboxRowLabel" >getCheckboxRowLabel</a> </li> <li> <a href="#getExpandButtonAriaLabel" >getExpandButtonAriaLabel</a> </li> <li> <a href="#onRowCheckboxChange" >onRowCheckboxChange</a> </li> <li> <a href="#onRowClick" >onRowClick</a> </li> <li> <a href="#shouldExpandAsTable" >shouldExpandAsTable</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="#checkboxRowLabel" >checkboxRowLabel</a> </li> <li> <a href="#enableSingleSelect" >enableSingleSelect</a> </li> <li> <a href="#expandButtonAriaLabel" >expandButtonAriaLabel</a> </li> <li> <a href="#model" >model</a> </li> <li> <a href="#selectionLabelColumn" >selectionLabelColumn</a> </li> <li> <a href="#showSelectionColumn" >showSelectionColumn</a> </li> <li> <a href="#size" >size</a> </li> <li> <a href="#skeleton" >skeleton</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="#deselectRow" >deselectRow</a> </li> <li> <a href="#rowClick" >rowClick</a> </li> <li> <a href="#selectRow" >selectRow</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="#expandButtonAriaLabel" >expandButtonAriaLabel</a> </li> <li> <a href="#checkboxRowLabel" >checkboxRowLabel</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="140" class="link-to-prism">src/table/body/table-body.component.ts:140</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="checkboxRowLabel"></a> <b>checkboxRowLabel</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="88" class="link-to-prism">src/table/body/table-body.component.ts:88</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="76" class="link-to-prism">src/table/body/table-body.component.ts:76</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Controls whether to enable multiple or single row selection.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="expandButtonAriaLabel"></a> <b>expandButtonAriaLabel</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="79" class="link-to-prism">src/table/body/table-body.component.ts:79</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="71" class="link-to-prism">src/table/body/table-body.component.ts:71</a></div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectionLabelColumn"></a> <b>selectionLabelColumn</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/number" target="_blank" >number</a></code> </td> </tr> <tr> <td class="col-md-2" colspan="2"> <div class="io-line">Defined in <a href="" data-line="116" class="link-to-prism">src/table/body/table-body.component.ts:116</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Used to populate the row selection checkbox label with a useful value if set.</p> <p>Example:</p> <b>Example :</b><div><pre class="line-numbers"><code class="language-none">&lt;cds-table [selectionLabelColumn]=&quot;0&quot;&gt;&lt;/cds-table&gt; &lt;!-- results in aria-label=&quot;Select first column value&quot; (where &quot;first column value&quot; is the value of the first column in the row --&gt;</code></pre></div></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="99" class="link-to-prism">src/table/body/table-body.component.ts:99</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Controls whether to show the selection checkboxes column or not.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="size"></a> <b>size</b> </td> </tr> <tr> <td class="col-md-4"> <i>Type : </i> <code><a href="../miscellaneous/typealiases.html#TableRowSize" target="_self" >TableRowSize</a></code> </td> </tr> <tr> <td class="col-md-4"> <i>Default value : </i><code>&quot;md&quot;</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/body/table-body.component.ts:104</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Size of the table rows.</p> </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="118" class="link-to-prism">src/table/body/table-body.component.ts:118</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="deselectRow"></a> <b>deselectRow</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="132" class="link-to-prism">src/table/body/table-body.component.ts:132</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if a single row is deselected.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="rowClick"></a> <b>rowClick</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="137" class="link-to-prism">src/table/body/table-body.component.ts:137</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if a row item excluding expandButtons, checkboxes, or radios is clicked.</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="selectRow"></a> <b>selectRow</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="125" class="link-to-prism">src/table/body/table-body.component.ts:125</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Emits if a single row is selected.</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="firstExpandedDataInRow"></a> <span class="name"> <span ><b>firstExpandedDataInRow</b></span> <a href="#firstExpandedDataInRow"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>firstExpandedDataInRow(row)</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/body/table-body.component.ts:169</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>Optional</td> </tr> </thead> <tbody> <tr> <td>row</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" >any</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="getCheckboxRowLabel"></a> <span class="name"> <span ><b>getCheckboxRowLabel</b></span> <a href="#getCheckboxRowLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getCheckboxRowLabel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="161" class="link-to-prism">src/table/body/table-body.component.ts:161</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="getExpandButtonAriaLabel"></a> <span class="name"> <span ><b>getExpandButtonAriaLabel</b></span> <a href="#getExpandButtonAriaLabel"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getExpandButtonAriaLabel()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="165" class="link-to-prism">src/table/body/table-body.component.ts:165</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="onRowCheckboxChange"></a> <span class="name"> <span ><b>onRowCheckboxChange</b></span> <a href="#onRowCheckboxChange"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>onRowCheckboxChange(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="149" class="link-to-prism">src/table/body/table-body.component.ts:149</a></div> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Triggered when a single row is clicked. Updates the header checkbox state. Emits the <code>selectRow</code> or <code>deselectRow</code> event.</p> </div> <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>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> </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="onRowClick"></a> <span class="name"> <span ><b>onRowClick</b></span> <a href="#onRowClick"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>onRowClick(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="157" class="link-to-prism">src/table/body/table-body.component.ts:157</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>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> </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="shouldExpandAsTable"></a> <span class="name"> <span ><b>shouldExpandAsTable</b></span> <a href="#shouldExpandAsTable"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>shouldExpandAsTable(row)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="177" class="link-to-prism">src/table/body/table-body.component.ts:177</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>Optional</td> </tr> </thead> <tbody> <tr> <td>row</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" >any</a></code> </div> <div class="io-description"> </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="_checkboxRowLabel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_checkboxRowLabel</b></span> <a href="#_checkboxRowLabel"><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_ROW&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="139" class="link-to-prism">src/table/body/table-body.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="_expandButtonAriaLabel"></a> <span class="name"> <span class="modifier">Protected</span> <span ><b>_expandButtonAriaLabel</b></span> <a href="#_expandButtonAriaLabel"><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.EXPAND_BUTTON&quot;)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="140" class="link-to-prism">src/table/body/table-body.component.ts:140</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="expandButtonAriaLabel"></a> <span class="name"><b>expandButtonAriaLabel</b><a href="#expandButtonAriaLabel"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>expandButtonAriaLabel()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="83" class="link-to-prism">src/table/body/table-body.component.ts:83</a></div> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>set</b><code>expandButtonAriaLabel(value: string | Observable<string>)</code></span> </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/body/table-body.component.ts:79</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&lt;string&gt;</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="checkboxRowLabel"></a> <span class="name"><b>checkboxRowLabel</b><a href="#checkboxRowLabel"><span class="icon ion-ios-link"></span></a></span> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>get</b><code>checkboxRowLabel()</code></span> </td> </tr> <tr> <td class="col-md-4"> <div class="io-line">Defined in <a href="" data-line="92" class="link-to-prism">src/table/body/table-body.component.ts:92</a></div> </td> </tr> <tr> <td class="col-md-4"> <span class="accessor"><b>set</b><code>checkboxRowLabel(value: string | Observable<string>)</code></span> </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/body/table-body.component.ts:88</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&lt;string&gt;</