BootstrapCardView Class

Declaration

export class BootstrapCardView extends BootstrapGridBase

Inheritance

BootstrapGridBase
BootstrapCardView

Properties

batchEditApi Property

Declaration

batchEditApi: BootstrapCardViewBatchEditApi | null

Property Value

Type Description
BootstrapCardViewBatchEditApi
null

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

addNewCard Method

Declaration

addNewCard(): void

adjustControl Method

Declaration

adjustControl(): 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(columnIndex: number): void

Parameters

Type Name Description
number columnIndex

focusEditor Method

Declaration

focusEditor(column: BootstrapCardViewColumn): void

Parameters

Type Name Description
BootstrapCardViewColumn column

focusEditor Method

Declaration

focusEditor(columnFieldNameOrId: string): void

Parameters

Type Name Description
string columnFieldNameOrId

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

getEditValue Method

Declaration

getEditValue(columnFieldNameOrId: string): string

Parameters

Type Name Description
string columnFieldNameOrId

Returns

Type Description
string

getEditValue Method

Declaration

getEditValue(columnIndex: number): string

Parameters

Type Name Description
number columnIndex

Returns

Type Description
string

getEditor Method

Declaration

getEditor(columnIndex: number): BootstrapClientEdit

Parameters

Type Name Description
number columnIndex

Returns

Type Description
BootstrapClientEdit

getEditor Method

Declaration

getEditor(column: BootstrapCardViewColumn): BootstrapClientEdit

Parameters

Type Name Description
BootstrapCardViewColumn column

Returns

Type Description
BootstrapClientEdit

getEditor Method

Declaration

getEditor(columnFieldNameOrId: string): BootstrapClientEdit

Parameters

Type Name Description
string columnFieldNameOrId

Returns

Type Description
BootstrapClientEdit

getFocusedCardIndex Method

Declaration

getFocusedCardIndex(): number

Returns

Type Description
number

getFocusedCell Method

Declaration

getFocusedCell(): BootstrapCardViewCellInfo | null

Returns

Type Description
BootstrapCardViewCellInfo
null

getHeight Method

Declaration

getHeight(): number

Returns

Type Description
number

getMainElement Method

Declaration

getMainElement(): any

Returns

Type Description
any

getPageCount Method

Declaration

getPageCount(): number

Returns

Type Description
number

getPageIndex Method

Declaration

getPageIndex(): number

Returns

Type Description
number

getParentControl Method

Declaration

getParentControl(): any

Returns

Type Description
any

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
any[]

getToolbar Method

Declaration

getToolbar(index: number): BootstrapMenu | null

Parameters

Type Name Description
number index

Returns

Type Description
BootstrapMenu
null

getToolbarByName Method

Declaration

getToolbarByName(name: string): BootstrapMenu | null

Parameters

Type Name Description
string name

Returns

Type Description
BootstrapMenu
null

getTopVisibleIndex Method

Declaration

getTopVisibleIndex(): number

Returns

Type Description
number

getVerticalScrollPosition Method

Declaration

getVerticalScrollPosition(): number

Returns

Type Description
number

getVisible Method

Declaration

getVisible(): boolean

Returns

Type Description
boolean

getVisibleCardsOnPage Method

Declaration

getVisibleCardsOnPage(): number

Returns

Type Description
number

getWidth Method

Declaration

getWidth(): number

Returns

Type Description
number

gotoPage Method

Declaration

gotoPage(pageIndex: number): void

Parameters

Type Name Description
number pageIndex

hideCustomizationWindow Method

Declaration

hideCustomizationWindow(): void

inCallback Method

Declaration

inCallback(): boolean

Returns

Type Description
boolean

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

moveColumn Method

Declaration

moveColumn(columnIndex: number): void

Parameters

Type Name Description
number columnIndex

moveColumn Method

Declaration

moveColumn(columnFieldNameOrId: string): void

Parameters

Type Name Description
string columnFieldNameOrId

moveColumn Method

Declaration

moveColumn(column: BootstrapCardViewColumn, moveToColumnVisibleIndex: number): void

Parameters

Type Name Description
BootstrapCardViewColumn column
number moveToColumnVisibleIndex

moveColumn Method

Declaration

moveColumn(columnIndex: number, moveToColumnVisibleIndex: number): void

Parameters

Type Name Description
number columnIndex
number moveToColumnVisibleIndex

moveColumn Method

Declaration

moveColumn(columnFieldNameOrId: string, moveToColumnVisibleIndex: number): void

Parameters

Type Name Description
string columnFieldNameOrId
number moveToColumnVisibleIndex

moveColumn Method

Declaration

moveColumn(column: BootstrapCardViewColumn, moveToColumnVisibleIndex: number, moveBefore: boolean): void

Parameters

Type Name Description
BootstrapCardViewColumn column
number moveToColumnVisibleIndex
boolean moveBefore

moveColumn Method

Declaration

moveColumn(columnIndex: number, moveToColumnVisibleIndex: number, moveBefore: boolean): void

