UNPKG

jsdataset

Version:

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

1,548 lines 122 kB
{ "project": { "linkNatives": "true", "name": "jsDataSet", "description": "DataSet (like .Net) made available for javascript and more", "version": "1.0.6", "url": "https://github.com/gaelazzo/jsDataSet" }, "files": { "src\\jsDataSet.js": { "name": "src\\jsDataSet.js", "modules": { "DataSet": 1, "DataRow": 1 }, "classes": { "DataColumn": 1, "ObjectRow": 1, "DataRow": 1, "AutoIncrementColumn": 1, "DataTable": 1, "OptimisticLocking": 1, "DataRelation": 1, "DataSet": 1 }, "fors": {}, "namespaces": {} } }, "modules": { "DataSet": { "name": "DataSet", "submodules": { "DataRow": 1 }, "elements": {}, "classes": { "DataColumn": 1, "ObjectRow": 1, "DataRow": 1, "AutoIncrementColumn": 1, "DataTable": 1, "OptimisticLocking": 1, "DataRelation": 1, "DataSet": 1 }, "fors": {}, "namespaces": {}, "tag": "module", "file": "src\\jsDataSet.js", "line": 2597, "description": "Provides shim for Ado.net DataSet class" }, "DataRow": { "name": "DataRow", "submodules": {}, "elements": {}, "classes": { "DataColumn": 1, "ObjectRow": 1, "DataRow": 1, "AutoIncrementColumn": 1, "DataTable": 1 }, "fors": {}, "is_submodule": 1, "namespaces": {}, "module": "DataSet", "namespace": "", "file": "src\\jsDataSet.js", "line": 908, "description": "DataRow shim, provides methods to manage objects as Ado.Net DataRows" } }, "classes": { "DataColumn": { "name": "DataColumn", "shortname": "DataColumn", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "file": "src\\jsDataSet.js", "line": 190, "access": "public", "tagname": "", "params": [ { "name": "columnName", "description": "", "type": "String" }, { "name": "ctype", "description": "type of the column field", "type": "CType" } ], "submodule": "DataRow" }, "ObjectRow": { "name": "ObjectRow", "shortname": "ObjectRow", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "submodule": "DataRow", "namespace": "", "file": "src\\jsDataSet.js", "line": 231, "description": "class type to host data", "access": "public", "tagname": "" }, "DataRow": { "name": "DataRow", "shortname": "DataRow", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "submodule": "DataRow", "namespace": "", "file": "src\\jsDataSet.js", "line": 254, "description": "Provides methods to manage objects as Ado.Net DataRows" }, "AutoIncrementColumn": { "name": "AutoIncrementColumn", "shortname": "AutoIncrementColumn", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "submodule": "DataRow", "namespace": "", "file": "src\\jsDataSet.js", "line": 733, "description": "Describe how to evaluate the value of a column before posting it" }, "DataTable": { "name": "DataTable", "shortname": "DataTable", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "submodule": "DataRow", "namespace": "", "file": "src\\jsDataSet.js", "line": 908, "description": "A DataTable is s collection of ObjectRow and provides information about the structure of logical table" }, "OptimisticLocking": { "name": "OptimisticLocking", "shortname": "OptimisticLocking", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "namespace": "", "file": "src\\jsDataSet.js", "line": 2290, "description": "Manages auto fill of locking purposed fields and evaluates filter for optimistic locking for update\nIn his basic implementation accept a list of fields to fill. Values for filling are taken from\n environment." }, "DataRelation": { "name": "DataRelation", "shortname": "DataRelation", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "namespace": "", "file": "src\\jsDataSet.js", "line": 2363, "description": "creates a DataRelation", "is_constructor": 1, "params": [ { "name": "relationName", "description": "", "type": "String" }, { "name": "parentTableName", "description": "", "type": "String" }, { "name": "parentColsName", "description": "array of string", "type": "String|String[]" }, { "name": "childTableName", "description": "", "type": "String" }, { "name": "childColsName", "description": "optional names of child columns", "type": "String|String[]", "optional": true, "optdefault": "parentColsName" } ], "return": { "description": "", "type": "DataRelation" } }, "DataSet": { "name": "DataSet", "shortname": "DataSet", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "DataSet", "namespace": "", "file": "src\\jsDataSet.js", "line": 2597, "description": "Stores and manages a set of DataTables and DataRelations" } }, "elements": {}, "classitems": [ { "file": "src\\jsDataSet.js", "line": 1, "description": "Created by Gaetano Lazzo on 07/02/2015.\nThanks to lodash, ObjectObserve", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 16, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 22, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 25, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 30, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 34, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 39, "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 44, "itemtype": "property", "name": "CType", "access": "public", "tagname": "", "enum": "CType", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 63, "access": "public", "tagname": "", "enum": "DataRowState", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 76, "description": "Enumerates possible version of a DataRow field: original, current", "access": "public", "tagname": "", "enum": "DataRowVersion", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 198, "description": "name of the column", "itemtype": "property", "name": "name", "type": "String", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 204, "description": "type of the column", "itemtype": "property", "name": "ctype", "type": "CType", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 210, "description": "Skips this column on insert copy", "type": "{boolean}", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 216, "description": "column name for posting to db", "itemtype": "property", "name": "forPosting", "type": "String", "class": "DataColumn" }, { "file": "src\\jsDataSet.js", "line": 242, "description": "Gets the DataRow linked to an ObjectRow", "access": "public", "tagname": "", "itemtype": "method", "name": "getRow", "return": { "description": "", "type": "DataRow" }, "class": "ObjectRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 260, "description": "Creates a DataRow from a generic plain object, and returns the DataRow", "itemtype": "method", "name": "DataRow", "params": [ { "name": "o", "description": "this is the main object managed by the application logic, it is attached to a getRow function", "type": "Object" } ], "return": { "description": "", "type": "DataRow" }, "is_constructor": 1, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 291, "description": "previous values of the DataRow, only previous values of changed fields are stored", "internal": "", "itemtype": "property", "name": "old", "type": "Object", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 298, "description": "fields added to object (after last acceptChanges())", "internal": "", "itemtype": "property", "name": "added", "type": "Object", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 305, "description": "fields removed (with delete o.field) from object (after last acceptChanges())", "internal": "", "itemtype": "property", "name": "removed", "type": "Object", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 315, "description": "State of the DataRow, possible values are added unchanged modified deleted detached", "access": "public", "tagname": "", "itemtype": "property", "name": "state", "type": "DataRowState", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 342, "description": "Get the DataRow attached to an object. This method is attached to the object itself,\n so you can get the DataRow calling o.getRow() where o is the plain object\nThis transforms o into an ObjectRow", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 357, "access": "public", "tagname": "", "itemtype": "property", "name": "current current value of the DataRow is the ObjectRow attached to it", "type": "ObjectRow", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 363, "access": "public", "tagname": "", "itemtype": "property", "name": "table", "type": "DataTable", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 370, "type": "{DataRow}", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 376, "description": "get the value of a field of the object. If dataRowVer is omitted, it's equivalent to o.fieldName", "itemtype": "method", "name": "getValue", "params": [ { "name": "fieldName", "description": "", "type": "String" }, { "name": "dataRowVer", "description": "possible values are 'original', 'current'", "type": "DataRowVersion", "optional": true, "optdefault": "'current'" } ], "return": { "description": "", "type": "Object" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 398, "description": "Gets the original row, before changes was made, undefined if current state is added", "itemtype": "method", "name": "originalRow", "return": { "description": "", "type": "Object" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 431, "description": "Make this row identical to another row (both in state, original and current value)", "params": [ { "name": "r", "description": "", "type": "DataRow" } ], "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 458, "description": "changes current row to make it's current values equal to another one. Deleted rows becomes modified\ncompared to patchTo, this also removes values that are not present in other row", "itemtype": "method", "name": "makeEqualTo", "params": [ { "name": "o", "description": "", "type": "Object" } ], "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 466, "type": "{DataRow}", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 488, "description": "changes current row to make it's current values equal to another one. Deleted rows becomes modified", "itemtype": "method", "name": "patchTo", "params": [ { "name": "o", "description": "", "type": "Object" } ], "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 510, "description": "Get the column name of all modified/added/removed fields", "return": { "description": "", "type": "*" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 518, "description": "Makes changes permanents, discarding old values. state becomes unchanged, detached remains detached", "itemtype": "method", "name": "acceptChanges", "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 535, "description": "Discard changes, restoring the original values of the object. state becomes unchanged,\ndetached remains detached", "itemtype": "method", "name": "rejectChanges", "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 563, "description": "resets all change and sets state to unchanged", "access": "private", "tagname": "", "itemtype": "method", "name": "_reset", "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 577, "description": "Detaches row, loosing all changes made. object is also removed from the underlying DataTable.\nProxy is disposed.", "itemtype": "method", "name": "detach", "return": { "description": "", "type": "Undefined" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 594, "description": "Deletes the row. If it is in added state it becomes detached. Otherwise any changes are lost, and\n only rejectChanges can bring the row into life again", "itemtype": "method", "name": "del", "return": { "description": "", "type": "DataRow" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 616, "description": "Debug - helper function", "itemtype": "method", "name": "toString", "return": { "description": "", "type": "String" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 628, "description": "Gets the parent(s) of this row in the dataSet it is contained, following the relation with the\n specified name", "itemtype": "method", "name": "getParentRows", "params": [ { "name": "relName", "description": "", "type": "String" } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 643, "description": "Gets all parent rows of this one", "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 655, "description": "Gets parents row of this row in a given table", "itemtype": "method", "name": "getParentsInTable", "params": [ { "name": "parentTableName", "description": "", "type": "String" } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 671, "description": "Gets the child(s) of this row in the dataSet it is contained, following the relation with the\n specified name", "itemtype": "method", "name": "getChildRows", "params": [ { "name": "relName", "description": "", "type": "String" } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 686, "description": "Gets all child rows of this one", "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 699, "description": "Gets child rows of this row in a given table", "itemtype": "method", "name": "getChildInTable", "params": [ { "name": "childTableName", "description": "", "type": "String" } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 715, "description": "DataTable that contains this DataRow", "itemtype": "property", "name": "table", "type": "DataTable", "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 721, "description": "Get an object with all key fields of this row", "itemtype": "method", "name": "keySample", "return": { "description": "", "type": "Object" }, "class": "DataRow", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 739, "description": "Create a AutoIncrementColumn", "is_constructor": 1, "params": [ { "name": "columnName", "description": "", "type": "String" }, { "name": "options", "description": "same options as AutoIncrement properties", "type": "Object" } ], "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 746, "description": "name of the column that has to be auto-incremented", "itemtype": "property", "name": "columnName", "type": "String", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 752, "description": "Array of column names of selector fields. The max() is evaluating filtering the values of those fields", "itemtype": "property", "name": "[selector]", "type": "String[]", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 758, "description": "Array of bit mask to use for comparing selector. If present, only corresponding bits will be compared,\n i.e. instead of sel=value it will be compared (sel & mask) = value", "itemtype": "property", "name": "[selectorMask]", "type": "Number[]", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 765, "description": "A field to use as prefix for the evaluated field", "itemtype": "property", "name": "[prefixField]", "type": "String", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 771, "description": "String literal to be appended to the prefix before the evaluated max", "itemtype": "property", "name": "[middleConst]", "type": "String", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 778, "description": "for string id, the len of the evaluated max. It is not the overall size of the evaluated id, because a\n prefix and a middle const might be present\nIf idLen = 0 and there is no prefix, the field is assumed to be a number, otherwise a 0 prefixed string-number", "itemtype": "property", "name": "[idLen=0]", "type": "Number", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 786, "description": "Indicates that numbering does NOT depend on prefix value, I.e. is linear in every section of the calculated field", "itemtype": "property", "name": "[linearField=false]", "type": "Boolean", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 792, "description": "Minimum temporary value for in-memory rows", "itemtype": "property", "name": "[minimum=0]", "type": "Number", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 798, "description": "true if this field is a number", "itemtype": "property", "name": "[isNumber=false]", "type": "Number", "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 819, "description": "Gets a function that filter selector fields eventually masking with selectorMask", "params": [ { "name": "row", "description": "" } ], "return": { "description": "", "type": "SqlFun" }, "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 843, "description": "evaluates the function to filter selector on a specified row and column", "itemtype": "method", "name": "getSelector", "params": [ { "name": "r", "description": "", "type": "ObjectRow" } ], "return": { "description": "", "type": "SqlFun" }, "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 859, "description": "Gets the prefix evaluated for a given row", "itemtype": "method", "name": "getPrefix", "params": [ { "name": "r", "description": "" } ], "return": { "description": "string" }, "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 878, "description": "gets the expression to be used for retrieving the max", "itemtype": "method", "name": "getExpression", "params": [ { "name": "r", "description": "", "type": "ObjectRow" } ], "return": { "description": "", "type": "SqlFun" }, "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 897, "description": "Optional custom function to be called to evaluate the maximum value", "itemtype": "method", "name": "customFunction", "params": [ { "name": "r", "description": "", "type": "ObjectRow" }, { "name": "columnName", "description": "", "type": "String" }, { "name": "conn", "description": "", "type": "JsDataAccess" } ], "return": { "description": "", "type": "Object" }, "class": "AutoIncrementColumn", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 913, "description": "DataSet to which this table belongs", "itemtype": "property", "name": "dataset", "type": "DataSet", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 918, "description": "Creates an empty DataTable", "params": [ { "name": "tableName", "description": "", "type": "String" } ], "is_constructor": 1, "return": { "description": "", "type": "DataTable" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 925, "description": "Name of the table", "itemtype": "property", "name": "name", "type": "String", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 931, "description": "Collection of rows, each one hiddenly surrounded with a DataRow object", "itemtype": "property", "name": "rows", "type": "ObjectRow[]", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 938, "description": "Array of key column names", "access": "private", "tagname": "", "itemtype": "property", "name": "myKey", "type": "String[]", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 945, "description": "Set of properties to be assigned to new rows when they are created", "itemtype": "property", "name": "myDefaults", "type": "Object", "access": "private", "tagname": "", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 952, "description": "Dictionary of DataColumn", "itemtype": "property", "name": "columns", "type": "{{DataColumn}}", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 959, "itemtype": "property", "name": "autoIncrementColumns", "type": "{{AutoIncrementColumn}}", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 965, "description": "A ordering to use for posting of this table", "itemtype": "property", "name": "postingOrder", "type": "string | string[] | function", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 975, "access": "private", "tagname": "", "itemtype": "property", "name": "maxCache", "type": "object", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 981, "description": "Mark the table as optimized / not optimized\nAn optimized table has a cache for all autoincrement field", "itemtype": "method", "name": "setOptimize", "params": [ { "name": "value", "description": "", "type": "Boolean" } ], "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 997, "description": "Check if this table is optimized", "itemtype": "method", "name": "isOptimized", "return": { "description": "", "type": "Boolean" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1006, "description": "Clear evaluated max cache", "itemtype": "method", "name": "clearMaxCache", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1016, "params": [ { "name": "colNames", "description": "", "type": "String[]" } ], "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1033, "description": "Set a value in the max cache", "itemtype": "method", "name": "setMaxExpr", "params": [ { "name": "field", "description": "", "type": "String" }, { "name": "expr", "description": "", "type": "SqlFun" }, { "name": "filter", "description": "", "type": "SqlFun" }, { "name": "num", "description": "", "type": "Int" } ], "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1049, "params": [ { "name": "name", "description": "", "type": "String" }, { "name": "ctype", "description": "", "type": "CType" } ], "return": { "description": "", "type": "DataColumn" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1067, "description": "get/set the minimum temp value for a field, assuming 0 if undefined", "itemtype": "method", "name": "minimumTempValue", "params": [ { "name": "field", "description": "", "type": "String" }, { "name": "value", "description": "", "type": "Number", "optional": true } ], "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1090, "description": "gets the max in cache for a field and updates the cache", "itemtype": "method", "name": "getMaxExpr", "params": [ { "name": "field", "description": "", "type": "String" }, { "name": "expr", "description": "", "type": "SqlFun|string" }, { "name": "filter", "description": "", "type": "SqlFun" } ], "return": { "description": "", "type": "Number" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1108, "description": "Evaluates the max of an expression eventually using a cached value", "itemtype": "method", "name": "cachedMaxSubstring", "params": [ { "name": "field", "description": "", "type": "String" }, { "name": "start", "description": "", "type": "Number" }, { "name": "len", "description": "", "type": "Number" }, { "name": "filter", "description": "", "type": "SqlFun" } ], "return": { "description": "", "type": "Number" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1126, "description": "Evaluates the max of an expression without using any cached value. If len = 0 the expression is managed\n as a number with max(field) otherwise it is performed max(convertToInt(substring(field,start,len)))", "params": [ { "name": "field", "description": "", "type": "String" }, { "name": "start", "description": "", "type": "Number" }, { "name": "len", "description": "", "type": "Number" }, { "name": "filter", "description": "", "type": "SqlFun" } ], "return": { "description": "", "type": "Number" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1161, "description": "Extract a set of rows matching a filter function - skipping deleted rows", "itemtype": "method", "name": "select", "params": [ { "name": "filter", "description": "", "type": "SqlFun", "optional": true } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1202, "description": "Extract a set of rows matching a filter function - including deleted rows", "itemtype": "method", "name": "selectAll", "params": [ { "name": "filter", "description": "", "type": "SqlFun" } ], "return": { "description": "", "type": "ObjectRow[]" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1216, "description": "Get the filter that compares key fields of a given row", "itemtype": "method", "name": "keyFilter", "params": [ { "name": "row", "description": "", "type": "Object" } ], "return": { "description": "", "type": "*|sqlFun" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1229, "description": "Compares the key of two objects", "params": [ { "name": "a", "description": "", "type": "Object" }, { "name": "b", "description": "", "type": "Object" } ], "return": { "description": "", "type": "Boolean" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1241, "description": "Get/Set the primary key in a Jquery fashioned style. If k is given, the key is set, otherwise the existing\n key is returned", "itemtype": "method", "name": "key", "params": [ { "name": "k", "description": "", "type": "String[]", "optional": true } ], "return": { "description": "", "type": "*|string[]" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1271, "description": "Check if a column is key", "params": [ { "name": "k", "description": "", "type": "String" } ], "return": { "description": "", "type": "Boolean" }, "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1282, "description": "Clears the table detaching all rows.", "itemtype": "method", "name": "clear", "class": "DataTable", "module": "DataSet", "submodule": "DataRow" }, { "file": "src\\jsDataSet.js", "line": 1296, "description": "Detaches a row from the table", "itemtype": "method", "name": "detach", "params": [ { "name": "obj", "description": "" } ], "class": "Dat