Contains all the information for a MetaData
Classes
Methods
(inner) copyExtraPropertiesTable(dtIn, dtDest)
SYNC
Copies some useful properties form dtIn to dtOut
Parameters:
Name | Type | Description |
---|---|---|
dtIn |
DataTable | |
dtDest |
DataTable |
(inner) describeColumns(table, listType) → {Promise.<DataTable>}
ASYNC
Describes a listing type (captions, column order, formulas, column formats and so on)
Parameters:
Name | Type | Description |
---|---|---|
table |
DataTable | |
listType |
string |
Returns:
- Type
- Promise.<DataTable>
(inner) describeColumnsStructure(table) → {*}
ASYNCH
Sets Captions, DenyNull and Format properties of Columns. They are usually set on backend.
Parameters:
Name | Type | Description |
---|---|---|
table |
DataTable |
Returns:
- Type
- *
(inner) describeColumnsStructure(t, cName, caption, format, pos, maxLen)
SYNC
Set some information (useful on visualization) on column "cName"
Parameters:
Name | Type | Description |
---|---|---|
t |
DataTable | |
cName |
string | |
caption |
string | |
format |
string | |
pos |
Number | |
maxLen |
Number |
(inner) describeTree(table, listType) → {Object}
ASYNC
Describes the table of the tree
Parameters:
Name | Type | Description |
---|---|---|
table |
DataTable | |
listType |
string |
Returns:
- Type
- Object
(inner) doDelete(col, sourceRow, destRow)
SYNC
To override eventually. Copies the value of the column col of the row "source" on the row "dest"
Parameters:
Name | Type | Description |
---|---|---|
col |
DataColumn | |
sourceRow |
ObjectRow | |
destRow |
ObjectRow |
(inner) getName(editType) → {string}
SYNC
Gets metadata name
Parameters:
Name | Type | Description |
---|---|---|
editType |
string |
Returns:
- Type
- string
(inner) getNewRow(dtDest) → {Deferred.<(DataRow|null)>}
ASYNC
Gets new row, having ParentRow as Parent, and adds it on DataTable "dtDest"
Parameters:
Name | Type | Description |
---|---|---|
parentRow. |
DataRow | Parent Row of the new Row to create, or null if no parent is present |
dtDest |
DataTable | Table in which row has to be added |
Returns:
- Type
- Deferred.<(DataRow|null)>
(inner) getSorting(listType) → {string|null}
SYNC
Returns the default sorting for a list type "listType"
Parameters:
Name | Type | Description |
---|---|---|
listType |
string |
Returns:
- Type
- string | null
(inner) getStaticFilter(listType) → {jsDataQuery|null}
ASYNC
Gets the static filter associated to the "listType"
Parameters:
Name | Type | Description |
---|---|---|
listType |
Returns:
- Type
- jsDataQuery | null
(inner) insertFilter() → {jsDataQuery|null}
SYNC
Returns:
- Type
- jsDataQuery | null
(inner) isValid(r) → {Deferred}
ASYNC
Checks if a DataRow "r" has a valid data. Returns an object { warningMsg, errMsg, errField, row }
Parameters:
Name | Type | Description |
---|---|---|
r |
DataRow |
Returns:
can be null or Object
- Type
- Deferred
(inner) primaryKey() → {Array.<string>}
SYNC
Returns the list of primary key fields, this has to be redefined for views.
Returns:
- Type
- Array.<string>
(inner) searchFilter() → {jsDataQuery|null}
SYNC
Returns:
- Type
- jsDataQuery | null
(inner) sortedColumnNameList(table)
ASYNC
Returns the list of real (not temporary or expression) columns NAMES of a table "table"
formatting it like "fieldname1, fieldname2,...."
Parameters:
Name | Type | Description |
---|---|---|
table |
DataTable |