NewEqResultGrid class

Extends

Grid

Index

Constructors

Public Properties

Protected Properties

Public Methods

Protected Methods

Constructors


constructor

The default constructor. ⊕ new NewEqResultGrid(slot: HTMLElement): NewEqResultGrid

Parameters:

  • slot: HTMLElement - The html element.

Public Properties


widgetType

● widgetType: string


Protected Properties


context

● context: EqContext


group

● group: WidgetGroup


● menuList: any[] = [ { id: 'Rename', text: i18n.getText('ButtonRename')}, { id: 'Delete', text: i18n.getText('ButtonDelete')}, this.delimiter, { id: 'MoveTop', text: i18n.getText('CmdMoveToFirst') }, { id: 'MoveUp', text: i18n.getText('CmdMoveToPrev') }, { id: 'MoveDown', text: i18n.getText('CmdMoveToNext') }, { id: 'MoveBottom', text: i18n.getText('CmdMoveToLast') } ]


moveColumnActions

● moveColumnActions: string[] = ['MoveTop', 'MoveUp', 'MoveDown', 'MoveBottom']


options

● options: any


slot

The html element.

● slot: HTMLElement


sortColumnActions

● sortColumnActions: string[] = ['None', 'Ascending', 'Descending']


sortList

● sortList: any[] = [ this.delimiter, { id: 'None', text: i18n.getText('CmdNotSorted') }, { id: 'Ascending', text: i18n.getText('CmdAscending') }, { id: 'Descending', text: i18n.getText('CmdDescending') }, ]


Public Methods


addColumn

▸ addColumn(column: Column,index?: number): void

Parameters:

  • column: Column
  • index: number, Optional

Returns void


addNewColumn

▸ addNewColumn(attrId: string,index?: number): Column

Parameters:

  • attrId: string
  • index: number, Optional

Returns Column


belongsToGroup

Returns true if the widget belongs to one of the groups specified in the parameter

▸ belongsToGroup(groups?: WidgetGroup): boolean

Parameters:

Returns boolean


destroy

▸ destroy(): void

Returns void


getContext

Returns current context (the one this widget belongs to)

▸ getContext(): EqContext

Returns EqContext


getQuery

▸ getQuery(): Query

Returns Query


init

Initialize widget.

▸ init(context: EqContext,options?: GridOptions): void

Parameters:

Returns void


onProcessEnd

This function is called on the end of some process this widget participates in. For example, some widgets should be updated on model loading or after the execution of the current query

▸ onProcessEnd(): void

Returns void


onProcessStart

This function is called on the start of some process this widget participates in. For example, some widgets can show a spinner or a progress bar at the beginning of some long process (e.g. model loading).

▸ onProcessStart(): void

Returns void


refresh

Refreshes the widget's content

▸ refresh(): void

Returns void


Protected Methods


applyDisplayFormats

▸ applyDisplayFormats(): void

Returns void


attachQueryObserver

▸ attachQueryObserver(): void

Returns void


checkColumn

▸ checkColumn(col: Column): Column

Parameters:

Returns Column


clear

Clears GRID.

▸ clear(): void

Returns void


createColumnMenu

▸ createColumnMenu(column: Column): PopupMenu

Parameters:

Returns PopupMenu


createEntitiesMenu

▸ createEntitiesMenu(): void

Returns void


createFunctionList

▸ createFunctionList(column: Column): any[]

Parameters:

Returns any[]


destroyCore

▸ destroyCore(): void

Returns void


getColumnAttribute

▸ getColumnAttribute(column: Column): EntityAttr

Parameters:

Returns EntityAttr


getDefaultColumnCaption

▸ getDefaultColumnCaption(column: Column | EntityAttr): string

Parameters:

Returns string


moveColumn

▸ moveColumn(column: Column,direction: string): void

Parameters:

  • column: Column
  • direction: string

Returns void


moveColumnCore

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

Parameters:

  • index1: number
  • index2: number

Returns void


onProcessEndCore

This function is called from onProcessEnd function. It does nothing in the base Widget class but can be overridden in derived classes to implement the functionality specific for a particular widget.

▸ onProcessEndCore(): void

Returns void


onProcessStartCore

This function is called from onProcessStart function. It does nothing in the base Widget class but can be overridden in derived classes to implement the functionality specific for a particular widget.

▸ onProcessStartCore(): void

Returns void


refreshCore

Refresh widget implementation

▸ refreshCore(): void

Returns void


render

Renders widget

▸ render(): void

Returns void


renderAddRowButton

▸ renderAddRowButton(): HTMLElement

Returns HTMLElement


renderColumnHeader

▸ renderColumnHeader(column: Column,index: number): HTMLElement

Parameters:

  • column: Column
  • index: number

Returns HTMLElement


renderPageNavigator

Renders page navidator

▸ renderPageNavigator(): void

Returns void


sortColumn

▸ sortColumn(column: Column,direction: string): void

Parameters:

  • column: Column
  • direction: string

Returns void