QueryColumn class

Represents some column which will be queried

Implements

ExpressionParent

Index

Constructors

• constructor

Public Properties

• blockId
• caption
• enabled
• expr
• params
• sortIndex
• sorting

Public Accessors

• id

Public Methods

• expressionChanged
• fireChangedEvent
• getExpressionIndex
• getModel
• getQuery
• isHidden
• isJustSorted
• isReadOnly
• loadFromData
• saveToData
• setHidden
• setReadOnly

Constructors

constructor

the default constructor. ⊕ new QueryColumn(query: Query,justsorted?: boolean): QueryColumn

Parameters:

• query: Query
• justsorted: boolean, Default value = false

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 Accessors

id

⇄ get id(): string

Returns string

Public Methods

expressionChanged

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

Parameters:

• expr: Expression
• oldValue: string

Returns void

fireChangedEvent

▸ fireChangedEvent(): void

Returns void

getExpressionIndex

▸ getExpressionIndex(expr: Expression): number

Parameters:

• expr: Expression

Returns number

getModel

▸ getModel(): DataModel

Returns DataModel

getQuery

▸ getQuery(): Query

Returns Query

isHidden

Indicates whether this column is invisible

▸ isHidden(): boolean

Returns boolean

isJustSorted

Indicates whether this column is just-sorted

▸ isJustSorted(): 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: QueryColumnData): void

Parameters:

• model: DataModel - The Data Model.
• colData: QueryColumnData - The JSON representation object.

Returns void

saveToData

Saves the column to a data transfer object (ready for sending to the server-side) .

▸ saveToData(): QueryColumnData

Returns QueryColumnData - 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