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