Skip to content

QueryEx class

Query


⊕ new QueryEx(model: DataModel): QueryEx



The attributec class name (Tag).

● attributeExprTag: ExprTag


● clientListRequestHandler: any


Contains user-defined extra data for current query.

● extraData: any


● innerData: any


● isNewbie: boolean


The Data Model associated with this query.

● model: DataModel


● serverListRequestHandler: any


Current timezone offset (it’s sent to the server for proper date/time values processing).

● timezoneOffset: number



● extraConditions: Condition



Add changed callback

▸ addChangedCallback(callback: (event: EqEvent) => void): string

  • callback: (event: EqEvent) => void - The callback ID.

Returns string


Adds a new column with specified parameters

▸ addColumn(descriptor: ColumnDescriptor,author?: string): QueryColumn

  • descriptor: ColumnDescriptor
  • author: string, Optional - The author of this operation. This parameter is used in EasyQuery widgets only to indicate which of the initiates the change.

Returns QueryColumn

query.addColumn({
attributeId: 'Customers.CompanyName',
sortIndex: SortDirection.Ascending
}});

Adds a new column with specified index.

▸ addColumnObj(column: QueryColumn | QueryColumn[],index: any,author: any): void

  • column: QueryColumn | QueryColumn[] - The column or array of columns
  • index: any - The index of new column
  • author: any - The author.

Returns void

const column = new Column();
column.caption = "Company name";
query.addColumn(column, 1)

Adds a condition group - a group of simple conditions (predicates) linked by AND or OR

▸ addConditionGroup(descriptor: ConditionGroupDescriptor,addChildCondition?: boolean): Condition

  • descriptor: ConditionGroupDescriptor - The descriptor of the new condition group.
  • addChildCondition: boolean, Default value = true

Returns Condition - The new search condition.


▸ addDrillDown(): Query

Returns Query


▸ addExtraConditionGroup(descriptor: ConditionGroupDescriptor,addChildCondition?: boolean): Condition

Returns Condition


Add process callback

▸ addProcessCallback(callback: (event: EqEvent) => void): string

  • callback: (event: EqEvent) => void - The callback.

Returns string


Adds a new simple condition (a predicate)

▸ addSimpleCondition(descriptor: SimpleConditionDescriptor): Condition

Returns Condition - The new condition.


▸ addSimpleExtraCondition(descriptor: SimpleConditionDescriptor): Condition

Returns Condition


Changes column to Aggregate function, custom expression or simple column.

▸ changeColumnType(column: QueryColumn,tag: ExprTag,args?: any): void

  • column: QueryColumn - The column to change.
  • tag: ExprTag - New column expression tag.
  • args: any, Optional - The arguments (Contains aggregate function id)

Returns void


Clears the query (all conditions, columns, extraData, etc).

▸ clear(): void

Returns void


Clears all columns in query

▸ clearColumns(): void

Returns void


Clears all conditions in query.

▸ clearConditions(): void

Returns void


Clears all drill downs

▸ clearDrillDowns(): void

Returns void


Clears all extra conditions in query

▸ clearExtraConditions(): void

Returns void


▸ createColumn(justsorted?: boolean): QueryColumn

  • justsorted: boolean, Default value = false

Returns QueryColumn


▸ createCondition(tag?: CondTag): Condition

  • tag: CondTag, Default value = CondTag.Simple

Returns Condition


▸ findColumnById(colId: string): QueryColumn | null

  • colId: string

Returns QueryColumn | null


Fires a QueryChanged event.

▸ fireChangedEvent(params?: QueryChangeEventParams): any

Returns any

▸ fireChangedEvent(params?: QueryChangeEventParams,postpone?: number,wasModified?: boolean): any

Returns any


▸ fireColumnsChangedEvent(action?: QueryChangeAction,column?: QueryColumn | QueryColumn[],justsorted?: boolean): void

Returns void


▸ fireConditionsChangedEvent(action?: QueryChangeAction,condition?: Condition | Condition[]): void

Returns void


Fires process event.

▸ fireProcessEvent(data: any): void

  • data: any - The data.

Returns void


▸ getAggregatedColumns(): QueryColumn[]

Returns QueryColumn[]


▸ getColumnById(id: string): QueryColumn

  • id: string

Returns QueryColumn


Gets Colummn sorting index.

▸ getColumnSortIndex(col: QueryColumn): number

Returns number


Get array of columns.

▸ getColumns(): QueryColumn[]

Returns QueryColumn[]


Retruns conditions text

▸ getConditionsText(): string

Returns string


Retruns conditions text

