jsdataset
Version:
DataSet (like .Net) made available for javascript and more
725 lines (465 loc) • 21.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>AutoIncrementColumn - 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>AutoIncrementColumn Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/src_jsDataSet.js.html#l733"><code>src\jsDataSet.js:733</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>Describe how to evaluate the value of a column before posting it</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_customFunction">customFunction</a>
</li>
<li class="index-item method">
<a href="#method_getExpression">getExpression</a>
</li>
<li class="index-item method">
<a href="#method_getPrefix">getPrefix</a>
</li>
<li class="index-item method">
<a href="#method_getSelector">getSelector</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_[idLen=0]">[idLen=0]</a>
</li>
<li class="index-item property">
<a href="#property_[isNumber=false]">[isNumber=false]</a>
</li>
<li class="index-item property">
<a href="#property_[linearField=false]">[linearField=false]</a>
</li>
<li class="index-item property">
<a href="#property_[middleConst]">[middleConst]</a>
</li>
<li class="index-item property">
<a href="#property_[minimum=0]">[minimum=0]</a>
</li>
<li class="index-item property">
<a href="#property_[prefixField]">[prefixField]</a>
</li>
<li class="index-item property">
<a href="#property_[selector]">[selector]</a>
</li>
<li class="index-item property">
<a href="#property_[selectorMask]">[selectorMask]</a>
</li>
<li class="index-item property">
<a href="#property_columnName">columnName</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_customFunction" class="method item">
<h3 class="name"><code>customFunction</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>columnName</code>
</li>
<li class="arg">
<code>conn</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#l897"><code>src\jsDataSet.js:897</code></a>
</p>
</div>
<div class="description">
<p>Optional custom function to be called to evaluate the maximum value</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">columnName</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">conn</code>
<span class="type">JsDataAccess</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_getExpression" class="method item">
<h3 class="name"><code>getExpression</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>r</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">SqlFun</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l878"><code>src\jsDataSet.js:878</code></a>
</p>
</div>
<div class="description">
<p>gets the expression to be used for retrieving the max</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>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">SqlFun</span>:
</div>
</div>
</div>
<div id="method_getPrefix" class="method item">
<h3 class="name"><code>getPrefix</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>r</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#l859"><code>src\jsDataSet.js:859</code></a>
</p>
</div>
<div class="description">
<p>Gets the prefix evaluated for a given row</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="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">
<p>string</p>
</div>
</div>
</div>
<div id="method_getSelector" class="method item">
<h3 class="name"><code>getSelector</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>r</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">SqlFun</span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l843"><code>src\jsDataSet.js:843</code></a>
</p>
</div>
<div class="description">
<p>evaluates the function to filter selector on a specified row and 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>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type">SqlFun</span>:
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property_[idLen=0]" class="property item">
<h3 class="name"><code>[idLen=0]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l778"><code>src\jsDataSet.js:778</code></a>
</p>
</div>
<div class="description">
<p>for string id, the len of the evaluated max. It is not the overall size of the evaluated id, because a
prefix and a middle const might be present
If idLen = 0 and there is no prefix, the field is assumed to be a number, otherwise a 0 prefixed string-number</p>
</div>
</div>
<div id="property_[isNumber=false]" class="property item">
<h3 class="name"><code>[isNumber=false]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l798"><code>src\jsDataSet.js:798</code></a>
</p>
</div>
<div class="description">
<p>true if this field is a number</p>
</div>
</div>
<div id="property_[linearField=false]" class="property item">
<h3 class="name"><code>[linearField=false]</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l786"><code>src\jsDataSet.js:786</code></a>
</p>
</div>
<div class="description">
<p>Indicates that numbering does NOT depend on prefix value, I.e. is linear in every section of the calculated field</p>
</div>
</div>
<div id="property_[middleConst]" class="property item">
<h3 class="name"><code>[middleConst]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l771"><code>src\jsDataSet.js:771</code></a>
</p>
</div>
<div class="description">
<p>String literal to be appended to the prefix before the evaluated max</p>
</div>
</div>
<div id="property_[minimum=0]" class="property item">
<h3 class="name"><code>[minimum=0]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l792"><code>src\jsDataSet.js:792</code></a>
</p>
</div>
<div class="description">
<p>Minimum temporary value for in-memory rows</p>
</div>
</div>
<div id="property_[prefixField]" class="property item">
<h3 class="name"><code>[prefixField]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l765"><code>src\jsDataSet.js:765</code></a>
</p>
</div>
<div class="description">
<p>A field to use as prefix for the evaluated field</p>
</div>
</div>
<div id="property_[selector]" class="property item">
<h3 class="name"><code>[selector]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l752"><code>src\jsDataSet.js:752</code></a>
</p>
</div>
<div class="description">
<p>Array of column names of selector fields. The max() is evaluating filtering the values of those fields</p>
</div>
</div>
<div id="property_[selectorMask]" class="property item">
<h3 class="name"><code>[selectorMask]</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l758"><code>src\jsDataSet.js:758</code></a>
</p>
</div>
<div class="description">
<p>Array of bit mask to use for comparing selector. If present, only corresponding bits will be compared,
i.e. instead of sel=value it will be compared (sel & mask) = value</p>
</div>
</div>
<div id="property_columnName" class="property item">
<h3 class="name"><code>columnName</code></h3>
<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="meta">
<p>
Defined in
<a href="../files/src_jsDataSet.js.html#l746"><code>src\jsDataSet.js:746</code></a>
</p>
</div>
<div class="description">
<p>name of the column that has to be auto-incremented</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>