%PDF-
%PDF-
Mini Shell
Mini Shell
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DatatableFactory | vuejs-datatable</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">vuejs-datatable</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="datatablefactory.html">DatatableFactory</a>
</li>
</ul>
<h1>Class DatatableFactory</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registers Vuejs-Datatable components globally in VueJS.</p>
</div>
<dl class="tsd-comment-tags">
<dt>example</dt>
<dd><p>import { DatatableFactory } from 'vuejs-datatable';
const myDatatableFactory = new DatatableFactory()
.registerTableType( new TableType( 'my-table', {}) )
Vue.use( myDatatableFactory );</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">DatatableFactory</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">PluginObject</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="datatablefactory.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="datatablefactory.html#defaulttabletype" class="tsd-kind-icon">default<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="datatablefactory.html#tabletypes" class="tsd-kind-icon">table<wbr>Types</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="datatablefactory.html#vueinstance" class="tsd-kind-icon">vue<wbr>Instance</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datatablefactory.html#deregistertabletype" class="tsd-kind-icon">deregister<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datatablefactory.html#gettabletype" class="tsd-kind-icon">get<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datatablefactory.html#install" class="tsd-kind-icon">install</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="datatablefactory.html#installtabletype" class="tsd-kind-icon">install<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="datatablefactory.html#registertabletype" class="tsd-kind-icon">register<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="datatablefactory.html#uninstalltabletype" class="tsd-kind-icon">uninstall<wbr>Table<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="datatablefactory.html#usedefaulttype" class="tsd-kind-icon">use<wbr>Default<wbr>Type</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Datatable<wbr>Factory<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="datatablefactory.html" class="tsd-signature-type">DatatableFactory</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L24">classes/datatable-factory.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initialize the default factory</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="datatablefactory.html" class="tsd-signature-type">DatatableFactory</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="defaulttabletype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> default<wbr>Table<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">default<wbr>Table<wbr>Type<span class="tsd-signature-symbol">:</span> <a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = new TableType<any>( DEFAULT_DATATABLE )</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L24">classes/datatable-factory.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The default table type to use if no other configuration was provided.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="tabletypes" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> table<wbr>Types</h3>
<div class="tsd-signature tsd-kind-icon">table<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L22">classes/datatable-factory.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Registry of declared table types.</p>
</div>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-index-signature">
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="vueinstance" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> vue<wbr>Instance</h3>
<div class="tsd-signature tsd-kind-icon">vue<wbr>Instance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">VueConstructor</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Vue</span><span class="tsd-signature-symbol">></span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L20">classes/datatable-factory.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A reference to the Vue instance the plugin is installed in. It may be used to check if the factory was already installed</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="deregistertabletype" class="tsd-anchor"></a>
<h3>deregister<wbr>Table<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">deregister<wbr>Table<wbr>Type<span class="tsd-signature-symbol">(</span>nameOrTableType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L101">classes/datatable-factory.ts:101</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new table type with a specified prefix, that you can customize using a callback.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nameOrTableType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of the component to register, or a <a href="tabletype.html">TableType</a> object.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p><code>this</code> for chaining.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettabletype" class="tsd-anchor"></a>
<h3>get<wbr>Table<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Table<wbr>Type<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L41">classes/datatable-factory.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get a table type by its identifier.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> id: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = DEFAULT_DATATABLE</span></h5>
<div class="tsd-comment tsd-typography">
<p>The identifier of the table type. If not provided, it will default to the default table type.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
<p>the table type registered with that identifier.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="install" class="tsd-anchor"></a>
<h3>install</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">(</span>vue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VueConstructor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L118">classes/datatable-factory.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Declares global components exported by vuejs-datatable, & load configs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>vue: <span class="tsd-signature-type">VueConstructor</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<p>nothing.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="installtabletype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> install<wbr>Table<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">install<wbr>Table<wbr>Type<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L137">classes/datatable-factory.ts:137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Declares a pair of components (a Datatable & a Datatable-Pager) sharing a config.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The base name of the datatable type.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p><code>this</code> for chaining.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="registertabletype" class="tsd-anchor"></a>
<h3>register<wbr>Table<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">register<wbr>Table<wbr>Type<TRow, TSource, TFiltered, TSorted, TPaged><span class="tsd-signature-symbol">(</span>nameOrTableType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TFiltered</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSorted</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TPaged</span><span class="tsd-signature-symbol">></span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L79">classes/datatable-factory.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new table type with a specified prefix, that you can customize using a callback.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>TRow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span></h4>
</li>
<li>
<h4>TSource</h4>
</li>
<li>
<h4>TFiltered</h4>
</li>
<li>
<h4>TSorted</h4>
</li>
<li>
<h4>TPaged</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>nameOrTableType: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="tabletype.html" class="tsd-signature-type">TableType</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSource</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TFiltered</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TSorted</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">TPaged</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>The name of the component to register, or a <a href="tabletype.html">TableType</a> object.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography">
<p>An optional function to execute, that configures the newly created <a href="tabletype.html">TableType</a>. It takes a single parameter: the newly created <a href="tabletype.html">TableType</a>, and should
return the transformed table type.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p><code>this</code> for chaining.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="uninstalltabletype" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> uninstall<wbr>Table<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">uninstall<wbr>Table<wbr>Type<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L158">classes/datatable-factory.ts:158</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Remove a table type definition from vue (the datatable & its associated pager).
This should be used carefully, because Vue won't be able to instanciate new instances of this table type.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>id: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The base name of the datatable type to forget.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p><code>this</code> for chaining.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="usedefaulttype" class="tsd-anchor"></a>
<h3>use<wbr>Default<wbr>Type</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">use<wbr>Default<wbr>Type<span class="tsd-signature-symbol">(</span>use<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
<li class="tsd-signature tsd-kind-icon">use<wbr>Default<wbr>Type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L51">classes/datatable-factory.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Controls the use of the default table type.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>use: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p><code>true</code> to use the default type, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
<p><code>this</code> for chaining.</p>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/datatable-factory.ts#L57">classes/datatable-factory.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Check if the factory uses the default table type.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>a boolean indicating if the factory uses the default table type.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" ">
<a href="../tutorials/index.html">Tutorial index</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="datatablefactory.html" class="tsd-kind-icon">Datatable<wbr>Factory</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="datatablefactory.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="datatablefactory.html#defaulttabletype" class="tsd-kind-icon">default<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="datatablefactory.html#tabletypes" class="tsd-kind-icon">table<wbr>Types</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="datatablefactory.html#vueinstance" class="tsd-kind-icon">vue<wbr>Instance</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="datatablefactory.html#deregistertabletype" class="tsd-kind-icon">deregister<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="datatablefactory.html#gettabletype" class="tsd-kind-icon">get<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="datatablefactory.html#install" class="tsd-kind-icon">install</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="datatablefactory.html#installtabletype" class="tsd-kind-icon">install<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="datatablefactory.html#registertabletype" class="tsd-kind-icon">register<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="datatablefactory.html#uninstalltabletype" class="tsd-kind-icon">uninstall<wbr>Table<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="datatablefactory.html#usedefaulttype" class="tsd-kind-icon">use<wbr>Default<wbr>Type</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>
Zerion Mini Shell 1.0