Parameters

Type Name Description
number columnIndex
number moveToColumnVisibleIndex
boolean moveBefore

moveColumn Method

Declaration

moveColumn(columnFieldNameOrId: string, moveToColumnVisibleIndex: number, moveBefore: boolean): void

Parameters

Type Name Description
string columnFieldNameOrId
number moveToColumnVisibleIndex
boolean moveBefore

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<K extends keyof BootstrapCardViewEventMap>(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<K extends keyof BootstrapCardViewEventMap>(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>

performCallback Method

Declaration

performCallback(data: any, onSuccess: () => void): void

Parameters

Type Name Description
any data
() => void onSuccess

prevPage Method

Declaration

prevPage(): void

refresh Method

Declaration

refresh(): void

selectAllCardsOnPage Method

Declaration

selectAllCardsOnPage(): void

selectCardOnPage Method

Declaration

selectCardOnPage(visibleIndex: number, selected: boolean): void

Parameters

Type Name Description
number visibleIndex
boolean selected

selectCardOnPage Method

Declaration

selectCardOnPage(visibleIndex: number): void

Parameters

Type Name Description
number visibleIndex

selectCards Method

Declaration

selectCards(): void

selectCardsByKey Method

Declaration

selectCardsByKey(key: any): void

Parameters

Type Name Description
any key

selectCardsByKey Method

Declaration

selectCardsByKey(keys: any[], selected: boolean): void

Parameters

Type Name Description
any[] keys
boolean selected

selectCardsByKey Method

Declaration

selectCardsByKey(keys: any[]): void

Parameters

Type Name Description
any[] keys

selectCardsByKey Method

Declaration

selectCardsByKey(key: any, selected: boolean): void

Parameters

Type Name Description
any key
boolean selected

sendMessageToAssistiveTechnology Method

Declaration

sendMessageToAssistiveTechnology(message: string): void

Parameters

Type Name Description
string message

setEditValue Method

Declaration

setEditValue(columnIndex: number, value: string): void

Parameters

Type Name Description
number columnIndex
string value

setEditValue Method

Declaration

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

Parameters

Type Name Description
BootstrapCardViewColumn column
string value

setEditValue Method

Declaration

setEditValue(columnFieldNameOrId: string, value: string): void

Parameters

Type Name Description
string columnFieldNameOrId
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

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
number height

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

setVisible Method

Declaration

setVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setWidth Method

Declaration

setWidth(width: number): void

Parameters

Type Name Description
number width

showCustomizationWindow Method

Declaration

showCustomizationWindow(): void

showFilterControl Method

Declaration

showFilterControl(): void

sortBy Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Type Name Description
string columnFieldNameOrId
string sortOrder
boolean reset
number sortIndex

sortBy Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string): void

Parameters

Type Name Description
string columnFieldNameOrId
string sortOrder

sortBy Method

Declaration

sortBy(columnIndex: number, sortOrder: string): void

Parameters

Type Name Description
number columnIndex
string sortOrder

sortBy Method

Declaration

sortBy(column: BootstrapCardViewColumn, sortOrder: string): void

Parameters

Type Name Description
BootstrapCardViewColumn column
string sortOrder

sortBy Method

Declaration

sortBy(columnFieldNameOrId: string): void

Parameters

Type Name Description
string columnFieldNameOrId

sortBy Method

Declaration

sortBy(columnIndex: number): void

Parameters

Type Name Description
number columnIndex

sortBy Method

Declaration

sortBy(column: BootstrapCardViewColumn): void

Parameters

Type Name Description
BootstrapCardViewColumn column

sortBy Method

Declaration

sortBy(column: BootstrapCardViewColumn, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Type Name Description
BootstrapCardViewColumn column
string sortOrder
boolean reset
number sortIndex

sortBy Method

Declaration

sortBy(columnIndex: number, sortOrder: string, reset: boolean): void

Parameters

Type Name Description
number columnIndex
string sortOrder
boolean reset

sortBy Method

Declaration

sortBy(columnIndex: number, sortOrder: string, reset: boolean, sortIndex: number): void

Parameters

Type Name Description
number columnIndex
string sortOrder
boolean reset
number sortIndex

sortBy Method

Declaration

sortBy(columnFieldNameOrId: string, sortOrder: string, reset: boolean): void

Parameters

Type Name Description
string columnFieldNameOrId
string sortOrder
boolean reset

sortBy Method

Declaration

sortBy(column: BootstrapCardViewColumn, sortOrder: string, reset: boolean): void

Parameters

Type Name Description
BootstrapCardViewColumn column
string sortOrder
boolean reset

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: any[]): void

Parameters

Type Name Description
any[] keys

unselectCardsByKey Method

Declaration

unselectCardsByKey(key: any): void

Parameters

Type Name Description
any key

unselectFilteredCards Method

Declaration

unselectFilteredCards(): void

updateEdit Method

Declaration

updateEdit(): void