ColumnsBar class

Extends

Widget

Index

Constructors

• constructor

Public Properties

• id
• moveMenu
• sortMenu

Protected Properties

• context
• group
• slot

Protected Accessors

• cssPrefix

Public Methods

• addColumn
• addNewColumn
• areCustomExpressionsAllowed
• belongsToGroup
• destroy
• getColumnsBlock
• getContext
• getQuery
• getWidgetType
• hideLandingSlot
• init
• moveColumn
• onProcessEnd
• onProcessStart
• refresh
• showEntitiesMenu
• showLandingSlot
• toggleColumnPicked

Protected Methods

• destroyCore
• onProcessEndCore
• onProcessStartCore
• refreshCore

Constructors

---

constructor

⊕ new ColumnsBar(slot: HTMLElement,customQuery?: Query): ColumnsBar

Parameters:

• slot: HTMLElement
• customQuery: Query, Optional

---

Public Properties

---

id

● id: string

---

moveMenu

● moveMenu: PopupMenu

---

sortMenu

● sortMenu: PopupMenu

---

Protected Properties

---

context

● context: EqContext

---

group

● group: WidgetGroup

---

slot

● slot: HTMLElement

---

Protected Accessors

---

cssPrefix

⇄ get cssPrefix(): string

Returns string

---

Public Methods

---

addColumn

▸ addColumn(column: QueryColumn | QueryColumn[],index?: number): void

Parameters:

• column: QueryColumn | QueryColumn[]
• index: number, Optional

Returns void

---

addNewColumn

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

Parameters:

• attrId: string
• index: number, Optional

Returns QueryColumn

▸ addNewColumn(attrId: string[],index?: number): QueryColumn[]

Parameters:

• attrId: string[]
• index: number, Optional

Returns QueryColumn[]

---

areCustomExpressionsAllowed

▸ areCustomExpressionsAllowed(): boolean

Returns boolean

---

belongsToGroup

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

▸ belongsToGroup(groups?: WidgetGroup): boolean

Parameters:

• groups: WidgetGroup, Optional -

Returns boolean

---

destroy

▸ destroy(): void

Returns void

---

getColumnsBlock

▸ getColumnsBlock(): HTMLElement

Returns HTMLElement

---

getContext

Returns current context (the one this widget belongs to)

▸ getContext(): EqContext

Returns EqContext

---

getQuery

▸ getQuery(): Query

Returns Query

---

getWidgetType

▸ getWidgetType(): string

Returns string

---

hideLandingSlot

▸ hideLandingSlot(): void

Returns void

---

init

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

Parameters:

• context: EqContext
• options: ColumnsBarOptions, Optional

Returns void

---

moveColumn

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

Parameters:

• column: QueryColumn
• direction: string

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

---

showEntitiesMenu

▸ showEntitiesMenu(menuOptions: any): void

Parameters:

• menuOptions: any

Returns void

---

showLandingSlot

▸ showLandingSlot(pageX: number,pageY: number): void

Parameters:

• pageX: number
• pageY: number

Returns void

---

toggleColumnPicked

▸ toggleColumnPicked(column: QueryColumn): void

Parameters:

• column: QueryColumn

Returns void

---

Protected Methods

---

destroyCore

▸ destroyCore(): void

Returns void

---

onProcessEndCore

▸ onProcessEndCore(): void

Returns void

---

onProcessStartCore

▸ onProcessStartCore(): void

Returns void

---

refreshCore

▸ refreshCore(): void

Returns void

---