EntityAttr class
Represents entity attribute.
Extends
Section titled “Extends”MetaEntityAttr
- caption
- captionPlural
- dataAttr
- dataType
- defaultEditor
- defaultOperator
- description
- displayFormat
- entity
- expr
- id
- isEditable
- isForeignKey
- isNullable
- isPrimaryKey
- kind
- lookupAttr
- lookupDataAttr
- lookupEntity
- operators
- params
- showInLookup
- showOnCreate
- showOnEdit
- showOnView
- size
- useInConditions
- useInResult
- useInSorting
- userData
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor. ⊕ new EntityAttr(entity: Entity): EntityAttr
Parameters:
Section titled “Parameters:”- entity: Entity
Public Properties
Section titled “Public Properties”caption
Section titled “caption”The caption.
● caption: string
captionPlural
Section titled “captionPlural”The caption in plural form.
● captionPlural: string
dataAttr
Section titled “dataAttr”● dataAttr: string
dataType
Section titled “dataType”● dataType: DataType
defaultEditor
Section titled “defaultEditor”The default editor.
● defaultEditor: ValueEditor
defaultOperator
Section titled “defaultOperator”The default operator.
● defaultOperator: string
description
Section titled “description”The description.
● description: string
displayFormat
Section titled “displayFormat”The display format for the attribute
● displayFormat?: string
entity
Section titled “entity”The parent
● entity: Entity
The attribute expression.
● expr: string
The id.
● id: string
isEditable
Section titled “isEditable”The value indicating wether the attribute is editable.
● isEditable: boolean
isForeignKey
Section titled “isForeignKey”The value indicating wether the attribute is a primary key.
● isForeignKey: boolean
isNullable
Section titled “isNullable”The value indicating wether the attribute can be null key.
● isNullable: boolean
isPrimaryKey
Section titled “isPrimaryKey”The value indicating wether the attribute is a primary key.
● isPrimaryKey: boolean
The kind.
● kind: EntityAttrKind
lookupAttr
Section titled “lookupAttr”The lookupAttr.
● lookupAttr: string
lookupDataAttr
Section titled “lookupDataAttr”● lookupDataAttr: string
lookupEntity
Section titled “lookupEntity”● lookupEntity: string
operators
Section titled “operators”The list of operators which can be applied for this attribute.
● operators: string[]
params
Section titled “params”The parameters associated with this entity attribute
● params: QueryParam[] = []
showInLookup
Section titled “showInLookup”The value indicating wether the attribute is shown in Lookup Editor.
● showInLookup: boolean
showOnCreate
Section titled “showOnCreate”The value indicating wether the attribute is shown create page.
● showOnCreate: boolean
showOnEdit
Section titled “showOnEdit”The value indicating wether the attribute is shown edit page.
● showOnEdit: boolean
showOnView
Section titled “showOnView”The value indicating wether the attribute is shown on view page.
● showOnView: boolean
● size: number
useInConditions
Section titled “useInConditions”The value indicating whether the attribute can be used in query conditions.
● useInConditions: boolean
useInResult
Section titled “useInResult”The value indicating whether the attribute can be used in result columns (SELECT clause).
● useInResult: boolean
useInSorting
Section titled “useInSorting”The value indicating whether the attribute can be used in sorting.
● useInSorting: boolean
userData
Section titled “userData”User data
● userData?: string
Public Methods
Section titled “Public Methods”loadFromData
Section titled “loadFromData”Loads entity attribute from JSON representation object.
▸ loadFromData(model: DataModel,data: EntityAttrData): void
Parameters:
Section titled “Parameters:”- model: DataModel - The Data Model.
- data: EntityAttrData - The JSON representation object.
Returns void