NewEqResultGrid class
Extends
Section titled “Extends”- addColumn
- addNewColumn
- belongsToGroup
- destroy
- getContext
- getQuery
- init
- onProcessEnd
- onProcessStart
- refresh
- applyDisplayFormats
- attachQueryObserver
- checkColumn
- clear
- createColumnMenu
- createEntitiesMenu
- createFunctionList
- destroyCore
- getColumnAttribute
- getDefaultColumnCaption
- moveColumn
- moveColumnCore
- onProcessEndCore
- onProcessStartCore
- refreshCore
- render
- renderAddRowButton
- renderColumnHeader
- renderPageNavigator
- sortColumn
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor.
⊕ new NewEqResultGrid(slot: HTMLElement): NewEqResultGrid
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The html element.
Public Properties
Section titled “Public Properties”widgetType
Section titled “widgetType”● widgetType: string
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● group: WidgetGroup
menuList
Section titled “menuList”● 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
Section titled “moveColumnActions”● moveColumnActions: string[] = ['MoveTop', 'MoveUp', 'MoveDown', 'MoveBottom']
options
Section titled “options”● options: any
The html element.
● slot: HTMLElement
sortColumnActions
Section titled “sortColumnActions”● sortColumnActions: string[] = ['None', 'Ascending', 'Descending']
sortList
Section titled “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
Section titled “Public Methods”addColumn
Section titled “addColumn”▸ addColumn(column: Column,index?: number): void
Parameters:
Section titled “Parameters:”- column: Column
- index:
number, Optional
Returns void
addNewColumn
Section titled “addNewColumn”▸ addNewColumn(attrId: string,index?: number): Column
Parameters:
Section titled “Parameters:”- attrId:
string - index:
number, Optional
Returns Column
belongsToGroup
Section titled “belongsToGroup”Returns true if the widget belongs to one of the groups specified in the parameter
▸ belongsToGroup(groups?: WidgetGroup): boolean
Parameters:
Section titled “Parameters:”- groups: WidgetGroup, Optional -
Returns boolean
destroy
Section titled “destroy”▸ destroy(): void
Returns void
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
Initialize widget.
▸ init(context: EqContext,options?: GridOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options: GridOptions, Optional - The options.
Returns void
onProcessEnd
Section titled “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
Section titled “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
Section titled “refresh”Refreshes the widget’s content
▸ refresh(): void
Returns void
Protected Methods
Section titled “Protected Methods”applyDisplayFormats
Section titled “applyDisplayFormats”▸ applyDisplayFormats(): void
Returns void
attachQueryObserver
Section titled “attachQueryObserver”▸ attachQueryObserver(): void
Returns void
checkColumn
Section titled “checkColumn”▸ checkColumn(col: Column): Column
Parameters:
Section titled “Parameters:”- col: Column
Returns Column
Clears GRID.
▸ clear(): void
Returns void
createColumnMenu
Section titled “createColumnMenu”▸ createColumnMenu(column: Column): PopupMenu
Parameters:
Section titled “Parameters:”- column: Column
Returns PopupMenu
createEntitiesMenu
Section titled “createEntitiesMenu”▸ createEntitiesMenu(): void
Returns void
createFunctionList
Section titled “createFunctionList”▸ createFunctionList(column: Column): any[]
Parameters:
Section titled “Parameters:”- column: Column
Returns any[]
destroyCore
Section titled “destroyCore”▸ destroyCore(): void
Returns void
getColumnAttribute
Section titled “getColumnAttribute”▸ getColumnAttribute(column: Column): EntityAttr
Parameters:
Section titled “Parameters:”- column: Column
Returns EntityAttr
getDefaultColumnCaption
Section titled “getDefaultColumnCaption”▸ getDefaultColumnCaption(column: Column | EntityAttr): string
Parameters:
Section titled “Parameters:”- column: Column | EntityAttr
Returns string
moveColumn
Section titled “moveColumn”▸ moveColumn(column: Column,direction: string): void
Parameters:
Section titled “Parameters:”- column: Column
- direction:
string
Returns void
moveColumnCore
Section titled “moveColumnCore”▸ moveColumnCore(index1: number,index2: number): void
Parameters:
Section titled “Parameters:”- index1:
number - index2:
number
Returns void
onProcessEndCore
Section titled “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
Section titled “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
Section titled “refreshCore”Refresh widget implementation
▸ refreshCore(): void
Returns void
render
Section titled “render”Renders widget
▸ render(): void
Returns void
renderAddRowButton
Section titled “renderAddRowButton”▸ renderAddRowButton(): HTMLElement
Returns HTMLElement
renderColumnHeader
Section titled “renderColumnHeader”▸ renderColumnHeader(column: Column,index: number): HTMLElement
Parameters:
Section titled “Parameters:”- column: Column
- index:
number
Returns HTMLElement
renderPageNavigator
Section titled “renderPageNavigator”Renders page navidator
▸ renderPageNavigator(): void
Returns void
sortColumn
Section titled “sortColumn”▸ sortColumn(column: Column,direction: string): void
Parameters:
Section titled “Parameters:”- column: Column
- direction:
string
Returns void