BootstrapCheckBoxList Class

Declaration

export class BootstrapCheckBoxList extends BootstrapListBox

Inheritance

Methods

getItem method

Declaration

getItem(index: number): BootstrapListBoxItem | null

Parameters

Type Name Description
number index

Returns

Type Description
BootstrapListBoxItem
null

getItemCount method

Declaration

getItemCount(): number

Returns

Type Description
number

getSelectedIndices method

Declaration

getSelectedIndices(): array[number]

Returns

Type Description
array[number]

getSelectedItems method

Declaration

getSelectedItems(): array[BootstrapListBoxItem]

Returns

Type Description
array[BootstrapListBoxItem]

getSelectedValues method

Declaration

getSelectedValues(): array[any]

Returns

Type Description
array[any]

off method

Declaration

off(eventName?: K, callback?: (this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void): this

Parameters

Type Name Description
K eventName
(this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void callback

Returns

Type Description
this

on method

Declaration

on(eventName: K, callback: (this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void): this

Parameters

Type Name Description
K eventName
(this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void callback

Returns

Type Description
this

once method

Declaration

once(eventName: K, callback: (this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void): this

Parameters

Type Name Description
K eventName
(this: BootstrapCheckBoxList, args?: BootstrapCheckBoxListEventMap[K]) => void callback

Returns

Type Description
this

selectAll method

Declaration

selectAll(): void

selectIndices method

Declaration

selectIndices(indices: array[number]): void

Parameters

Type Name Description
array[number] indices

selectItems method

Declaration

selectItems(items: array[BootstrapListBoxItem]): void

Parameters

Type Name Description
array[BootstrapListBoxItem] items

selectValues method

Declaration

selectValues(values: array[any]): void

Parameters

Type Name Description
array[any] values

unselectAll method

Declaration

unselectAll(): void

unselectIndices method

Declaration

unselectIndices(indices: array[number]): void

Parameters

Type Name Description
array[number] indices

unselectItems method

Declaration

unselectItems(items: array[BootstrapListBoxItem]): void

Parameters

Type Name Description
array[BootstrapListBoxItem] items

unselectValues method

Declaration

unselectValues(values: array[any]): void

Parameters

Type Name Description
array[any] values