BootstrapScheduler Class

Represents the client-side equivalent of the BootstrapScheduler control.

Declaration

export class BootstrapScheduler extends Control
Note

See Online Demos: Refer to the https://demos.devexpress.com/aspnetcore-bootstrap/Scheduler-ClientSideAPI online demo for detailed information on the Scheduler control's client-side API.

Inheritance

Control
BootstrapScheduler

Methods

appointmentFormCancel Method

Declaration

appointmentFormCancel(): void

appointmentFormDelete Method

Declaration

appointmentFormDelete(): void

appointmentFormSave Method

Declaration

appointmentFormSave(): void

changeFormContainer Method

Declaration

changeFormContainer(container: any): void

Parameters

Type Name Description
container

changePopupMenuContainer Method

Declaration

changePopupMenuContainer(container: any): void

Parameters

Type Name Description
container

changeTimeZoneId Method

Declaration

changeTimeZoneId(timeZoneId: string): void

Parameters

Type Name Description
timeZoneId

changeToolTipContainer Method

Declaration

changeToolTipContainer(container: any): void

Parameters

Type Name Description
container

deleteAppointment Method

Declaration

deleteAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Type Name Description
apt

deselectAppointmentById Method

Declaration

deselectAppointmentById(aptId: any): void

Parameters

Type Name Description
aptId

getActiveViewType Method

Declaration

getActiveViewType(): BootstrapSchedulerViewType

Returns

Type Description

getAllDayAreaHeight Method

Declaration

getAllDayAreaHeight(): number

Returns

Type Description

getAppointmentById Method

Declaration

getAppointmentById(id: any): BootstrapSchedulerAppointment | null

Parameters

Type Name Description
id

Returns

Type Description

getAppointmentProperties Method

Declaration

getAppointmentProperties(aptId: number, propertyNames: array[string], onCallBack: any): array[string]

Parameters

Type Name Description
aptId
propertyNames
onCallBack

Returns

Type Description

getGroupType Method

Declaration

getGroupType(): BootstrapSchedulerGroupType

Returns

Type Description

getResourceNavigatorVisible Method

Declaration

getResourceNavigatorVisible(): boolean

Returns

Type Description

getScrollAreaHeight Method

Declaration

getScrollAreaHeight(): number

Returns

Type Description

getSelectedAppointmentIds Method

Declaration

getSelectedAppointmentIds(): array[string]

Returns

Type Description

getSelectedInterval Method

Declaration

getSelectedInterval(): BootstrapTimeInterval | null

Returns

Type Description

getSelectedResource Method

Declaration

getSelectedResource(): string

Returns

Type Description

getToolbarVisible Method

Declaration

getToolbarVisible(): boolean

Returns

Type Description

getTopRowTime Method

Declaration

getTopRowTime(viewType: BootstrapSchedulerViewType): number

Parameters

Type Name Description
viewType

Returns

Type Description

getVisibleAppointments Method

Declaration

getVisibleAppointments(): array[BootstrapSchedulerAppointment]

Returns

Type Description

getVisibleIntervals Method

Declaration

getVisibleIntervals(): array[BootstrapTimeInterval]

Returns

Type Description

goToDateFormApply Method

Declaration

goToDateFormApply(): void

goToDateFormCancel Method

Declaration

goToDateFormCancel(): void

gotoDate Method

Declaration

gotoDate(date: Date): void

Parameters

Type Name Description
date

gotoToday Method

Declaration

gotoToday(): void

hideLoadingPanel Method

Declaration

hideLoadingPanel(): void

inplaceEditFormCancel Method

Declaration

inplaceEditFormCancel(): void

inplaceEditFormSave Method

Declaration

inplaceEditFormSave(): void

inplaceEditFormShowMore Method

Declaration

inplaceEditFormShowMore(): void

insertAppointment Method

Declaration

insertAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Type Name Description
apt

navigateBackward Method

Declaration

navigateBackward(): void

navigateForward Method

Declaration

navigateForward(): void

off Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

on Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

once Method

Declaration

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

Parameters

Type Name Description
eventName
callback

Returns

Type Description

performCallback Method

Declaration

performCallback(parameter: string): void

Parameters

Type Name Description
parameter

refresh Method

Declaration

refresh(): void

refreshClientAppointmentProperties Method

Declaration

refreshClientAppointmentProperties(clientAppointment: BootstrapSchedulerAppointment, propertyNames: array[string], onCallBack: any): void

Parameters

Type Name Description
clientAppointment
propertyNames
onCallBack

reminderFormCancel Method

Declaration

reminderFormCancel(): void

reminderFormDismiss Method

Declaration

reminderFormDismiss(): void

reminderFormDismissAll Method

Declaration

reminderFormDismissAll(): void

reminderFormSnooze Method

Declaration

reminderFormSnooze(): void

selectAppointmentById Method

Declaration

selectAppointmentById(aptId: any): void

Parameters

Type Name Description
aptId

setActiveViewType Method

Declaration

setActiveViewType(value: BootstrapSchedulerViewType): void

Parameters

Type Name Description
value

setAllDayAreaHeight Method

Declaration

setAllDayAreaHeight(height: number): void

Parameters

Type Name Description
height

setGroupType Method

Declaration

setGroupType(value: BootstrapSchedulerGroupType): void

Parameters

Type Name Description
value

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
height

setResourceNavigatorVisible Method

Declaration

setResourceNavigatorVisible(visible: boolean): void

Parameters

Type Name Description
visible

setSelection Method

Declaration

setSelection(interval: BootstrapTimeInterval): void

Parameters

Type Name Description
interval

setToolbarVisible Method

Declaration

setToolbarVisible(visible: boolean): void

Parameters

Type Name Description
visible

setTopRowTime Method

Declaration

setTopRowTime(duration: number): void

Parameters

Type Name Description
duration

setVisibleResources Method

Declaration

setVisibleResources(resourceIds: array[string]): void

Parameters

Type Name Description
resourceIds

showAppointmentFormByClientId Method

Declaration

showAppointmentFormByClientId(aptClientId: string): void

Parameters

Type Name Description
aptClientId

showAppointmentFormByServerId Method

Declaration

showAppointmentFormByServerId(aptServerId: string): void

Parameters

Type Name Description
aptServerId

showInplaceEditor Method

Declaration

showInplaceEditor(start: Date, end: Date): void

Parameters

Type Name Description
start
end

showLoadingPanel Method

Declaration

showLoadingPanel(): void

showSelectionToolTip Method

Declaration

showSelectionToolTip(x: number, y: number): void

Parameters

Type Name Description
x
y

updateAppointment Method

Declaration

updateAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Type Name Description
apt