▸ getConditionsTextAsHtml(): string

Returns string


Gets description of the query.

▸ getDescription(): string

Returns string


▸ getDrillDowns(): Array<Query>

Returns Array<Query>


Gets query ID.

▸ getId(): string

Returns string - The ID>


Get array of columns used only in sorting.

▸ getJustSortedColumns(): QueryColumn[]

Returns QueryColumn[]


Gets DataModel object associated with this query.

▸ getModel(): DataModel

Returns DataModel


Gets name of the query.

▸ getName(): string

Returns string


Gets one value for the attribute

▸ getOneValueForAttr(attrId: string): string

  • attrId: string - The attribute ID.

Returns string


▸ getParentQuery(): Query | null

Returns Query | null


Gets root predicate

▸ getRootCondition(): Condition

Returns Condition


Gets array of columns used in sorting

▸ getSortedColumns(): QueryColumn[]

Returns QueryColumn[]


Gets array of columns that are used as keys for totals.

▸ getUsedInTotalsColumns(): QueryColumn[]

Returns QueryColumn[]


▸ hasEnabledAggrColumns(): boolean

Returns boolean


Checks wether query does not contains any column and any condition.

▸ isEmpty(): boolean

Returns boolean


Checks wether query does not contains any column.

▸ isEmptyColumns(): boolean

Returns boolean


Checks wether query does not contains any condtion.

▸ isEmptyConditions(): boolean

Returns boolean


▸ isEx(): boolean

Returns boolean


▸ isModified(): boolean

Returns boolean


Loads query from data representation.

▸ loadFromData(data: QueryData,changeStatus?: boolean): void

  • data: QueryData
  • changeStatus: boolean, Optional

Returns void


Sets data to the query.

▸ loadFromDataOrJson(data: QueryData | string,changeStatus?: boolean): void

  • data: QueryData | string - JSON representation object or JSON string
  • changeStatus: boolean, Optional - Indicate whether we should change the “isModified” status (by default == true)

Returns void


Loads query from JSON.

▸ loadFromJson(json: string,changeStatus?: boolean): void

  • json: string - The JSON string.
  • changeStatus: boolean, Optional

Returns void


Loads data model.

▸ loadModelData(model: ModelPlainData | string): void

  • model: ModelPlainData | string - JSON representation object or JSON string.

Returns void


Moves the column with specified index to another position.

▸ moveColumn(index1: number,index2: number): void

  • index1: number - The index of the column that should be moved.
  • index2: number - The index of the position the column should be moved to

Returns void


Regenerates current query ID.

▸ regenerateId(): void

Returns void


Remove changed callback

▸ removeChangedCallback(callbackId: string): void

  • callbackId: string - The callback ID.

Returns void


Removes the column.

▸ removeColumn(column: QueryColumn,author: any): void

  • column: QueryColumn - The column to be removed.
  • author: any - The author

Returns void


Removes several columns passed as array.

▸ removeColumns(columnsToRemove: QueryColumn[],author: any): void

  • columnsToRemove: QueryColumn[] - The list of columns to be removed.
  • author: any - The author.

Returns void


Remove process callback

▸ removeProcessCallback(callbackId: string): void

  • callbackId: string - The callback ID.

Returns void


Resets the query: clears all its conditions and columns, regenerate the ID and sets the default name.

▸ reset(clearQuery?: boolean): void

  • clearQuery: boolean, Optional

Returns void


▸ resetModified(): void

Returns void


Runs through condition with this callback.

▸ runThroughConditions(processCondition: (cond: Condition) => void): void

  • processCondition: (cond: Condition) => void - The function to process condition.

Returns void


▸ setDefaultName(): string

Returns string


Sets description of the query

▸ setDescription(description: string): void

  • description: string - New description.

Returns void


Sets query ID.

▸ setId(id: string): void

  • id: string - New Query ID.

Returns void


Sets DataModel object associated with this query.

▸ setModel(model: DataModel): void

Returns void


Sets name of the query

▸ setName(name: string): void

  • name: string - New name.

Returns void


Returns JSON representation of this query.

▸ toJSON(): string

Returns string


Returns JSON representation of this query.

▸ toJSONData(): QueryData

Returns QueryData


Validates wether the query corresponds to the model.

▸ tryValidate(options?: ValidateQueryOptions): boolean

Returns boolean - true if it is valid, otherwise false


Validates wether the query corresponds to the model.

▸ validate(options?: ValidateQueryOptions): void

Returns void



▸ createSimpleConditionObject(attr: EntityAttr,operator: Operator,inputValues: string | Array<string>): Condition

Returns Condition