%PDF- %PDF-
Direktori : /home/ugotscom/bos_naturals/node_modules/vuejs-datatable/docs/classes/ |
Current File : /home/ugotscom/bos_naturals/node_modules/vuejs-datatable/docs/classes/column.html |
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Column | 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="column.html">Column</a> </li> </ul> <h1>Class Column<TRow></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>A class responsible for handling a full column with its header.</p> </div> </div> </section> <section class="tsd-panel tsd-type-parameters"> <h3>Type parameters</h3> <ul class="tsd-type-parameters"> <li> <h4>TRow<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">__type</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Column</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="column.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#align" class="tsd-kind-icon">align</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#class" class="tsd-kind-icon">class</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#component" class="tsd-kind-icon">component</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#field" class="tsd-kind-icon">field</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#filterable" class="tsd-kind-icon">filterable</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#headeralign" class="tsd-kind-icon">header<wbr>Align</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#headerclass" class="tsd-kind-icon">header<wbr>Class</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#headercomponent" class="tsd-kind-icon">header<wbr>Component</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#interpolate" class="tsd-kind-icon">interpolate</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#label" class="tsd-kind-icon">label</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="column.html#representedas" class="tsd-kind-icon">represented<wbr>As</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="column.html#sortable" class="tsd-kind-icon">sortable</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="column.html#getrepresentation" class="tsd-kind-icon">get<wbr>Representation</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="column.html#matches" class="tsd-kind-icon">matches</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="column.html#isfilterable" class="tsd-kind-icon">is<wbr>Filterable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="column.html#isplaintextfield" class="tsd-kind-icon">is<wbr>Plain<wbr>Text<wbr>Field</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="column.html#issortable" class="tsd-kind-icon">is<wbr>Sortable</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="column.html#normalizealignment" class="tsd-kind-icon">normalize<wbr>Alignment</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>Column<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="column.html" class="tsd-signature-type">Column</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/column.ts#L99">classes/column.ts:99</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>props: <a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">></span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="column.html" class="tsd-signature-type">Column</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="align" class="tsd-anchor"></a> <h3>align</h3> <div class="tsd-signature tsd-kind-icon">align<span class="tsd-signature-symbol">:</span> <a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L77">classes/column.ts:77</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The alignment direction of the cells in this column.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="class" class="tsd-anchor"></a> <h3>class</h3> <div class="tsd-signature tsd-kind-icon">class<span class="tsd-signature-symbol">:</span> <a href="../globals.html#tclassval" class="tsd-signature-type">TClassVal</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L75">classes/column.ts:75</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The CSS class or a function returning CSS class(es) for cells of this column.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="component" class="tsd-anchor"></a> <h3>component</h3> <div class="tsd-signature tsd-kind-icon">component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Vue</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L79">classes/column.ts:79</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The component used to represent this cell.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="field" class="tsd-anchor"></a> <h3>field</h3> <div class="tsd-signature tsd-kind-icon">field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">keyof TRow</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Path</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L81">classes/column.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The name of the field in the row object.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="filterable" class="tsd-anchor"></a> <h3>filterable</h3> <div class="tsd-signature tsd-kind-icon">filterable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L99">classes/column.ts:99</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Controls whetever this column can be filtered.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="headeralign" class="tsd-anchor"></a> <h3>header<wbr>Align</h3> <div class="tsd-signature tsd-kind-icon">header<wbr>Align<span class="tsd-signature-symbol">:</span> <a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L88">classes/column.ts:88</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The alignment direction of the header of this column.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="headerclass" class="tsd-anchor"></a> <h3>header<wbr>Class</h3> <div class="tsd-signature tsd-kind-icon">header<wbr>Class<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">""</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/column.ts#L92">classes/column.ts:92</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The base CSS class to apply to the header component.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="headercomponent" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> header<wbr>Component</h3> <div class="tsd-signature tsd-kind-icon">header<wbr>Component<span class="tsd-signature-symbol">:</span> <a href="vuedatatablecell.html#vue" class="tsd-signature-type">Vue</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L90">classes/column.ts:90</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The header cell component of the column.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="interpolate" class="tsd-anchor"></a> <h3>interpolate</h3> <div class="tsd-signature tsd-kind-icon">interpolate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> = false</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L85">classes/column.ts:85</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set to true to convert the return value of <code>props.representedAs</code> to HTML.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="label" class="tsd-anchor"></a> <h3>label</h3> <div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">""</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/column.ts#L94">classes/column.ts:94</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The label displayed in the header.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="representedas" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> represented<wbr>As</h3> <div class="tsd-signature tsd-kind-icon">represented<wbr>As<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L83">classes/column.ts:83</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>A transformation function that returns the string to display</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="sortable" class="tsd-anchor"></a> <h3>sortable</h3> <div class="tsd-signature tsd-kind-icon">sortable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/GerkinDev/vuejs-datatable/blob/125ca58/src/classes/column.ts#L97">classes/column.ts:97</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Controls whetever this column can be sorted.</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="getrepresentation" class="tsd-anchor"></a> <h3>get<wbr>Representation</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Representation<span class="tsd-signature-symbol">(</span>row<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TRow</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/column.ts#L183">classes/column.ts:183</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Converts a row to its string representation for the current column.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>row: <span class="tsd-signature-type">TRow</span></h5> <div class="tsd-comment tsd-typography"> <p>The row to convert</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> <p>the string representation of this row in the current column.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="matches" class="tsd-anchor"></a> <h3>matches</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">matches<span class="tsd-signature-symbol">(</span>row<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">TRow</span>, filterString<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">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/column.ts#L202">classes/column.ts:202</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the provided row's representation matches a certain filter string.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>row: <span class="tsd-signature-type">TRow</span></h5> <div class="tsd-comment tsd-typography"> <p>The row to check.</p> </div> </li> <li> <h5>filterString: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The filter string to test.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p><code>true</code> if the row matches the filter, <code>false</code> otherwise.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="isfilterable" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Filterable</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>Filterable<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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">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/column.ts#L153">classes/column.ts:153</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the column can be filtered.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>props: <a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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 column definition object</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p><code>true</code> if the column can be filtered, <code>false</code> otherwise</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="isplaintextfield" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Plain<wbr>Text<wbr>Field</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>Plain<wbr>Text<wbr>Field<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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">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/column.ts#L143">classes/column.ts:143</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the column use plain text value (eg <code>representedAs</code> or <code>field</code>, but not <code>component</code>) If multiple representation props are provided, it is considered as plain text if there are alternatives to <code>component</code></p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>props: <a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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 column definition object</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p><code>true</code> if the column can be represented by plain text, <code>false</code> otherwise</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="issortable" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Sortable</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">is<wbr>Sortable<span class="tsd-signature-symbol">(</span>props<span class="tsd-signature-symbol">: </span><a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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">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/column.ts#L168">classes/column.ts:168</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Check if the column can be sorted.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>props: <a href="../interfaces/icolumndefinition.html" class="tsd-signature-type">IColumnDefinition</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 column definition object</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> <p><code>true</code> if the column can be sorted, <code>false</code> otherwise</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="normalizealignment" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> normalize<wbr>Alignment</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">normalize<wbr>Alignment<span class="tsd-signature-symbol">(</span>align<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span>, defaultAlign<span class="tsd-signature-symbol">?: </span><a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</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/column.ts#L126">classes/column.ts:126</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Normalize the alignment, using the requested default value.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>align: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5> <div class="tsd-comment tsd-typography"> <p>The raw desired alignment</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> defaultAlign: <a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a><span class="tsd-signature-symbol"> = EColAlign.Left</span></h5> <div class="tsd-comment tsd-typography"> <p>The default alignment to use, if the 1st parameter isn't recognized</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../enums/ecolalign.html" class="tsd-signature-type">EColAlign</a></h4> <p>the normalized alignment</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 tsd-has-type-parameter"> <a href="column.html" class="tsd-kind-icon">Column</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="column.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#align" class="tsd-kind-icon">align</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#class" class="tsd-kind-icon">class</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#component" class="tsd-kind-icon">component</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#field" class="tsd-kind-icon">field</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#filterable" class="tsd-kind-icon">filterable</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#headeralign" class="tsd-kind-icon">header<wbr>Align</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#headerclass" class="tsd-kind-icon">header<wbr>Class</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#headercomponent" class="tsd-kind-icon">header<wbr>Component</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#interpolate" class="tsd-kind-icon">interpolate</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#label" class="tsd-kind-icon">label</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="column.html#representedas" class="tsd-kind-icon">represented<wbr>As</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="column.html#sortable" class="tsd-kind-icon">sortable</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="column.html#getrepresentation" class="tsd-kind-icon">get<wbr>Representation</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="column.html#matches" class="tsd-kind-icon">matches</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="column.html#isfilterable" class="tsd-kind-icon">is<wbr>Filterable</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="column.html#isplaintextfield" class="tsd-kind-icon">is<wbr>Plain<wbr>Text<wbr>Field</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="column.html#issortable" class="tsd-kind-icon">is<wbr>Sortable</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="column.html#normalizealignment" class="tsd-kind-icon">normalize<wbr>Alignment</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>