Column class
Represents some column which will be queried
Implements
Section titled “Implements”- expressionChanged
- fireChangedEvent
- getExpressionIndex
- getModel
- getQuery
- isReadOnly
- loadFromData
- saveToData
- setReadOnly
Constructors
Section titled “Constructors”constructor
Section titled “constructor”the default constructor. ⊕ new Column(query: Query): Column
Parameters:
Section titled “Parameters:”- query: Query
Public Properties
Section titled “Public Properties”blockId
Section titled “blockId”The block ID.
● blockId: string
caption
Section titled “caption”The caption.
● caption: string
enabled
Section titled “enabled”Column is enabled
● enabled: boolean = true
The column expression.
● expr: Expression
params
Section titled “params”The parameters associated with this column
● params: QueryParam[] = []
sortIndex
Section titled “sortIndex”The index of the column in the sorting list.
● sortIndex: number
sorting
Section titled “sorting”Column sorting direction
● sorting: SortDirection
Public Accessors
Section titled “Public Accessors”⇄ get id(): string
Returns string
Public Methods
Section titled “Public Methods”expressionChanged
Section titled “expressionChanged”▸ expressionChanged(expr: Expression,oldValue: string): void
Parameters:
Section titled “Parameters:”- expr: Expression
- oldValue:
string
Returns void
fireChangedEvent
Section titled “fireChangedEvent”▸ fireChangedEvent(): void
Returns void
getExpressionIndex
Section titled “getExpressionIndex”▸ getExpressionIndex(expr: Expression): number
Parameters:
Section titled “Parameters:”- expr: Expression
Returns number
getModel
Section titled “getModel”▸ getModel(): DataModel
Returns DataModel
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
isReadOnly
Section titled “isReadOnly”Indicates whether this column is read-only
▸ isReadOnly(): boolean
Returns boolean
loadFromData
Section titled “loadFromData”Loads column from its JSON representation object.
▸ loadFromData(model: DataModel,colData: ColumnData): void
Parameters:
Section titled “Parameters:”- model: DataModel - The Data Model.
- colData: ColumnData - The JSON representation object.
Returns void
saveToData
Section titled “saveToData”Saves the column to a data transfer object (ready for sending to the server-side) .
▸ saveToData(): ColumnData
Returns ColumnData - An plain object that represents the column.
setReadOnly
Section titled “setReadOnly”▸ setReadOnly(value: boolean): void
Parameters:
Section titled “Parameters:”- value:
boolean
Returns void