BootstrapScheduler Class

Declaration

export class BootstrapScheduler extends Control

Inheritance

Control
BootstrapScheduler

Properties

name Property

Declaration

readonly name: string

Property Value

Type Description
string

Methods

adjustControl Method

Declaration

adjustControl(): void

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
any container

changePopupMenuContainer Method

Declaration

changePopupMenuContainer(container: any): void

Parameters

Type Name Description
any container

changeTimeZoneId Method

Declaration

changeTimeZoneId(timeZoneId: string): void

Parameters

Type Name Description
string timeZoneId

changeToolTipContainer Method

Declaration

changeToolTipContainer(container: any): void

Parameters

Type Name Description
any container

deleteAppointment Method

Declaration

deleteAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Type Name Description
BootstrapSchedulerAppointment apt

deselectAppointmentById Method

Declaration

deselectAppointmentById(aptId: any): void

Parameters

Type Name Description
any aptId

getActiveViewType Method

Declaration

getActiveViewType(): BootstrapSchedulerViewType

Returns

Type Description
BootstrapSchedulerViewType

getAllDayAreaHeight Method

Declaration

getAllDayAreaHeight(): number

Returns

Type Description
number

getAppointmentById Method

Declaration

getAppointmentById(id: any): BootstrapSchedulerAppointment | null

Parameters

Type Name Description
any id

Returns

Type Description
BootstrapSchedulerAppointment
null

getAppointmentProperties Method

Declaration

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

Parameters

Type Name Description
number aptId
string[] propertyNames
any onCallBack

Returns

Type Description
string[]

getGroupType Method

Declaration

getGroupType(): BootstrapSchedulerGroupType

Returns

Type Description
BootstrapSchedulerGroupType

getHeight Method

Declaration

getHeight(): number

Returns

Type Description
number

getMainElement Method

Declaration

getMainElement(): any

Returns

Type Description
any

getParentControl Method

Declaration

getParentControl(): any

Returns

Type Description
any

getResourceNavigatorVisible Method

Declaration

getResourceNavigatorVisible(): boolean

Returns

Type Description
boolean

getScrollAreaHeight Method

Declaration

getScrollAreaHeight(): number

Returns

Type Description
number

getSelectedAppointmentIds Method

Declaration

getSelectedAppointmentIds(): array[string]

Returns

Type Description
string[]

getSelectedInterval Method

Declaration

getSelectedInterval(): BootstrapTimeInterval | null

Returns

Type Description
BootstrapTimeInterval
null

getSelectedResource Method

Declaration

getSelectedResource(): string

Returns

Type Description
string

getToolbarVisible Method

Declaration

getToolbarVisible(): boolean

Returns

Type Description
boolean

getTopRowTime Method

Declaration

getTopRowTime(viewType: BootstrapSchedulerViewType): number

Parameters

Type Name Description
BootstrapSchedulerViewType viewType

Returns

Type Description
number

getVisible Method

Declaration

getVisible(): boolean

Returns

Type Description
boolean

getVisibleAppointments Method

Declaration

getVisibleAppointments(): array[BootstrapSchedulerAppointment]

Returns

Type Description
BootstrapSchedulerAppointment[]

getVisibleIntervals Method

Declaration

getVisibleIntervals(): array[BootstrapTimeInterval]

Returns

Type Description
BootstrapTimeInterval[]

getWidth Method

Declaration

getWidth(): number

Returns

Type Description
number

goToDateFormApply Method

Declaration

goToDateFormApply(): void

goToDateFormCancel Method

Declaration

goToDateFormCancel(): void

gotoDate Method

Declaration

gotoDate(date: Date): void

Parameters

Type Name Description
Date date

gotoToday Method

Declaration

gotoToday(): void

hideLoadingPanel Method

Declaration

hideLoadingPanel(): void

inCallback Method

Declaration

inCallback(): boolean

Returns

Type Description
boolean

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
BootstrapSchedulerAppointment 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
K eventName
(this: BootstrapScheduler, args?: BootstrapSchedulerEventMap[K]) => void callback

Returns

Type Description
this

on Method

Declaration

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

Parameters

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

Returns

Type Description
this

once Method

Declaration

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

Parameters

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

Returns

Type Description
this

performCallback Method

Declaration

performCallback(parameter: string): void

Parameters

Type Name Description
string parameter

refresh Method

Declaration

refresh(): void

refreshClientAppointmentProperties Method

Declaration

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

Parameters

Type Name Description
BootstrapSchedulerAppointment clientAppointment
string[] propertyNames
any 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, scrollToSelection: boolean): void

Parameters

Type Name Description
any aptId
boolean scrollToSelection

selectAppointmentById Method

Declaration

selectAppointmentById(aptId: any): void

Parameters

Type Name Description
any aptId

sendMessageToAssistiveTechnology Method

Declaration

sendMessageToAssistiveTechnology(message: string): void

Parameters

Type Name Description
string message

setActiveViewType Method

Declaration

setActiveViewType(value: BootstrapSchedulerViewType): void

Parameters

Type Name Description
BootstrapSchedulerViewType value

setAllDayAreaHeight Method

Declaration

setAllDayAreaHeight(height: number): void

Parameters

Type Name Description
number height

setGroupType Method

Declaration

setGroupType(value: BootstrapSchedulerGroupType): void

Parameters

Type Name Description
BootstrapSchedulerGroupType value

setHeight Method

Declaration

setHeight(height: number): void

Parameters

Type Name Description
number height

setResourceNavigatorVisible Method

Declaration

setResourceNavigatorVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setSelection Method

Declaration

setSelection(interval: BootstrapTimeInterval, resourceId: string, scrollToSelection: boolean): void

Parameters

Type Name Description
BootstrapTimeInterval interval
string resourceId
boolean scrollToSelection

setSelection Method

Declaration

setSelection(interval: BootstrapTimeInterval, resourceId: string): void

Parameters

Type Name Description
BootstrapTimeInterval interval
string resourceId

setSelection Method

Declaration

setSelection(interval: BootstrapTimeInterval): void

Parameters

Type Name Description
BootstrapTimeInterval interval

setToolbarVisible Method

Declaration

setToolbarVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setTopRowTime Method

Declaration

setTopRowTime(duration: number, viewType: BootstrapSchedulerViewType): void

Parameters

Type Name Description
number duration
BootstrapSchedulerViewType viewType

setTopRowTime Method

Declaration

setTopRowTime(duration: number): void

Parameters

Type Name Description
number duration

setVisible Method

Declaration

setVisible(visible: boolean): void

Parameters

Type Name Description
boolean visible

setVisibleResources Method

Declaration

setVisibleResources(resourceIds: string[]): void

Parameters

Type Name Description
string[] resourceIds

setWidth Method

Declaration

setWidth(width: number): void

Parameters

Type Name Description
number width

showAppointmentFormByClientId Method

Declaration

showAppointmentFormByClientId(aptClientId: string): void

Parameters

Type Name Description
string aptClientId

showAppointmentFormByServerId Method

Declaration

showAppointmentFormByServerId(aptServerId: string): void

Parameters

Type Name Description
string aptServerId

showInplaceEditor Method

Declaration

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

Parameters

Type Name Description
Date start
Date end
String resourceId

showInplaceEditor Method

Declaration

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

Parameters

Type Name Description
Date start
Date end

showLoadingPanel Method

Declaration

showLoadingPanel(): void

showSelectionToolTip Method

Declaration

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

Parameters

Type Name Description
number x
number y

updateAppointment Method

Declaration

updateAppointment(apt: BootstrapSchedulerAppointment): void

Parameters

Type Name Description
BootstrapSchedulerAppointment apt