UNPKG

jsdataset

Version:

DataSet (like .Net) made available for javascript and more

1,644 lines (1,043 loc) 116 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>DataTable - jsDataSet</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title="jsDataSet" width="117" height="52"></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: 1.0.6</em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/AutoIncrementColumn.html">AutoIncrementColumn</a></li> <li><a href="../classes/DataColumn.html">DataColumn</a></li> <li><a href="../classes/DataRelation.html">DataRelation</a></li> <li><a href="../classes/DataRow.html">DataRow</a></li> <li><a href="../classes/DataSet.html">DataSet</a></li> <li><a href="../classes/DataTable.html">DataTable</a></li> <li><a href="../classes/ObjectRow.html">ObjectRow</a></li> <li><a href="../classes/OptimisticLocking.html">OptimisticLocking</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/DataRow.html">DataRow</a></li> <li><a href="../modules/DataSet.html">DataSet</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>DataTable Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/src_jsDataSet.js.html#l908"><code>src\jsDataSet.js:908</code></a> </div> Module: <a href="../modules/DataRow.html">DataRow</a><br> Parent Module: <a href="../modules/DataSet.html">DataSet</a> </div> <div class="box intro"> <p>A DataTable is s collection of ObjectRow and provides information about the structure of logical table</p> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> <li class="api-class-tab properties"><a href="#properties">Properties</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_acceptChanges">acceptChanges</a> </li> <li class="index-item method"> <a href="#method_add">add</a> </li> <li class="index-item method"> <a href="#method_assignField">assignField</a> </li> <li class="index-item method"> <a href="#method_autoIncrement">autoIncrement</a> </li> <li class="index-item method"> <a href="#method_avoidCollisions">avoidCollisions</a> </li> <li class="index-item method private"> <a href="#method_avoidCollisionsOnField">avoidCollisionsOnField</a> </li> <li class="index-item method"> <a href="#method_cachedMaxSubstring">cachedMaxSubstring</a> </li> <li class="index-item method"> <a href="#method_calcTemporaryId">calcTemporaryId</a> </li> <li class="index-item method private"> <a href="#method_cascadeAssignField">cascadeAssignField</a> </li> <li class="index-item method"> <a href="#method_childRelations">childRelations</a> </li> <li class="index-item method"> <a href="#method_clear">clear</a> </li> <li class="index-item method"> <a href="#method_clearDefaults">clearDefaults</a> </li> <li class="index-item method"> <a href="#method_clearMaxCache">clearMaxCache</a> </li> <li class="index-item method"> <a href="#method_clone">clone</a> </li> <li class="index-item method private"> <a href="#method_collisionFilter">collisionFilter</a> </li> <li class="index-item method"> <a href="#method_columnList">columnList</a> </li> <li class="index-item method"> <a href="#method_defaults">defaults</a> </li> <li class="index-item method"> <a href="#method_denyClear">denyClear</a> </li> <li class="index-item method"> <a href="#method_detach">detach</a> </li> <li class="index-item method"> <a href="#method_existingRow">existingRow</a> </li> <li class="index-item method private"> <a href="#method_fieldDependencies">fieldDependencies</a> </li> <li class="index-item method"> <a href="#method_getAutoIncrementColumns">getAutoIncrementColumns</a> </li> <li class="index-item method"> <a href="#method_getChanges">getChanges</a> </li> <li class="index-item method"> <a href="#method_getMaxExpr">getMaxExpr</a> </li> <li class="index-item method"> <a href="#method_hasChanges">hasChanges</a> </li> <li class="index-item method"> <a href="#method_importRow">importRow</a> </li> <li class="index-item method"> <a href="#method_isOptimized">isOptimized</a> </li> <li class="index-item method"> <a href="#method_key">key</a> </li> <li class="index-item method"> <a href="#method_keyFilter">keyFilter</a> </li> <li class="index-item method"> <a href="#method_load">load</a> </li> <li class="index-item method"> <a href="#method_loadArray">loadArray</a> </li> <li class="index-item method"> <a href="#method_makeChild">makeChild</a> </li> <li class="index-item method"> <a href="#method_mergeArray">mergeArray</a> </li> <li class="index-item method"> <a href="#method_mergeAsPatch">mergeAsPatch</a> </li> <li class="index-item method"> <a href="#method_mergeAsPost">mergeAsPost</a> </li> <li class="index-item method"> <a href="#method_mergeAsPut">mergeAsPut</a> </li> <li class="index-item method"> <a href="#method_minimumTempValue">minimumTempValue</a> </li> <li class="index-item method"> <a href="#method_newRow">newRow</a> </li> <li class="index-item method"> <a href="#method_parentRelations">parentRelations</a> </li> <li class="index-item method public"> <a href="#method_postingTable">postingTable</a> </li> <li class="index-item method"> <a href="#method_realTable">realTable</a> </li> <li class="index-item method"> <a href="#method_rejectChanges">rejectChanges</a> </li> <li class="index-item method"> <a href="#method_safeAssign">safeAssign</a> </li> <li class="index-item method"> <a href="#method_select">select</a> </li> <li class="index-item method"> <a href="#method_selectAll">selectAll</a> </li> <li class="index-item method"> <a href="#method_setMaxExpr">setMaxExpr</a> </li> <li class="index-item method"> <a href="#method_setOptimize">setOptimize</a> </li> <li class="index-item method"> <a href="#method_"></a> </li> <li class="index-item method"> <a href="#method_skipInsertCopy">skipInsertCopy</a> </li> <li class="index-item method"> <a href="#method_skipSecurity">skipSecurity</a> </li> <li class="index-item method"> <a href="#method_staticFilter">staticFilter</a> </li> <li class="index-item method"> <a href="#method_tableForReading">tableForReading</a> </li> <li class="index-item method"> <a href="#method_tableForWriting">tableForWriting</a> </li> <li class="index-item method"> <a href="#method_toString">toString</a> </li> <li class="index-item method"> <a href="#method_updateDependencies">updateDependencies</a> </li> <li class="index-item method"> <a href="#method_viewTable">viewTable</a> </li> </ul> </div> <div class="index-section properties"> <h3>Properties</h3> <ul class="index-list properties"> <li class="index-item property"> <a href="#property_autoIncrementColumns">autoIncrementColumns</a> </li> <li class="index-item property"> <a href="#property_columns">columns</a> </li> <li class="index-item property"> <a href="#property_dataset">dataset</a> </li> <li class="index-item property private"> <a href="#property_maxCache">maxCache</a> </li> <li class="index-item property private"> <a href="#property_myDefaults">myDefaults</a> </li> <li class="index-item property private"> <a href="#property_myKey">myKey</a> </li> <li class="index-item property"> <a href="#property_name">name</a> </li> <li class="index-item property"> <a href="#property_postingOrder">postingOrder</a> </li> <li class="index-item property"> <a href="#property_rows">rows</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_acceptChanges" class="method item"> <h3 class="name"><code>acceptChanges</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1390"><code>src\jsDataSet.js:1390</code></a> </p> </div> <div class="description"> <p>Accept any changes setting all dataRows in the state of 'unchanged'. Deleted rows become detached and are removed from the table</p> </div> </div> <div id="method_add" class="method item"> <h3 class="name"><code>add</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>obj</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1316"><code>src\jsDataSet.js:1316</code></a> </p> </div> <div class="description"> <p>Adds an object to the table setting the datarow in the state of &quot;added&quot;</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">obj</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> <p>plain object</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <p>DataRow created</p> </div> </div> </div> <div id="method_assignField" class="method item"> <h3 class="name"><code>assignField</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>r</code> </li> <li class="arg"> <code>field</code> </li> <li class="arg"> <code>value</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2079"><code>src\jsDataSet.js:2079</code></a> </p> </div> <div class="description"> <p>Assign a value to a field and update all dependencies</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">r</code> <span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">field</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">value</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_autoIncrement" class="method item"> <h3 class="name"><code>autoIncrement</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>fieldName</code> </li> <li class="arg"> <code class="optional">[autoIncrementInfo]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"> | <a href="../classes/AutoIncrementColumn.html" class="crosslink">AutoIncrementColumn</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1776"><code>src\jsDataSet.js:1776</code></a> </p> </div> <div class="description"> <p>Get/Set autoincrement properties of fields</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">fieldName</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name optional">[autoIncrementInfo]</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>//see AutoIncrementColumn properties for details</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"> | <a href="../classes/AutoIncrementColumn.html" class="crosslink">AutoIncrementColumn</a></span>: </div> </div> </div> <div id="method_avoidCollisions" class="method item"> <h3 class="name"><code>avoidCollisions</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>r</code> </li> <li class="arg"> <code>field</code> </li> <li class="arg"> <code>value</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2043"><code>src\jsDataSet.js:2043</code></a> </p> </div> <div class="description"> <p>check if changing a key field of a row it would collide with come autoincrement field. If it would, recalculates colliding rows/filter in accordance</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">r</code> <span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">field</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">value</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_avoidCollisionsOnField" class="method item private"> <h3 class="name"><code>avoidCollisionsOnField</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>field</code> </li> <li class="arg"> <code>filter</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2065"><code>src\jsDataSet.js:2065</code></a> </p> </div> <div class="description"> <p>Recalculate a field to avoid collisions on some rows identified by a filter</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">field</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">filter</code> <span class="type">SqlFun</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_cachedMaxSubstring" class="method item"> <h3 class="name"><code>cachedMaxSubstring</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>field</code> </li> <li class="arg"> <code>start</code> </li> <li class="arg"> <code>len</code> </li> <li class="arg"> <code>filter</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1108"><code>src\jsDataSet.js:1108</code></a> </p> </div> <div class="description"> <p>Evaluates the max of an expression eventually using a cached value</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">field</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">start</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">len</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">filter</code> <span class="type">SqlFun</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number" class="crosslink external" target="_blank">Number</a></span>: </div> </div> </div> <div id="method_calcTemporaryId" class="method item"> <h3 class="name"><code>calcTemporaryId</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>r</code> </li> <li class="arg"> <code class="optional">[field]</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2155"><code>src\jsDataSet.js:2155</code></a> </p> </div> <div class="description"> <p>Augment r[field] in order to avoid collision with another row that needs to take that value if field is not specified, this is applied to all autoincrement field of the table Precondition: r[[field] should be an autoincrement field</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">r</code> <span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name optional">[field]</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_cascadeAssignField" class="method item private"> <h3 class="name"><code>cascadeAssignField</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>r</code> </li> <li class="arg"> <code>parentField</code> </li> <li class="arg"> <code>value</code> </li> </ul><span class="paren">)</span> </div> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2092"><code>src\jsDataSet.js:2092</code></a> </p> </div> <div class="description"> <p>assign a value to a field in a row and all descending child rows</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">r</code> <span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">parentField</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">value</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_childRelations" class="method item"> <h3 class="name"><code>childRelations</code></h3> <span class="paren">()</span> <span class="returns-inline"> <span class="type"></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1939"><code>src\jsDataSet.js:1939</code></a> </p> </div> <div class="description"> <p>Get all relation where THIS table is the parent and another table is the child</p> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <p>DataRelation[]</p> </div> </div> </div> <div id="method_clear" class="method item"> <h3 class="name"><code>clear</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1282"><code>src\jsDataSet.js:1282</code></a> </p> </div> <div class="description"> <p>Clears the table detaching all rows.</p> </div> </div> <div id="method_clearDefaults" class="method item"> <h3 class="name"><code>clearDefaults</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1514"><code>src\jsDataSet.js:1514</code></a> </p> </div> <div class="description"> <p>Clears any stored default value for the table</p> </div> </div> <div id="method_clearMaxCache" class="method item"> <h3 class="name"><code>clearMaxCache</code></h3> <span class="paren">()</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1006"><code>src\jsDataSet.js:1006</code></a> </p> </div> <div class="description"> <p>Clear evaluated max cache</p> </div> </div> <div id="method_clone" class="method item"> <h3 class="name"><code>clone</code></h3> <span class="paren">()</span> <span class="returns-inline"> <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1973"><code>src\jsDataSet.js:1973</code></a> </p> </div> <div class="description"> <p>clones table structure without copying any DataRow</p> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="../classes/DataTable.html" class="crosslink">DataTable</a></span>: </div> </div> </div> <div id="method_collisionFilter" class="method item private"> <h3 class="name"><code>collisionFilter</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>r</code> </li> <li class="arg"> <code>field</code> </li> <li class="arg"> <code>value</code> </li> <li class="arg"> <code>autoInfo</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type">SqlFun</span> </span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2009"><code>src\jsDataSet.js:2009</code></a> </p> </div> <div class="description"> <p>Gets a filter of colliding rows supposing to change r[field]= value, on a specified column</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">r</code> <span class="type"><a href="../classes/ObjectRow.html" class="crosslink">ObjectRow</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">field</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">value</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">autoInfo</code> <span class="type"><a href="../classes/AutoIncrementColumn.html" class="crosslink">AutoIncrementColumn</a></span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type">SqlFun</span>: </div> </div> </div> <div id="method_columnList" class="method item"> <h3 class="name"><code>columnList</code></h3> <span class="paren">()</span> <span class="returns-inline"> <span class="type"></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1749"><code>src\jsDataSet.js:1749</code></a> </p> </div> <div class="description"> <p>get the list of columns or * if there is no column set</p> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <p>string</p> </div> </div> </div> <div id="method_defaults" class="method item"> <h3 class="name"><code>defaults</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code class="optional">[def]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | </span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1499"><code>src\jsDataSet.js:1499</code></a> </p> </div> <div class="description"> <p>Get/set the object defaults in a JQuery fashioned style. When def is present, its fields and values are merged into existent defaults.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name optional">[def]</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | </span>: </div> </div> </div> <div id="method_denyClear" class="method item"> <h3 class="name"><code>denyClear</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code class="optional">[arg]</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1599"><code>src\jsDataSet.js:1599</code></a> </p> </div> <div class="description"> <p>Get/Set DenyClear. === y avoid to clear table on backend reads</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name optional">[arg]</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: </div> </div> </div> <div id="method_detach" class="method item"> <h3 class="name"><code>detach</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>obj</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1296"><code>src\jsDataSet.js:1296</code></a> </p> </div> <div class="description"> <p>Detaches a row from the table</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">obj</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> </div> <div id="method_existingRow" class="method item"> <h3 class="name"><code>existingRow</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>obj</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="../classes/DataRow.html" class="crosslink">DataRow</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" class="crosslink external" target="_blank">undefined</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l1330"><code>src\jsDataSet.js:1330</code></a> </p> </div> <div class="description"> <p>check if a row is present in the table. If there is a key, it is used for finding the row, otherwise a ==== comparison is made</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">obj</code> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span> <div class="param-description"> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="../classes/DataRow.html" class="crosslink">DataRow</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined" class="crosslink external" target="_blank">undefined</a></span>: </div> </div> </div> <div id="method_fieldDependencies" class="method item private"> <h3 class="name"><code>fieldDependencies</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>field</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String[]</a></span> </span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/src_jsDataSet.js.html#l2117"><code>src\jsDataSet.js:2117</code>