dhtmlx-scheduler 6.0.4 → 7.0.0

package/codebase/dhtmlxscheduler.d.ts

@@ -5,7 +5,91 @@ type SchedulerCallback = (...args: any[]) => any;
 type SchedulerFilterCallback = { (id: string | number, event: any): boolean }
 
 
-type SchedulerEventName = "onAfterEventDisplay"|"onAfterFolderToggle"|"onAfterLightbox"|"onAfterQuickInfo"|"onAfterSchedulerResize"|"onBeforeCollapse"|"onBeforeDrag"|"onBeforeEventChanged"|"onBeforeEventCreated"|"onBeforeEventDelete"|"onBeforeEventDisplay"|"onBeforeEventDragIn"|"onBeforeEventDragOut"|"onBeforeEventPasted"|"onBeforeExpand"|"onBeforeExternalDragIn"|"onBeforeFolderToggle"|"onBeforeLightbox"|"onBeforeParse"|"onBeforeTodayDisplayed"|"onBeforeTooltip"|"onBeforeViewChange"|"onCellClick"|"onCellDblClick"|"onClearAll"|"onClick"|"onCollapse"|"onConfirmedBeforeEventDelete"|"onContextMenu"|"onDataRender"|"onDblClick"|"onDestroy"|"onDragEnd"|"onEmptyClick"|"onError"|"onEventAdded"|"onEventCancel"|"onEventChanged"|"onEventCollision"|"onEventCopied"|"onEventCreated"|"onEventCut"|"onEventDeleted"|"onEventDrag"|"onEventDragIn"|"onEventDragOut"|"onEventDropOut"|"onEventIdChange"|"onEventLoading"|"onEventPasted"|"onEventSave"|"onEventSelected"|"onEventUnselected"|"onExpand"|"onExternalDragIn"|"onLightbox"|"onLightboxButton"|"onLimitViolation"|"onLoadEnd"|"onLoadError"|"onLoadStart"|"onLocationError"|"onMouseDown"|"onMouseMove"|"onOptionsLoad"|"onOptionsLoadFinal"|"onOptionsLoadStart"|"onParse"|"onQuickInfo"|"onSaveError"|"onScaleAdd"|"onScaleDblClick"|"onSchedulerReady"|"onSchedulerResize"|"onTemplatesReady"|"onTimelineCreated"|"onViewChange"|"onViewMoreClick"|"onXLE"|"onXLS"|"onXScaleClick"|"onXScaleDblClick"|"onYScaleClick"|"onYScaleDblClick";
+type SchedulerEventName = "onAfterEventDisplay" |
+	"onAfterFolderToggle" |
+	"onAfterLightbox" |
+	"onAfterQuickInfo" |
+	"onAfterSchedulerResize" |
+	"onBeforeCollapse" |
+	"onBeforeDrag" |
+	"onBeforeEventChanged" |
+	"onBeforeEventCreated" |
+	"onBeforeEventDelete" |
+	"onBeforeEventDisplay" |
+	"onBeforeEventDragIn" |
+	"onBeforeEventDragOut" |
+	"onBeforeEventPasted" |
+	"onBeforeExpand" |
+	"onBeforeExternalDragIn" |
+	"onBeforeFolderToggle" |
+	"onBeforeLightbox" |
+	"onBeforeParse" |
+	"onBeforeQuickInfo" |
+	"onBeforeTodayDisplayed" |
+	"onBeforeTooltip" |
+	"onBeforeViewChange" |
+	"onCellClick" |
+	"onCellDblClick" |
+	"onClearAll" |
+	"onClick" |
+	"onCollapse" |
+	"onConfirmedBeforeEventDelete" |
+	"onContextMenu" |
+	"onDataRender" |
+	"onDblClick" |
+	"onDestroy" |
+	"onDragEnd" |
+	"onEmptyClick" |
+	"onError" |
+	"onEventAdded" |
+	"onEventCancel" |
+	"onEventChanged" |
+	"onEventCollision" |
+	"onEventCopied" |
+	"onEventCreated" |
+	"onEventCut" |
+	"onEventDeleted" |
+	"onEventDrag" |
+	"onEventDragIn" |
+	"onEventDragOut" |
+	"onEventDropOut" |
+	"onEventIdChange" |
+	"onEventLoading" |
+	"onEventPasted" |
+	"onEventSave" |
+	"onEventSelected" |
+	"onEventUnselected" |
+	"onExpand" |
+	"onExternalDragIn" |
+	"onLightbox" |
+	"onLightboxButton" |
+	"onLimitViolation" |
+	"onLoadEnd" |
+	"onLoadError" |
+	"onLoadStart" |
+	"onLocationError" |
+	"onMouseDown" |
+	"onMouseMove" |
+	"onOptionsLoad" |
+	"onOptionsLoadFinal" |
+	"onOptionsLoadStart" |
+	"onParse" |
+	"onQuickInfo" |
+	"onSaveError" |
+	"onScaleAdd" |
+	"onScaleDblClick" |
+	"onSchedulerReady" |
+	"onSchedulerResize" |
+	"onTemplatesReady" |
+	"onTimelineCreated" |
+	"onViewChange" |
+	"onViewMoreClick" |
+	"onXLE" |
+	"onXLS" |
+	"onXScaleClick" |
+	"onXScaleDblClick" |
+	"onYScaleClick" |
+	"onYScaleDblClick";
 
 
 export interface SchedulerTemplates {
@@ -17,6 +101,11 @@ export interface SchedulerTemplates {
 	*/
 	agenda_date(start: Date, end: Date): string;
 
+	/**
+	 * specifies the content of the day cell of the Agenda view
+	*/
+	agenda_day(): void;
+
 	/**
 	 * specifies the text in the second column of the Agenda view
 	 * @param start the date when an event is scheduled to begin
@@ -260,6 +349,16 @@ export interface SchedulerTemplates {
 	*/
 	time_picker(): string;
 
+	/**
+	 * specifies the css class of background cell in Day/Week views
+	*/
+	time_slot_class(): void;
+
+	/**
+	 * specifies the content of background cell in Day/Week views
+	*/
+	time_slot_text(): void;
+
 	/**
 	 * specifies the format of start and end dates displayed in the tooltip
 	 * @param date the date which needs formatting
@@ -574,6 +673,11 @@ export interface SchedulerConfigOptions {
 	*/
 	date_format: string;
 
+	/**
+	 * adds padding to a view column
+	*/
+	day_column_padding: number;
+
 	/**
 	 * sets the date format for the X-Axis of the Week and Units views
 	*/
@@ -995,7 +1099,7 @@ export interface SchedulerConfigOptions {
 	scroll_hour: number;
 
 	/**
-	 * specifies the delimiter that will be used to separate several sections/units in the related data property of the event
+	 * specifies the delimeter that will be used to separate several sections/units in the related data property of the event
 	*/
 	section_delimiter: string;
 
@@ -1044,6 +1148,26 @@ export interface SchedulerConfigOptions {
 	*/
 	timeline_swap_resize: boolean;
 
+	/**
+	 * sets the length of time, in milliseconds, before the tooltip hides
+	*/
+	tooltip_hide_timeout: number;
+
+	/**
+	 * sets the right (if positive) offset of the tooltip's position
+	*/
+	tooltip_offset_x: number;
+
+	/**
+	 * sets the top (if positive) offset of the tooltip's position
+	*/
+	tooltip_offset_y: number;
+
+	/**
+	 * sets the timeout in milliseconds before the tooltip is displayed for a task
+	*/
+	tooltip_timeout: number;
+
 	/**
 	 * enables/disables the touch support in the scheduler
 	*/
@@ -1224,6 +1348,50 @@ export interface SchedulerLocale {
 	labels: SchedulerLocaleLabels;
 }
 
+export interface SchedulerFormBlock {
+
+	/**
+	 * Renders the form block based on the provided configuration.
+	 * @function
+	 * @name SchedulerFormBlock#render
+	 * @param {any} config - The configuration object for the custom lightbox control.
+	 * @returns {string} Returns the HTML string representing the rendered the custom control.
+	 */
+	render: (config: any) => string;
+
+	/**
+	 * Sets the value of the custom lightbox control.
+	 * @function
+	 * @name SchedulerFormBlock#set_value
+	 * @param {HTMLElement} node - HTML object related to HTML defined above.
+	 * @param {*} value - value defined by map_to property.
+	 * @param {Event} ev - The event object.
+	 * @param {any} config - Section configuration object.
+	 * @returns {void}
+	 */
+	set_value: (node: HTMLElement, value: any, ev: Event, config: any) => void;
+
+	/**
+	 * Gets the value of the custom control.
+	 * @function
+	 * @name SchedulerFormBlock#get_value
+	 * @param {HTMLElement} node - HTML object related to HTML defined above.
+	 * @param {Event} ev - The event object.
+	 * @param {any} config - Section configuration object.
+	 * @returns {*} Returns the value of the custom lightbox control.
+	 */
+	get_value: (node: HTMLElement, ev: Event, config: any) => any;
+
+	/**
+	 * Focuses on the custom lightbox control.
+	 * @function
+	 * @name SchedulerFormBlock#focus
+	 * @param {HTMLElement} node - HTML object related to HTML defined above.
+	 * @returns {void}
+	 */
+	focus: (node: HTMLElement) => void;
+	}
+
 export interface SchedulerSizes {
 
 	/**
@@ -1440,9 +1608,9 @@ export interface SchedulerStatic {
 	 * attaches the handler to an inner event of dhtmlxScheduler
 	 * @param name the event's name, case-insensitive
 	 * @param handler the handler function
-	 * @param settings optional, an <a href="#propertiesofsettingsobject">object with settings</a> for the event handler
+	 * @param settings optional, optional, an <a href="#propertiesofsettingsobject">object with settings</a> for the event handler
 	*/
-	attachEvent(name: SchedulerEventName, handler: SchedulerCallback, settings: any): string;
+	attachEvent(name: SchedulerEventName, handler: SchedulerCallback, settings?: any): string;
 
 	/**
 	 * makes the scheduler reflect all data changes in the Backbone model and vice versa
@@ -1580,9 +1748,9 @@ export interface SchedulerStatic {
 
 	/**
 	 * removes marking/blocking set by the addMarkedTimespan() method
-	 * @param id optional, the timespan's id
+	 * @param config optional, the timespan's id or the timespan's configuration properties
 	*/
-	deleteMarkedTimespan(id?: string): void;
+	deleteMarkedTimespan(config?: any): void;
 
 	/**
 	 * deletes a section from the currently active view
@@ -1841,7 +2009,7 @@ export interface SchedulerStatic {
 	 * marks and/or blocks date(s) by applying the default or a custom style to them. Marking is cancelled right after any internal update in the app. Can be used for highlighting
 	 * @param config the configuration object of the timespan to mark/block
 	*/
-	markTimespan(config: any): void;
+	markTimespan(config: any): any[];
 
 	/**
 	 * calls a message box of the specified type
@@ -1933,7 +2101,7 @@ export interface SchedulerStatic {
 	/**
 	 * serializes all events loaded into the scheduler
 	*/
-	serialize(): any[];
+	serialize(): void;
 
 	/**
 	 * defines a named collection that can be loaded into Units, Timeline views, or the Lightbox
@@ -1988,6 +2156,12 @@ export interface SchedulerStatic {
 	*/
 	setLoadMode(mode: string): void;
 
+	/**
+	 * sets the active skin
+	 * @param skin name of the skin. Allowed values: "terrace", "dark", "material", "flat", "contrast-white", "contrast-black"
+	*/
+	setSkin(skin: string): void;
+
 	/**
 	 * sets the user data associated with the specified event
 	 * @param id the event's id
@@ -2120,7 +2294,16 @@ export interface SchedulerStatic {
 	 * @param view optional, (optional) the view name
 	*/
 	updateView(date?: Date, view?: string): void;
-}
+	
+	// /**
+	//  * A key-value mapping of string keys to Scheduler form blocks.
+	//  * The keys represent the names of the custom lightbox controls.
+	//  * The values are objects that implement the SchedulerFormBlock interface.
+	//  */
+	form_blocks: { [key: string]: SchedulerFormBlock };
+
+	[customMethod: string]: any;
+	}
 
 export declare var scheduler: SchedulerStatic;