Column class

Represents some column which will be queried

Implements

ExpressionParent

Index

Constructors

Public Properties

Public Methods

Constructors


constructor

the default constructor. ⊕ new Column(query: Query): Column

Parameters:


Public Properties


blockId

The block ID.

● blockId: string


caption

The caption.

● caption: string


enabled

Column is enabled

● enabled: boolean = true


expr

The column expression.

● expr: Expression


params

The parameters associated with this column

● params: QueryParam[] = []


sortIndex

The index of the column in the sorting list.

● sortIndex: number


sorting

Column sorting direction

● sorting: SortDirection


Public Methods


expressionChanged

▸ expressionChanged(expr: Expression,oldValue: string): void

Parameters:

Returns void


fireChangedEvent

▸ fireChangedEvent(): void

Returns void


getExpressionIndex

▸ getExpressionIndex(expr: Expression): number

Parameters:

Returns number


getModel

▸ getModel(): DataModel

Returns DataModel


getQuery

▸ getQuery(): Query

Returns Query


isHidden

Indicates whether this column is invisible

▸ isHidden(): boolean

Returns boolean


isReadOnly

Indicates whether this column is read-only

▸ isReadOnly(): boolean

Returns boolean


loadFromData

Loads column from its JSON representation object.

▸ loadFromData(model: DataModel,colData: ColumnData): void

Parameters:

Returns void


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.


setHidden

▸ setHidden(value: boolean): void

Parameters:

  • value: boolean

Returns void


setReadOnly

▸ setReadOnly(value: boolean): void

Parameters:

  • value: boolean

Returns void