ColsMeta object

Previous Next

This object contains a collection of columns and can be used the extract the meta data of a column.

When calling $.udb(), you can refer to columns with arrays or simple strings, using the selection techniques below:

 

 

collapseSelecting by column ID
collapseSelecting by name
collapseSelecting by column type

Functions

This object exposes the following functions.

NOTE: All the functions listed in this table are equally exposed by the Cols function object.

Function

Description

.alias()

Function that returns the alias of a column.

.altInputFormats()

Function that returns the alternative input formats of a column.

.defValue()

Function that returns the default value of a column.

.displayLength()

Function that returns the default value of a column.

.domain()

Function that returns the domain name of the column

.getForeignKey()

Function that returns the foreign key information of the lookup column, or undefined if its data source is not a lookup data source

.ioFormat()

Function that returns the IO format of the first item.

.isEmbeddedColumn()

Function that returns true if the first item is of an embedded data source.

.isGroupBy()

Function that returns true if the column is part of a GROUP BY clause, false if not

.isInputAllowed()

Function that returns whether the user may enter input for the first column in the collection

.isKey()

Function that returns true if the column is a key column, false if not

.isMandatory()

Function that returns whether a column is mandatory.

.isPrimaryKey()

Function that returns true if the column is a primary key column (and not part of a relation object), false if not

.isUpdatable()

Function that returns whether a column is updatable.

.label()

Function that returns the label of a column.

.name()

Function that returns the name of a column.

.sortOrder()

Function that returns, sets or removes a sort definition.

.type()

Function that returns the type of the column

.valueList()

Function that returns the allowed values of the column