BootstrapCardView Class

Declaration

export class BootstrapCardView extends BootstrapGridBase

Inheritance

Properties

batchEditApi property

Declaration

batchEditApi: BootstrapCardViewBatchEditApi | null

Property Value

Type Description
BootstrapCardViewBatchEditApi
null

Methods

addNewCard method

Declaration

addNewCard(): void

applyFilter method

Declaration

applyFilter(filterExpression: string): void

Parameters

Type Name Description
string filterExpression

applySearchPanelFilter method

Declaration

applySearchPanelFilter(value: string): void

Parameters

Type Name Description
string value

cancelEdit method

Declaration

cancelEdit(): void

clearFilter method

Declaration

clearFilter(): void

closeFilterControl method

Declaration

closeFilterControl(): void

deleteCard method

Declaration

deleteCard(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

deleteCardByKey method

Declaration

deleteCardByKey(key: any): void

Parameters

Type Name Description
any key

focus method

Declaration

focus(): void

focusEditor method

Declaration

focusEditor(column: BootstrapCardViewColumn): void

Parameters

Type Name Description
BootstrapCardViewColumn column

getCardKey method

Declaration

getCardKey(visibleIndex: number): string

Parameters

Type Name Description
number visibleIndex

Returns

Type Description
string

getColumn method

Declaration

getColumn(columnIndex: number): BootstrapCardViewColumn | null

Parameters

Type Name Description
number columnIndex

Returns

Type Description
BootstrapCardViewColumn
null

getColumnByField method

Declaration

getColumnByField(columnFieldName: string): BootstrapCardViewColumn | null

Parameters

Type Name Description
string columnFieldName

Returns

Type Description
BootstrapCardViewColumn
null

getColumnById method

Declaration

getColumnById(columnId: string): BootstrapCardViewColumn | null

Parameters

Type Name Description
string columnId

Returns

Type Description
BootstrapCardViewColumn
null

getColumnCount method

Declaration

getColumnCount(): number

Returns

Type Description
number

getEditValue method

Declaration

getEditValue(column: BootstrapCardViewColumn): string

Parameters

Type Name Description
BootstrapCardViewColumn column

Returns

Type Description
string

getEditor method

Declaration

getEditor(column: BootstrapCardViewColumn): BootstrapClientEdit

Parameters

Type Name Description
BootstrapCardViewColumn column

Returns

Type Description
BootstrapClientEdit

getFocusedCardIndex method

Declaration

getFocusedCardIndex(): number

Returns

Type Description
number

getFocusedCell method

Declaration

getFocusedCell(): BootstrapCardViewCellInfo | null

Returns

Type Description
BootstrapCardViewCellInfo
null

getPageCount method

Declaration

getPageCount(): number

Returns

Type Description
number

getPageIndex method

Declaration

getPageIndex(): number

Returns

Type Description
number

getPopupEditForm method

Declaration

getPopupEditForm(): BootstrapPopupControl | null

Returns

Type Description
BootstrapPopupControl
null

getSelectedCardCount method

Declaration

getSelectedCardCount(): number

Returns

Type Description
number

getSelectedKeysOnPage method

Declaration

getSelectedKeysOnPage(): array[any]

Returns

Type Description
array[any]

getTopVisibleIndex method

Declaration

getTopVisibleIndex(): number

Returns

Type Description
number

getVerticalScrollPosition method

Declaration

getVerticalScrollPosition(): number

Returns

Type Description
number

getVisibleCardsOnPage method

Declaration

getVisibleCardsOnPage(): number

Returns

Type Description
number

gotoPage method

Declaration

gotoPage(pageIndex: number): void

Parameters

Type Name Description
number pageIndex

hideCustomizationWindow method

Declaration

hideCustomizationWindow(): void

isCardSelectedOnPage method

Declaration

isCardSelectedOnPage(visibleIndex: number): boolean

Parameters

Type Name Description
number visibleIndex

Returns

Type Description
boolean

isCustomizationWindowVisible method

Declaration

isCustomizationWindowVisible(): boolean

Returns

Type Description
boolean

isEditing method

Declaration

isEditing(): boolean

Returns

Type Description
boolean

isNewCardEditing method

Declaration

isNewCardEditing(): boolean

Returns

Type Description
boolean

moveColumn method

Declaration

moveColumn(column: BootstrapCardViewColumn): void

Parameters

Type Name Description
BootstrapCardViewColumn column

nextPage method

Declaration

nextPage(): void

off method

Declaration

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

Parameters

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

Returns

Type Description
this

on method

Declaration

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

Parameters

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

Returns

Type Description
this

once method

Declaration

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

Parameters

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

Returns

Type Description
this

performCallback method

Declaration

performCallback(data: any): Promise<void>

Parameters

Type Name Description
any data

Returns

Type Description
Promise<void>

prevPage method

Declaration

prevPage(): void

refresh method

Declaration

refresh(): void

selectAllCardsOnPage method

Declaration

selectAllCardsOnPage(): void

selectCardOnPage method

Declaration

selectCardOnPage(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

selectCards method

Declaration

selectCards(): void

selectCardsByKey method

Declaration

selectCardsByKey(keys: array[any]): void

Parameters

Type Name Description
array[any] keys

setEditValue method

Declaration

setEditValue(column: BootstrapCardViewColumn, value: string): void

Parameters

Type Name Description
BootstrapCardViewColumn column
string value

setFilterEnabled method

Declaration

setFilterEnabled(isFilterEnabled: boolean): void

Parameters

Type Name Description
boolean isFilterEnabled

setFocusedCardIndex method

Declaration

setFocusedCardIndex(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

setFocusedCell method

Declaration

setFocusedCell(cardVisibleIndex: number, columnIndex: number): void

Parameters

Type Name Description
number cardVisibleIndex
number columnIndex

setSearchPanelCustomEditor method

Declaration

setSearchPanelCustomEditor(editor: BootstrapClientEdit): void

Parameters

Type Name Description
BootstrapClientEdit editor

setVerticalScrollPosition method

Declaration

setVerticalScrollPosition(position: number): void

Parameters

Type Name Description
number position

showCustomizationWindow method

Declaration

showCustomizationWindow(): void

showFilterControl method

Declaration

showFilterControl(): void

sortBy method

Declaration

sortBy(column: BootstrapCardViewColumn): void

Parameters

Type Name Description
BootstrapCardViewColumn column

startEditCard method

Declaration

startEditCard(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

startEditCardByKey method

Declaration

startEditCardByKey(key: any): void

Parameters

Type Name Description
any key

unselectAllCardsOnPage method

Declaration

unselectAllCardsOnPage(): void

unselectCardOnPage method

Declaration

unselectCardOnPage(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

unselectCards method

Declaration

unselectCards(): void

unselectCardsByKey method

Declaration

unselectCardsByKey(keys: array[any]): void

Parameters

Type Name Description
array[any] keys

unselectFilteredCards method

Declaration

unselectFilteredCards(): void

updateEdit method

Declaration

updateEdit(): void