dhtmlx-scheduler 6.0.5 → 7.0.0

package/codebase/dhtmlxscheduler.d.ts

@@ -24,6 +24,7 @@ type SchedulerEventName = "onAfterEventDisplay" |
 	"onBeforeFolderToggle" |
 	"onBeforeLightbox" |
 	"onBeforeParse" |
+	"onBeforeQuickInfo" |
 	"onBeforeTodayDisplayed" |
 	"onBeforeTooltip" |
 	"onBeforeViewChange" |
@@ -100,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
@@ -343,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
@@ -441,13 +457,6 @@ export interface SchedulerTemplates {
 	*/
 	grid_date(start: Date, end: Date): string;
 
-	/**
-	 * specifies the text in the columns
-	 * @param field_name the column's id
-	 * @param event the event object
-	*/
-	grid_field(field_name: string, event: any): string;
-
 	/**
 	 * specifies the format of dates in columns with id='date'
 	 * @param start the date when an event is scheduled to begin
@@ -463,12 +472,11 @@ export interface SchedulerTemplates {
 	grid_single_date(date: Date): string;
 
 	/**
-	 * specifies the CSS class that will be applied to a cell of the view
-	 * @param evs an array of objects of events contained in a cell (defined only in the 'cell' mode)
-	 * @param date the date of a column
-	 * @param section the section object
+	 * specifies the text in the columns
+	 * @param field_name the column's id
+	 * @param event the event object
 	*/
-	timeline_cell_class(evs: any[], date: Date, section: any): string;
+	grid_field(field_name: string, event: any): string;
 
 	/**
 	 * specifies the number of scheduled events in a cell of the view
@@ -479,24 +487,32 @@ export interface SchedulerTemplates {
 	timeline_cell_value(evs: any[], date: Date, section: any): string;
 
 	/**
-	 * specifies the date in the header of the view
-	 * @param date1 the date when an event is scheduled to begin
-	 * @param date2 the date when an event is scheduled to be completed
+	 * specifies the CSS class that will be applied to a cell of the view
+	 * @param evs an array of objects of events contained in a cell (defined only in the 'cell' mode)
+	 * @param date the date of a column
+	 * @param section the section object
 	*/
-	timeline_date(date1: Date, date2: Date): string;
+	timeline_cell_class(evs: any[], date: Date, section: any): string;
 
 	/**
-	 * specifies the CSS class that will be applied to a row of the Timeline view
-	 * @param section the section object
-	 * @param timeline the timeline object
+	 * specifies the name of a CSS class that will be applied to items of the X-Axis
+	 * @param date the date which needs formatting
 	*/
-	timeline_row_class(section: any, timeline: any): string;
+	timeline_scalex_class(date: Date): string;
 
 	/**
-	 * specifies items of the X-Axis
+	 * specifies the name of a CSS class that will be applied to items of the second X-Axis
 	 * @param date the date which needs formatting
 	*/
-	timeline_scale_date(date: Date): string;
+	timeline_second_scalex_class(date: Date): string;
+
+	/**
+	 * specifies the name of a CSS class that will be applied to items of the Y-Axis
+	 * @param key the section's id
+	 * @param label the section's label
+	 * @param section the section object that contains the 'key' and 'label' properties
+	*/
+	timeline_scaley_class(key: string, label: string, section: any): string;
 
 	/**
 	 * specifies items of the Y-Axis
@@ -507,38 +523,31 @@ export interface SchedulerTemplates {
 	timeline_scale_label(key: string, label: string, section: any): string;
 
 	/**
-	 * specifies the name of a CSS class that will be applied to items of the X-Axis
-	 * @param date the date which needs formatting
+	 * specifies the tooltip over a day cell containing some scheduled event(s)
+	 * @param start the date when an event is scheduled to begin
+	 * @param end the date when an event is scheduled to be completed
+	 * @param event the event object
 	*/
-	timeline_scalex_class(date: Date): string;
+	timeline_tooltip(start: Date, end: Date, event: any): string;
 
 	/**
-	 * specifies the name of a CSS class that will be applied to items of the Y-Axis
-	 * @param key the section's id
-	 * @param label the section's label
-	 * @param section the section object that contains the 'key' and 'label' properties
+	 * specifies the date in the header of the view
+	 * @param date1 the date when an event is scheduled to begin
+	 * @param date2 the date when an event is scheduled to be completed
 	*/
-	timeline_scaley_class(key: string, label: string, section: any): string;
+	timeline_date(date1: Date, date2: Date): string;
 
 	/**
-	 * specifies items of the second X-Axis
+	 * specifies items of the X-Axis
 	 * @param date the date which needs formatting
 	*/
-	timeline_second_scale_date(date: Date): string;
+	timeline_scale_date(date: Date): string;
 
 	/**
-	 * specifies the name of a CSS class that will be applied to items of the second X-Axis
+	 * specifies items of the second X-Axis
 	 * @param date the date which needs formatting
 	*/
-	timeline_second_scalex_class(date: Date): string;
-
-	/**
-	 * specifies the tooltip over a day cell containing some scheduled event(s)
-	 * @param start the date when an event is scheduled to begin
-	 * @param end the date when an event is scheduled to be completed
-	 * @param event the event object
-	*/
-	timeline_tooltip(start: Date, end: Date, event: any): string;
+	timeline_second_scale_date(date: Date): string;
 
 	/**
 	 * specifies the date in the header of the view
@@ -567,6 +576,13 @@ export interface SchedulerTemplates {
 	*/
 	xml_format(date: Date): string;
 
+	/**
+	 * specifies the CSS class that will be applied to a row of the Timeline view
+	 * @param section the section object
+	 * @param timeline the timeline object
+	*/
+	timeline_row_class(section: any, timeline: any): string;
+
 	[customTemplate: string]: any;
 }
 
@@ -657,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
 	*/
@@ -1127,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
 	*/
@@ -1707,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
@@ -1968,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
@@ -2115,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