ColumnBuilder - Documentation

new ColumnBuilder(name, kind)

Source:

index.js, line 593

Parameters:

Name	Type	Description
`name`	string
`kind`	string

Methods

addConstraint(constraint) → {ColumnBuilder}

Source:

index.js, line 611

Parameters:

Name	Type	Description
`constraint`	ConstraintCardinality \| ConstraintDeleteCascade

Returns:

Type: ColumnBuilder

decimalDigits(decimalDigits) → {ColumnBuilder}

Source:

index.js, line 746

Parameters:

Name	Type	Description
`decimalDigits`	number

Returns:

Type: ColumnBuilder

description(…args) → {ColumnBuilder}

Source:

index.js, line 634

Parameters:

Name	Type	Attributes	Description
`args`	Array.<(object\|string)>	<repeatable>	one multi-language object or langtag-value list

Returns:

Type: ColumnBuilder

displayName(…args) → {ColumnBuilder}

Source:

index.js, line 624

Parameters:

Name	Type	Attributes	Description
`args`	Array.<(object\|string)>	<repeatable>	one multi-language object or langtag-value list

Returns:

Type: ColumnBuilder

formatPattern(formatPattern) → {ColumnBuilder}

Source:

index.js, line 833

Parameters:

Name	Type	Description
`formatPattern`	string

Returns:

Type: ColumnBuilder

groups(groups) → {ColumnBuilder}

Source:

index.js, line 799

Parameters:

Name	Type	Description
`groups`	Array.<number>

Returns:

Type: ColumnBuilder

hidden(hiddenopt) → {ColumnBuilder}

Source:

index.js, line 716

Parameters:

Name	Type	Attributes	Default	Description
`hidden`	boolean	<optional>	`true`

Returns:

Type: ColumnBuilder

identifier(identifieropt) → {ColumnBuilder}

Source:

index.js, line 696

Parameters:

Name	Type	Attributes	Default	Description
`identifier`	boolean	<optional>	`true`

Returns:

Type: ColumnBuilder

languageType(languageType, countryCodesopt) → {ColumnBuilder}

Source:

index.js, line 670

Parameters:

Name	Type	Attributes	Description
`languageType`	string
`countryCodes`	Array.<string>	<optional>

Returns:

Type: ColumnBuilder

link(toTable) → {ColumnBuilder}

Source:

index.js, line 775

Parameters:

Name	Type	Description
`toTable`	Table \| number

Returns:

Type: ColumnBuilder

maxLength(maxLength) → {ColumnBuilder}

Source:

index.js, line 726

Parameters:

Name	Type	Description
`maxLength`	number

Returns:

Type: ColumnBuilder

minLength(minLength) → {ColumnBuilder}

Source:

index.js, line 736

Parameters:

Name	Type	Description
`minLength`	number

Returns:

Type: ColumnBuilder

multilanguage(multilanguageopt) → {ColumnBuilder}

Source:

index.js, line 654

Parameters:

Name	Type	Attributes	Default	Description
`multilanguage`	boolean	<optional>	`true`

Returns:

Type: ColumnBuilder

ordering(ordering) → {ColumnBuilder}

Source:

index.js, line 644

Parameters:

Name	Type	Description
`ordering`	number

Returns:

Type: ColumnBuilder

separator(separatoropt) → {ColumnBuilder}

Source:

index.js, line 706

Parameters:

Name	Type	Attributes	Default	Description
`separator`	boolean	<optional>	`true`

Returns:

Type: ColumnBuilder

showMemberColumns(showMemberColumns) → {ColumnBuilder}

Source:

index.js, line 818

Parameters:

Name	Type	Description
`showMemberColumns`	boolean

Returns:

Type: ColumnBuilder

simpleLink(toTable) → {ColumnBuilder}

Source:

index.js, line 765

Parameters:

Name	Type	Description
`toTable`	Table \| number

Returns:

Type: ColumnBuilder

singleDirection() → {ColumnBuilder}

Source:

index.js, line 922

Returns:

Type: ColumnBuilder

toDescription(…args) → {ColumnBuilder}

Source:

index.js, line 884

Parameters:

Name	Type	Attributes	Description
`args`	Array.<(object\|string)>	<repeatable>	one multi-language object or langtag-value list

Returns:

Type: ColumnBuilder

toDisplayName(…args) → {ColumnBuilder}

Source:

index.js, line 864

Parameters:

Name	Type	Attributes	Description
`args`	Array.<(object\|string)>	<repeatable>	one multi-language object or langtag-value list

Returns:

Type: ColumnBuilder

toName(toName) → {ColumnBuilder}

Source:

index.js, line 848

Parameters:

Name	Type	Description
`toName`	string

Returns:

Type: ColumnBuilder

toOrdering(toOrdering) → {ColumnBuilder}

Source:

index.js, line 904

Parameters:

Name	Type	Description
`toOrdering`	number \| null

Returns:

Type: ColumnBuilder