Interface: IControlCollection

A dynamic toolbar control to group and organize related controls

Extends

• IToolbarControl

Extended by

• IZoomControlCollection

Properties

ariaLabel?

optionalariaLabel: string

Inherited from

IToolbarControl.ariaLabel

---

class

class: string

Inherited from

IToolbarControl.class

---

controls

readonlycontrols: IToolbarControl[]

---

disabled

readonlydisabled: boolean

Inherited from

IToolbarControl.disabled

---

id

id: string

Inherited from

IToolbarControl.id

---

isControlCollection

readonlyisControlCollection: boolean

Inherited from

IToolbarControl.isControlCollection

---

isFlexible

readonlyisFlexible: boolean

Inherited from

IToolbarControl.isFlexible

---

isHidden

readonlyisHidden: boolean

Inherited from

IToolbarControl.isHidden

---

leftDivider

leftDivider: boolean

---

order

order: number

Inherited from

IToolbarControl.order

---

permissionCheck?

optionalpermissionCheck: IPermissionCheckRequest | IPermissionCheckRequest[]

Inherited from

IToolbarControl.permissionCheck

---

rightDivider

rightDivider: boolean

---

role?

optionalrole: string

Inherited from

IToolbarControl.role

---

scrollDimensions

scrollDimensions: object

x

x: number

y

y: number

Inherited from

IToolbarControl.scrollDimensions

---

title

title: string

Inherited from

IToolbarControl.title

---

viewModelPath

readonlyviewModelPath: string

Inherited from

IToolbarControl.viewModelPath

Methods

addControl()

addControl(control, position?): void

Adds the provided control to the collection

Parameters

• control: IToolbarControl

The toolbar control to add to the collection

• position?: number

The 0 based position to insert the control at in the collection, inserted at the end if not passed

Returns

void

---

disable()

disable(): void

Disables the toolbar control. This will also gets called when toolbar containing the control gets disabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for disable.

Returns

void

Inherited from

IToolbarControl.disable

---

enable()

enable(): void

Enables the toolbar control. This will also gets called when toolbar containing the control gets enabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for enable.

Returns

void

Inherited from

IToolbarControl.enable

---

getControlById()

getControlById(id): IToolbarControl

Retrieves the toolbar control with the specified identifier

Parameters

• id: string

The element identifier

Returns

IToolbarControl

First toolbar control element matching $ or null if none present

---

hide()

hide(): void

Hides the toolbar control.

Returns

void

Inherited from

IToolbarControl.hide

---

removeControl()

removeControl(control): boolean

Removes the provided toolbar control from the collection

Parameters

• control: IToolbarControl

The toolbar control to remove from the collection

Returns

boolean

Whether or not item was removed

---

show()

show(): void

Shows the toolbar control.

Returns

void

Inherited from

IToolbarControl.show