UNPKG

@rxap/material-table-system

Version:

This package provides a set of Angular directives, components, and services to enhance and customize Angular Material tables. It includes features such as row selection, column filtering, expandable rows, table actions, and more. The goal is to simplify c

1,195 lines (978 loc) 52.9 kB
<!doctype html> <html class="no-js" lang=""> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <title>angular-material-table-system</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> <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">angular-material-table-system</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 miscellaneous-functions"> <div class="content-data"> <ol class="breadcrumb"> <li class="breadcrumb-item">Miscellaneous</li> <li class="breadcrumb-item">Functions</li> </ol> <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"> <ul class="index-list"> <li> <a href="#getMultipleValuesInSingleSelectionError" title="src/lib/select-row/selection-model.ts" ><b>getMultipleValuesInSingleSelectionError</b>&nbsp;&nbsp;&nbsp;(src/.../selection-model.ts)</a> </li> <li> <a href="#GetTableHeaderButtonMetadata" title="src/lib/table-header-button/decorators.ts" ><b>GetTableHeaderButtonMetadata</b>&nbsp;&nbsp;&nbsp;(src/.../decorators.ts)</a> </li> <li> <a href="#GetTableRowActionCheckFunction" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>GetTableRowActionCheckFunction</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#GetTableRowActionMetadata" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>GetTableRowActionMetadata</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#HasTableRowActionCheckFunction" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>HasTableRowActionCheckFunction</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#HasTableRowActionMetadata" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>HasTableRowActionMetadata</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#initGenerator" title="src/generators/init/generator.ts" ><b>initGenerator</b>&nbsp;&nbsp;&nbsp;(src/.../generator.ts)</a> </li> <li> <a href="#IsTableRowActionTypeMethod" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>IsTableRowActionTypeMethod</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#IsTableRowActionTypeSwitchMethod" title="src/lib/table-row-actions/table-row-action.method.ts" ><b>IsTableRowActionTypeSwitchMethod</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-action.method.ts)</a> </li> <li> <a href="#NormalizeTableRow" title="src/lib/table-row-metadata.ts" ><b>NormalizeTableRow</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-metadata.ts)</a> </li> <li> <a href="#NormalizeTableRow" title="src/lib/table-row-metadata.ts" ><b>NormalizeTableRow</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-metadata.ts)</a> </li> <li> <a href="#NormalizeTableRow" title="src/lib/table-row-metadata.ts" ><b>NormalizeTableRow</b>&nbsp;&nbsp;&nbsp;(src/.../table-row-metadata.ts)</a> </li> <li> <a href="#TableActionMethod" title="src/lib/table-row-actions/decorators.ts" ><b>TableActionMethod</b>&nbsp;&nbsp;&nbsp;(src/.../decorators.ts)</a> </li> <li> <a href="#TableActionMethod" title="src/lib/table-row-actions/decorators.ts" ><b>TableActionMethod</b>&nbsp;&nbsp;&nbsp;(src/.../decorators.ts)</a> </li> <li> <a href="#TableActionMethod" title="src/lib/table-row-actions/decorators.ts" ><b>TableActionMethod</b>&nbsp;&nbsp;&nbsp;(src/.../decorators.ts)</a> </li> <li> <a href="#TableHeaderButtonMethod" title="src/lib/table-header-button/decorators.ts" ><b>TableHeaderButtonMethod</b>&nbsp;&nbsp;&nbsp;(src/.../decorators.ts)</a> </li> </ul> </td> </tr> </tbody> </table> </section> <h3>src/lib/select-row/selection-model.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="getMultipleValuesInSingleSelectionError"></a> <span class="name"> <span ><b>getMultipleValuesInSingleSelectionError</b></span> <a href="#getMultipleValuesInSingleSelectionError"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>getMultipleValuesInSingleSelectionError()</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Returns an error that reports that multiple values are passed into a selection model with a single value.</p> </div> </td> </tr> </tbody> </table> </section> <h3>src/lib/table-header-button/decorators.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="GetTableHeaderButtonMetadata"></a> <span class="name"> <span ><b>GetTableHeaderButtonMetadata</b></span> <a href="#GetTableHeaderButtonMetadata"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>GetTableHeaderButtonMetadata(method: Method)</code> </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>method</td> <td> <code>Method</code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../interfaces/TableHeaderButtonMethodOptions.html" target="_self" >TableHeaderButtonMethodOptions</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="TableHeaderButtonMethod"></a> <span class="name"> <span ><b>TableHeaderButtonMethod</b></span> <a href="#TableHeaderButtonMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>TableHeaderButtonMethod(options: <a href="../interfaces/TableHeaderButtonMethodOptions.html" target="_self">TableHeaderButtonMethodOptions</a>)</code> </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> <td>Default value</td> </tr> </thead> <tbody> <tr> <td>options</td> <td> <code><a href="../interfaces/TableHeaderButtonMethodOptions.html" target="_self" >TableHeaderButtonMethodOptions</a></code> </td> <td> No </td> <td> <code>{}</code> </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>ClassDecorator</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> <h3>src/lib/table-row-actions/table-row-action.method.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="GetTableRowActionCheckFunction"></a> <span class="name"> <span ><b>GetTableRowActionCheckFunction</b></span> <a href="#GetTableRowActionCheckFunction"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>GetTableRowActionCheckFunction(method: <a href="../undefineds/TableRowActionMethod.html" target="_self">TableRowActionMethod</a>)</code> </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>method</td> <td> <code><a href="../miscellaneous/typealiases.html#TableRowActionMethod" target="_self" >TableRowActionMethod</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#RowActionCheckFunction" target="_self" >RowActionCheckFunction&lt;Data&gt;</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="GetTableRowActionMetadata"></a> <span class="name"> <span ><b>GetTableRowActionMetadata</b></span> <a href="#GetTableRowActionMetadata"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>GetTableRowActionMetadata(method: <a href="../undefineds/TableRowActionMethod.html" target="_self">TableRowActionMethod</a>)</code> </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>method</td> <td> <code><a href="../miscellaneous/typealiases.html#TableRowActionMethod" target="_self" >TableRowActionMethod</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../interfaces/TableActionMethodOptions.html" target="_self" >TableActionMethodOptions</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="HasTableRowActionCheckFunction"></a> <span class="name"> <span ><b>HasTableRowActionCheckFunction</b></span> <a href="#HasTableRowActionCheckFunction"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>HasTableRowActionCheckFunction(method: <a href="../undefineds/TableRowActionMethod.html" target="_self">TableRowActionMethod</a>)</code> </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>method</td> <td> <code><a href="../miscellaneous/typealiases.html#TableRowActionMethod" target="_self" >TableRowActionMethod</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</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="HasTableRowActionMetadata"></a> <span class="name"> <span ><b>HasTableRowActionMetadata</b></span> <a href="#HasTableRowActionMetadata"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>HasTableRowActionMetadata(method: <a href="../undefineds/TableRowActionMethod.html" target="_self">TableRowActionMethod</a>)</code> </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>method</td> <td> <code><a href="../miscellaneous/typealiases.html#TableRowActionMethod" target="_self" >TableRowActionMethod</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean" target="_blank" >boolean</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="IsTableRowActionTypeMethod"></a> <span class="name"> <span ><b>IsTableRowActionTypeMethod</b></span> <a href="#IsTableRowActionTypeMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>IsTableRowActionTypeMethod(type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code> </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>type</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="IsTableRowActionTypeSwitchMethod"></a> <span class="name"> <span ><b>IsTableRowActionTypeSwitchMethod</b></span> <a href="#IsTableRowActionTypeSwitchMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>IsTableRowActionTypeSwitchMethod(method: <a href="../undefineds/TableRowActionMethod.html" target="_self">TableRowActionMethod</a>)</code> </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>method</td> <td> <code><a href="../miscellaneous/typealiases.html#TableRowActionMethod" target="_self" >TableRowActionMethod</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code><a href="../miscellaneous/typealiases.html#TableRowActionTypeSwitchMethod" target="_self" >TableRowActionTypeSwitchMethod&lt;Data&gt;</a></code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> <h3>src/generators/init/generator.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="initGenerator"></a> <span class="name"> <span ><b>initGenerator</b></span> <a href="#initGenerator"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>initGenerator(tree: Tree, options: InitGeneratorSchema)</code> </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>tree</td> <td> <code>Tree</code> </td> <td> No </td> </tr> <tr> <td>options</td> <td> <code>InitGeneratorSchema</code> </td> <td> No </td> </tr> </tbody> </table> </div> </td> </tr> </tbody> </table> </section> <h3>src/lib/table-row-metadata.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="NormalizeTableRow"></a> <span class="name"> <span ><b>NormalizeTableRow</b></span> <a href="#NormalizeTableRow"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>NormalizeTableRow(row: <a href="../undefineds/RawTableRow.html" target="_self">RawTableRow</a>, rowId: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>)</code> </td> </tr> <tr> <td class="col-md-4"> <div class="io-description"><p>Normalize the table row. Add the __rowId and <strong>metadata</strong> properties to the row.</p> <p>CAUTION: This function mutate the row object</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>row</td> <td> <code><a href="../miscellaneous/typealiases.html#RawTableRow" target="_self" >RawTableRow</a></code> </td> <td> No </td> </tr> <tr> <td>rowId</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>T</code> </div> <div class="io-description"> <p>T the normalized row</p> </div> </td> </tr> </tbody> </table> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="NormalizeTableRow"></a> <span class="name"> <span ><b>NormalizeTableRow</b></span> <a href="#NormalizeTableRow"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>NormalizeTableRow(row: <a href="../undefineds/RawTableRow.html" target="_self">RawTableRow</a>, rowIdMapper: <a href="../undefineds/RowIdMapperFunction.html" target="_self">RowIdMapperFunction</a>)</code> </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>row</td> <td> <code><a href="../miscellaneous/typealiases.html#RawTableRow" target="_self" >RawTableRow</a></code> </td> <td> No </td> </tr> <tr> <td>rowIdMapper</td> <td> <code><a href="../miscellaneous/typealiases.html#RowIdMapperFunction" target="_self" >RowIdMapperFunction</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>T</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="NormalizeTableRow"></a> <span class="name"> <span ><b>NormalizeTableRow</b></span> <a href="#NormalizeTableRow"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>NormalizeTableRow(row: <a href="../undefineds/RawTableRow.html" target="_self">RawTableRow</a>, rowIdOrMapper)</code> </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>row</td> <td> <code><a href="../miscellaneous/typealiases.html#RawTableRow" target="_self" >RawTableRow</a></code> </td> <td> No </td> </tr> <tr> <td>rowIdOrMapper</td> <td> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>T</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> <h3>src/lib/table-row-actions/decorators.ts</h3> <section data-compodoc="block-methods"> <h3></h3> <table class="table table-sm table-bordered"> <tbody> <tr> <td class="col-md-4"> <a name="TableActionMethod"></a> <span class="name"> <span ><b>TableActionMethod</b></span> <a href="#TableActionMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>TableActionMethod(options: <a href="../interfaces/TableActionMethodOptions.html" target="_self">TableActionMethodOptions</a>)</code> </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>options</td> <td> <code><a href="../interfaces/TableActionMethodOptions.html" target="_self" >TableActionMethodOptions</a></code> </td> <td> No </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>ClassDecorator</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="TableActionMethod"></a> <span class="name"> <span ><b>TableActionMethod</b></span> <a href="#TableActionMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>TableActionMethod(type: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank">string</a>, checkFunction?: <a href="../undefineds/RowActionCheckFunction.html" target="_self">RowActionCheckFunction</a>)</code> </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>type</td> <td> <code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string" target="_blank" >string</a></code> </td> <td> No </td> </tr> <tr> <td>checkFunction</td> <td> <code><a href="../miscellaneous/typealiases.html#RowActionCheckFunction" target="_self" >RowActionCheckFunction</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>ClassDecorator</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="TableActionMethod"></a> <span class="name"> <span ><b>TableActionMethod</b></span> <a href="#TableActionMethod"><span class="icon ion-ios-link"></span></a> </span> </td> </tr> <tr> <td class="col-md-4"> <code>TableActionMethod(typeOrOptions, checkFunction?: <a href="../undefineds/RowActionCheckFunction.html" target="_self">RowActionCheckFunction</a>)</code> </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>typeOrOptions</td> <td> </td> <td> No </td> </tr> <tr> <td>checkFunction</td> <td> <code><a href="../miscellaneous/typealiases.html#RowActionCheckFunction" target="_self" >RowActionCheckFunction</a></code> </td> <td> Yes </td> </tr> </tbody> </table> </div> <div class="io-description"> <b>Returns : </b> <code>ClassDecorator</code> </div> <div class="io-description"> </div> </td> </tr> </tbody> </table> </section> </div><div class="search-results"> <div class="has-results">