EqHtmlGrid class

The widget responsed for rendering html grid.

Extends

HtmlContentWidget

Index

Constructors

Public Properties

Protected Properties

Public Methods

Protected Methods

Constructors


constructor

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

Parameters:

  • slot: HTMLElement - The html element.

Public Properties


widgetType

● widgetType: string


Protected Properties


contentElement

The html element

● contentElement: HTMLElement


context

● context: EqContext


group

● group: WidgetGroup


maxButtonCount

Max count of buttons.

● maxButtonCount?: number


pageItemCssClass

pageTtem css class

● pageItemCssClass: string


slot

● slot: HTMLElement


Public Methods


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


init

Initialize widget.

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

Parameters:

  • context: EqContext - The context.
  • options: any, Optional - The options.

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


clear

Clears content.

▸ clear(): void

Returns void


destroyCore

▸ destroyCore(): void

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


renderPageNavigator

Renders page navigator.

▸ renderPageNavigator(): void

Returns void