// Type definitions for dhtmlxScheduler 4.0 // Project: http://dhtmlx.com/docs/products/dhtmlxScheduler // Definitions by: Maksim Kozhukh // Definitions: https://github.com/borisyankov/DefinitelyTyped interface SchedulerTemplates{ /** * specifies the date in the header of the view * @param start the start date of the view * @param end the end date of the view */ agenda_date(start : Date, end : Date): string; /** * specifies the text in the second column of the Agenda view * @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 */ agenda_text(start: Date, end: Date, event: any): string; /** * specifies the date in the first column of the Agenda view * @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 */ agenda_time(start: Date, end: Date, event: any): string; /** * specifies the format for dates that are set by means of API methods. Used to parse incoming dates * @param date the date which needs formatting */ api_date(date: Date): string; /** * specifies the format of the day in a cell * @param date the cell date */ calendar_date(date: Date): string; /** * specifies the date in the header of the calendar * @param date the date which needs formatting */ calendar_month(date: Date): string; /** * specifies the day name in the week sub-header of the view * @param date the date which needs formatting */ calendar_scale_date(date: Date): string; /** * specifies the date format of the lightbox start and end date inputs * @param date the date which needs formatting */ calendar_time(date: Date): string; /** * specifies the date in the header of the Day and Units views * @param date the date which needs formatting */ day_date(date: Date): string; /** * specifies the date in the sub-header of the Day view * @param date the date which needs formatting */ day_scale_date(date: Date): string; /** * specifies the date of an event. Applied to one-day events only * @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 */ event_bar_date(start: Date, end: Date, event: any): string; /** * specifies the event text. Applied to all events * @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 */ event_bar_text(start: Date, end: Date, event: any): string; /** * specifies the css style for the event container * @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 */ event_class(start: Date, end: Date, event: any): string; /** * specifies the time part of the start and end dates of the event. Mostly used by other templates for presenting time periods * @param date the date which needs formatting */ event_date(date: Date): string; /** * specifies the event header * @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 */ event_header(start: Date, end: Date, event: any): string; /** * specifies the event text * @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 */ event_text(start: Date, end: Date, event: any): string; /** * specifies the items of the Y-Axis * @param date the date which needs formatting */ hour_scale(date: Date): string; /** * specifies the format of requests in the dynamic loading mode * @param date the date which needs formatting */ load_format(date: Date): string; /** * specified the date in the header of the view * @param start the start date of the view * @param end the end date of the view */ map_date(start : Date, end : Date): string; /** * specifies the text in the second column of the view * @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 */ map_text(start: Date, end: Date, event: any): string; /** * specifies the date in the first column of the view * @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 */ map_time(start: Date, end: Date, event: any): string; /** * specifies the date of the event in the Google Maps popup marker * @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 */ marker_date(start: Date, end: Date, event: any): string; /** * specifies the text of the event in the Google Maps popup marker * @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 */ marker_text(start: Date, end: Date, event: any): string; /** * specifies the date in the header of the view * @param date the date which needs formatting */ month_date(date: Date): string; /** * specifies the css class that will be applied to a day cell * @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 */ month_date_class(start: Date, end: Date, event: any): string; /** * specifies the format of the day in a cell * @param date the date which needs formatting */ month_day(date: Date): string; /** * specifies the presentation of the 'View more' link in the cell of the Month view * @param date the date of a month cell * @param count the number of events in the cell */ month_events_link(date: Date, count: number): string; /** * specifies the date format of the X-Axis of the view * @param date the date which needs formatting */ month_scale_date(date: Date): string; /** * specifies the content of the pop-up edit form * @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 */ quick_info_content(start: Date, end: Date, event: any): string; /** * specifies the date of the pop-up edit form * @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 */ quick_info_date(start: Date, end: Date, event: any): string; /** * specifies the title of the pop-up edit form * @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 */ quick_info_title(start: Date, end: Date, event: any): string; /** * specifies the drop-down time selector in the lightbox */ time_picker(): string; /** * specifies the format of start and end dates displayed in the tooltip * @param date the date which needs formatting */ tooltip_date_format(date: Date): string; /** * specifies the text of tooltips * @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 */ tooltip_text(start: Date, end: Date, event: any): string; /** * specifies the event text * @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 * @param cellDate the date of a day cell that an one-day event or a single occurrence of the recurring event displayes in * @param pos the position a single occurrence in the recurring event: 'start' - the first occurrence, 'end' - the last occurrence, 'middle' - for remaining occurrences */ week_agenda_event_text(start: Date, end: Date, event: any, cellDate: Date, pos: string): string; /** * the date of a day cell of the view * @param date the date which needs formatting */ week_agenda_scale_date(date: Date): string; /** * specified the date in the header of the view * @param start the start date of the view * @param end the end date of the view */ week_date(start : Date, end : Date): string; /** * specifies the css class that will be applied to a day cell * @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 */ week_date_class(start: Date, end: Date, event: any): string; /** * specifies the date in the sub-header of the view * @param date the date which needs formatting */ week_scale_date(date: Date): string; /** * a string from an XML file is converted into a date object in conformity with this template * @param date the string which need to be parsed */ xml_date(date: Date): Date; /** * a date object is converted into a string in conformity with this template. Used to send data back to the server * @param date the date which needs formatting */ xml_format(date: Date): string; /** * specifies the date in the header of the view * @param date the date which needs formatting */ year_date(date: Date): string; /** * specifies the month name in the header of a month block of the view. * @param date the date which needs formatting */ year_month(date: Date): string; /** * specifies the day name in the sub-header of a month block of the view * @param date the date which needs formatting */ year_scale_date(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 */ year_tooltip(start: Date, end: Date, event: any): string; /** * specifies the lightbox header * @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 */ lightbox_header(start: Date, end: Date, event: any): string; /** * specifies the date in the header of the view * @param start the start date of the view * @param end the end date of the view */ grid_date(start : Date, end : Date): string; /** * specifies the format of dates in columns with id='date' * @param start the date when an event is scheduled to begin * @param end the date when an event is scheduled to be completed * @param ev the event object */ grid_full_date(start: Date, end: Date, ev: any): string; /** * specifies the format of dates in columns with id='start_date' or id='end_date' * @param date the date which needs formatting */ grid_single_date(date: Date): string; /** * specifies the text in the columns * @param field_name the column id * @param event the event object */ grid_field(field_name: string, event: any): string; /** * specifies the number of scheduled events in a cell of the view * @param evs an array of objects of events contained in a cell */ timeline_cell_value(evs: any): string; /** * specifies the css style for 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_cell_class(evs: any, date : Date, 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 */ timeline_scalex_class(date: Date): string; /** * 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_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 id * @param label the section 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 * @param key the section id (key) * @param label the section label * @param section the section object containing the key and label properties */ timeline_scale_label(key : string, label : string, section : any): 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; /** * 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_date(date1 : Date, date2 : Date): string; /** * specifies items of the X-Axis * @param date the date which needs formatting */ timeline_scale_date(date: Date): string; /** * specifies items of the second X-Axis * @param date the date which needs formatting */ timeline_second_scale_date(date: Date): string; /** * specifies the date in the header of the view * @param date the date which needs formatting */ units_date(date: Date): string; /** * specifies items of the X-Axis * @param key the unit id (key) * @param label the unit label * @param unit the unit object containing the key and label properties */ units_scale_text(key : string, label : string, unit : any): string; } interface SchedulerConfigOptions{ /** * 'says' to present the numbers of days in the Month view as clickable links that open the related day in the specified view */ active_link_view: string; /** * sets the date to display events until */ agenda_end: Date; /** * sets the date to start displaying events from */ agenda_start: Date; /** * 'says' to show multi-day events in the regular way (as one-day events are displayed) */ all_timed: any; /** * sets the date format that will be used by the addEvent() method to parse the start_date, end_date properties in case they are specified as strings */ api_date: string; /** * enables automatic changing of the end event date after changing the start date */ auto_end_date: boolean; /** * stores a collection of buttons resided in the left bottom corner of the lightbox */ buttons_left: any; /** * stores a collection of buttons resided in the right bottom corner of the lightbox */ buttons_right: any; /** * sets the maximum number of events in a cascade */ cascade_event_count: number; /** * sets the 'cascade' display mode */ cascade_event_display: boolean; /** * sets the left margin for a cascade of events */ cascade_event_margin: number; /** * activates/disables checking of limits */ check_limits: boolean; /** * sets the maximum allowable number of events per time slot */ collision_limit: number; /** * forces the scheduler container to automatically change its size to show the whole content without scrolling */ container_autoresize: boolean; /** * sets the format for the date in the header of the Week and Units views */ day_date: string; /** * enables the possibility to create events by double click */ dblclick_create: boolean; /** * sets the date format used by the templates 'day_date', 'week_date', 'day_scale_date' for setting date in the views' headers */ default_date: string; /** * 'says' to use the extended form while creating new events by drag or double click */ details_on_create: boolean; /** * 'says' to open the extended form after double clicking on an event */ details_on_dblclick: boolean; /** * defines whether the marked(blocked) time spans should be highlighted in the scheduler */ display_marked_timespans: boolean; /** * sets the default background color for the events retrieved by the showEvent() method */ displayed_event_color: string; /** * sets the default font color for the events retrieved by the showEvent() method */ displayed_event_text_color: string; /** * enables the possibility to create new events by drag-and-drop */ drag_create: boolean; /** * enables the possibility to drag the lightbox by the header */ drag_lightbox: boolean; /** * enables the possibility to move events by drag-and-drop */ drag_move: boolean; /** * enables the possibility to resize events by drag-and-drop */ drag_resize: boolean; /** * 'says' to open the lightbox while creating new events */ edit_on_create: boolean; /** * sets the initial duration of events in minutes */ event_duration: number; /** * sets the minimum value for the hour scale (Y-Axis) */ first_hour: number; /** * moves views' tabs from the left to the right side */ fix_tab_position: boolean; /** * enables setting of the event duration to the full day */ full_day: boolean; /** * specifies whether events retrieved by the showEvent method should be highlighted while displaying */ highlight_displayed_event: boolean; /** * sets the format of Y-Axis items */ hour_date: string; /** * sets the height of an hour unit in pixels */ hour_size_px: number; /** * stores a collection of icons visible in the side edit menu of the event box */ icons_edit: any; /** * stores a collection of icons visible in the side selection menu of the event box */ icons_select: any; /** * defines whether the date specified in the 'End by' field should be exclusive or inclusive */ include_end_by: boolean; /** * sets the maximum value of the hour scale (Y-Axis) */ last_hour: number; /** * adds the dotted left border to the scheduler */ left_border: boolean; /** * specifies the lightbox object */ lightbox: any; /** * defines the lightbox behavior while opening in the edit mode */ lightbox_recurring: string; /** * sets the right border of the allowable date range */ limit_end: Date; /** * sets the left border of the allowable date range */ limit_start: Date; /** * sets the max and min values of the time selector in the lightbox to the values of the 'last_hour' and 'first_hour' options */ limit_time_select: boolean; /** * limits viewing events */ limit_view: boolean; /** * sets the format of server request parameters 'from', 'to' in case of dynamic loading */ load_date: string; /** * sets the date to display events until */ map_end: Date; /** * sets the position that will be displayed on the map in case the event location can't be identified */ map_error_position: any; /** * the maximum width of the Google Maps's popup marker in the Map view */ map_infowindow_max_width: number; /** * sets the initial position of the map */ map_initial_position: any; /** * sets the initial zoom of Google Maps in the Map view */ map_initial_zoom: number; /** * activates attempts to resolve the event location if the database doesn't have the event's coordinates stored */ map_resolve_event_location: boolean; /** * enables/disables prompts asking the user to share his location for displaying on the map */ map_resolve_user_location: boolean; /** * sets the date to start displaying events from */ map_start: Date; /** * sets the type of Google Maps */ map_type: any; /** * sets the zoom that will be used to show the user's location if he agrees to the browser offer to show it */ map_zoom_after_resolve: number; /** * enables/disables the marker displaying the current time */ mark_now: boolean; /** * sets the maximum number of displayable in a cell events */ max_month_events: number; /** * specifies the minicalendar object */ minicalendar: any; /** * sets the format for the header of the Month view */ month_date: string; /** * sets the format for the day in a cell of the Month and Year views */ month_day: string; /** * sets the minimum height of cells in the Month view */ month_day_min_height: number; /** * enables rendering of multi-day events */ multi_day: boolean; /** * sets the height of the area that displays multi-day events */ multi_day_height_limit: any; /** * allows working with recurring events independently of time zones */ occurrence_timestamp_in_utc: boolean; /** * defines the 'saving' behaviour for the case when the user edits the event text directly in the event box */ positive_closing: boolean; /** * fixes dnd in case of non-linear time scale */ preserve_length: boolean; /** * cancels preserving of the current scroll position while navigating between dates of the same view */ preserve_scroll: boolean; /** * enables/disables caching of GET requests in the browser */ prevent_cache: boolean; /** * defines whether the event form will appear from the left/right side of the screen or near the selected event */ quick_info_detached: boolean; /** * activates the read-only mode for the scheduler */ readonly: boolean; /** * activates the read-only mode for the lightbox */ readonly_form: boolean; /** * sets the date format of the 'End by' field in the 'recurring' lighbox */ repeat_date: string; /** * prevents including past days to events with the 'weekly' recurrence */ repeat_precise: boolean; /** * sets the initial position of the vertical scroll in the scheduler (an hour in the 24h format) */ scroll_hour: number; /** * shows/hides the select bar in the event box */ select: boolean; /** * allows preventing short events from overlapping */ separate_short_events: boolean; /** * enables converting server-side dates from UTC to a local time zone (and backward) during sending data to the server */ server_utc: boolean; /** * enables showing a progress/spinner while data is loading (useful for dynamic loading) */ show_loading: boolean; /** * sets the start day of weeks */ start_on_monday: boolean; /** * sets the minimum step (in minutes) for event's time values */ time_step: number; /** * enables/disables the touch support in the scheduler */ touch: any; /** * defines the time period in milliseconds that is used to differ the long touch gesture from the scroll gesture */ touch_drag: any; /** * enables/disables prompting messages in the right up corner of the screen */ touch_tip: boolean; /** * 'says' events to occupy the whole width of the cell */ use_select_menu_space: boolean; /** * sets the format for the date in the sub-header of the Month view */ week_date: string; /** * enables/disables displaying the standard (wide) lightbox instead of the short one */ wide_form: boolean; /** * sets the date format that is used to parse data from the data set */ xml_date: string; /** * sets the number of rows in the Year view */ year_x: number; /** * sets the number of columns in the Year view */ year_y: number; } interface SchedulerDateHelpers{ add(origin: Date, count: number, unit: string): Date; copy(origin: Date): Date; date_part(origin: Date): Date; time_part(origin: Date): Date; day_start(origin: Date): Date; month_start(origin: Date): Date; week_start(origin: Date): Date; year_start(origin: Date): Date; getISOWeek(origin: Date): number; getUTCISOWeek(origin: Date): number; date_to_str(format: string): any; str_to_date(format: string): any; convert_to_utc(origin: Date): Date; to_fixed(value: number): string; } interface SchedulerHotkeys{ edit_save: number; edit_cancel: number; } //scheduler.locale interface SchedulerLocaleDate{ month_full: string[]; month_short: string[]; day_full: string[]; day_short: string[]; } interface SchedulerLocaleLabels{ dhx_cal_today_button: string; day_tab: string; week_tab: string; month_tab: string; new_event: string; icon_save: string; icon_cancel: string; icon_details: string; icon_edit: string; icon_delete: string; confirm_closing: string; confirm_deleting: string; section_description: string; section_time: string; } interface SchedulerLocale{ date: SchedulerLocaleDate; labels: SchedulerLocaleLabels; } interface SchedulerSizes{ /** * the height of day cells in the month view */ bar_height: number; /** * the width of the event text input 140 day */ editor_width: number; /** * increases the length of the lightbox */ lightbox_additional_height: number; /** * the width of the date column in the Map view */ map_date_width: number; /** * the width of the description column in the Map view */ map_description_width: number; /** * the left margin of the main scheduler area */ margin_left: number; /** * the bottom margin of the main scheduler area */ margin_top: number; /** * the width of the selection menu */ menu_width: number; /** * the minimal height of the event box */ min_event_height: number; /** * the top offset of an event in a cell in the month view */ month_scale_height: number; /** * the height of the navigation bar */ nav_height: number; /** * the height of the X-Axis */ scale_height: number; /** * the width of the Y-Axis */ scale_width: number; /** * the width of the scrollbar area */ scroll_width: number; } interface SchedulerStatic{ templates: SchedulerTemplates; config: SchedulerConfigOptions; date: SchedulerDateHelpers; keys: SchedulerHotkeys; skin: String; version: String; xy: SchedulerSizes; locale: SchedulerLocale; /** * adds a new event * @param event the event object */ addEvent(event: any): string; /** * adds a new event and opens the lightbox to confirm * @param event the event object */ addEventNow(event: any): string; /** * marks dates but with certain settings makes blocking (unlike blockTime() allows setting custom styling for the limit) * @param config the configuration object of the timespan to mark/block */ addMarkedTimespan(config: any); /** * adds a section to the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) * @param section the object of the section to add * @param parent_id the id of the parent section. Pass 'null' if you are adding a section to the root */ addSection(section: any, parent_id: string): boolean; /** * attaches the handler to an inner event of dhtmlxScheduler * @param name the event name, case-insensitive * @param handler the handler function */ attachEvent(name: string, handler: (...args: any[])=>any): string; /** * makes the scheduler reflect all data changes in the Backbone model and vice versa * @param events the Backbone data collection */ backbone(events: any); /** * blocks the specified date and applies the default 'dimmed' style to it. * @param date a date to block ( if a number is provided, the parameter will be treated as a week day: '0' index refers to Sunday, '6' - to Saturday) * @param time_points an array [start_minute,end_minute,..,start_minute_N,end_minute_N] where each pair sets a certain limit range. The array can have any number of such pairs * @param items defines specific items of view(s) to block */ blockTime(date: any, time_points: any, items?: any); /** * calls an inner event * @param name the event name, case-insensitive * @param params an array of the event related data */ callEvent(name: string, params: any): boolean; /** * changes the event id * @param id the current event id * @param new_id the new event id */ changeEventId(id: string, new_id: string); /** * checks whether the specified event occurs at the time that has been already occupied with another event(s) * @param event the event object */ checkCollision(event: any): boolean; /** * checks whether an event has some handler(s) specified * @param name the event name */ checkEvent(name: string): boolean; /** * checks whether an event resides in a specific timespan * @param event the event object * @param timespan the timespan type */ checkInMarkedTimespan(event: any, timespan: string): boolean; /** * checks whether the specified event takes place at the blocked time period * @param event the event object */ checkLimitViolation(event: any): boolean; /** * removes all events from the scheduler */ clearAll(); /** * closes all sections in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) */ closeAllSections(); /** * closes the specified section in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) * @param section_id the section id */ closeSection(section_id: string); /** * collapses the expanded scheduler back to the normal size */ collapse(); /** * creates the Grid view in the scheduler * @param config the configuration object of the Grid view */ createGridView(config: any); /** * creates the Timeline view in the scheduler * @param config the configuration object of the Timeline view */ createTimelineView(config: any); /** * creates the Units view in the scheduler * @param config the configuration object of the Units view */ createUnitsView(config: any); /** * deletes all sections from the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) */ deleteAllSections(); /** * deletes the specified event * @param id the event id */ deleteEvent(id: any); /** * removes marking/blocking set by the addMarkedTimespan() and blockTime() methods * @param id the timespan id */ deleteMarkedTimespan(id: string); /** * deletes a section from the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) * @param section_id the section id */ deleteSection(section_id: string): boolean; /** * destroys previously created mini-calendar * @param name the mini-calendar's object (if not specified, the scheduler attempts to destroy the last created mini calendar) */ destroyCalendar(name?: any); /** * detaches a handler from an event (which was attached before by the attachEvent method) * @param id the event id */ detachEvent(id: string); /** * opens the inline editor to alter the event text (the editor in the event box) * @param id the event id */ edit(id: string); /** * closes the inline event edotor if it's currently open * @param id the event id */ editStop(id: string); /** * closes the lightbox * @param mode if set to true, the changes made in the lightbox will be saved before closing. If - false, the changes will be cancelled. * @param box the HTML container for the lightbox */ endLightbox(mode: boolean, box: HTMLElement); /** * expands the scheduler to the full screen view */ expand(); /** * gives access to the objects of lightbox's sections * @param name the name of a lightbox section */ formSection(name: string): any; /** * returns the current cursor-pointed date and section (if defined) * @param e a native event object */ getActionData(e: Event): any; /** * return the event object by its id * @param event_id event_id */ getEvent(event_id: any); /** * gets the event's end date * @param id the event id */ getEventEndDate(id: string): Date; /** * gets the event's start date * @param id the event id */ getEventStartDate(id: string): Date; /** * gets the event's text * @param id the event id */ getEventText(id: string): string; /** * returns a collection of events which occur during the specified period * @param from the start date of the period * @param to the end date of the period */ getEvents(from?: Date, to?: Date); /** * gets the label of a select control in the lighbox * @param property the name of a data property that the control is mapped to * @param key the option id. This parameter is compared with the event data property to assign the select's option to an event */ getLabel(property: string, key: any); /** * gets the lightbox's HTML object element */ getLightbox(): HTMLElement; /** * returns all occurrences of a recurring event * @param id the id of a recurring event * @param number the maximum number of occurrences to return (by default, 100) */ getRecDates(id: string, number: number): any; /** * gets the object of the currently displayable event * @param id the event id */ getRenderedEvent(id: string): HTMLElement; /** * gets the object of the specified section in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) * @param section_id the section id */ getSection(section_id: string): any; /** * gets the current state of the scheduler */ getState(): any; /** * gets the user data associated with the specified event * @param id the event id * @param name the user data name */ getUserData(id: string, name: string): any; /** * hides the lightbox modal overlay that blocks interactions with the remaining screen * @param box an element to hide */ hideCover(box?: HTMLElement); /** * hides the pop-up event form (if it's currently active) */ hideQuickInfo(); /** * initializes an instance of dhtmlxScheduler * @param container the id or object of the HTML container that the scheduler will be created inside * @param date the initial date of the scheduler (by default, the current date) * @param view the name of the initial view (by default, "week") */ init(container: any, date?: Date, view?: string); /** * inverts the specified time zones * @param zones an array [start_minute,end_minute,..,start_minute_N,end_minute_N] where each pair sets a certain limit range (in minutes). The array can have any number of such pairs */ invertZones(zones: any); /** * checks whether the calendar is currently open in the scheduler */ isCalendarVisible(): any; /** * checks whether the specified event one-day or multi-day * @param event the event object */ isOneDayEvent(event: any): boolean; /** * 'says' to change the active date in the mini calendar each time the active date in the scheduler is changed * @param calendar the mini calendar object * @param shift a function that defines the difference between active dates in the mini-calendar and the scheduler. The function takes the scheduler's date as a parameter and returns the date that should be displayed in the mini calendar */ linkCalendar(calendar: any, shift: (...args: any[])=>any); /** * loads data to the scheduler from an external data source * @param url the server side url (may be a static file or a server side script which outputs data as XML) * @param type ('json', 'xml', 'ical') the data type. The default value - 'xml' * @param callback the callback function */ load(url: string, type?: string, callback?: (...args: any[])=>any); /** * applies a css class to the specified date * @param calendar the calendar object * @param date the date to mark * @param css the name of a css class */ markCalendar(calendar: any, date: Date, css: string); /** * 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); /** * opens all sections in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) */ openAllSections(); /** * opens the specified section in the currently active view (if the opened view isn't Timeline in the 'Tree' mode - the method will be ignored) * @param section_id the section id */ openSection(section_id: string); /** * loads data from a client-side resource * @param data a string or object which represents data * @param type ('json', 'xml', 'ical') the data type. The default value - 'xml' */ parse(data: any, type?: string); /** * creates a mini calendar * @param config the calendar configuration object */ renderCalendar(config: any); /** * generates the HTML content for a custom event box * @param container the event container * @param event the event object */ renderEvent(container: HTMLElement, event: any): boolean; /** * removes the current lightbox's HTML object element */ resetLightbox(); /** * scrolls the specified number of units in the Units view * @param step the number of units to scroll (set the positive value to scroll units in the right direction, the negative value - in the left direction). */ scrollUnit(step: number); /** * selects the specified event * @param id the event id */ select(id: string); /** * returns a list of options * @param list_name the name of a list * @param options an array of options */ serverList(list_name: string, options?: any); /** * displays the specified view and date * @param date the date to display * @param view the name of a view to display */ setCurrentView(date?: Date, view?: string); /** * adds a new event to the scheduler's data pool * @param id the event id * @param event the event object */ setEvent(id: any, event: any); /** * sets the event's end date * @param id the event id * @param date the new end date of the event */ setEventEndDate(id: string, date: Date); /** * set the event's start date * @param id the event id * @param date the new start date of the event */ setEventStartDate(id: string, date: Date); /** * set the event's text * @param id the event id * @param text the new text of the event */ setEventText(id: string, text: string); /** * forces the lightbox to resize */ setLightboxSize(); /** * sets the mode that allows loading data by parts (enables the dynamic loading) * @param mode the loading mode */ setLoadMode(mode: string); /** * sets the user data associated with the specified event * @param id the event id * @param name the user data name * @param value the user data value */ setUserData(id: string, name: string, value: any); /** * shows the lightbox modal overlay that blocks interactions with the remaining screen * @param box an element to hide */ showCover(box?: HTMLElement); /** * shows and highlights the specified event in the current or specified view * @param id the event id * @param view the view name */ showEvent(id: string, view?: string); /** * opens the lightbox for the specified event * @param id the event id */ showLightbox(id: string); /** * displays the pop-up event form for the specified event * @param id the event id */ showQuickInfo(id: string); /** * shows a custom lightbox in the specified HTML container centered on the screen * @param id the event id * @param box the lightbox's HTML container */ startLightbox(id : string, box: HTMLElement); /** * convers scheduler's data to the ICal format * @param header sets the value for the content header field */ toICal(header?: string): string; /** * converts scheduler's data into the JSON format */ toJSON(): string; /** * exports the current view to a PDF document (can be used for printing) * @param url the path to the server-side PDF converter * @param mode the color map of the resulting PDF document */ toPDF(url: string, mode?: string); /** * exports several scheduler's views to a PDF document (can be used for printing) * @param from the date to start export events from * @param to the date to export events until * @param view the name of a view that the export should be applied to * @param path the path to the php file which generates a PDF file (details) * @param color the color map in use */ toPDFRange(from: Date, to: Date, view: string, path: string, color: string); /** * converts scheduler's data into the XML format */ toXML(): string; /** * generates an unique ID (unique inside the current scheduler, not GUID) */ uid(); /** * removes blocking set by the blockTime() method * @param days (Date, number,array, string) days that should be limited * @param zones the period in minutes that should be limited. Can be set to 'fullday' value to limit the entire day * @param sections allows blocking date(s) just for specific items of specific views. BTW, the specified date(s) will be blocked just in the related view(s) */ unblockTime(days: any, zones?: any, sections?: any); /** * removes a css class from the specified date * @param calendar the mini calendar object * @param date the date to unmark * @param css the name of a css class to remove */ unmarkCalendar(calendar: any, date: Date, css: string); /** * removes marking/blocking set by the markTimespan() method * @param divs a timespan to remove marking/blocking from (or an array of timespans) */ unmarkTimespan(divs: any); /** * unselects the specified event * @param id the event id (if not specified, the currently selected event will be unselected) */ unselect(id?: string); /** * displays the specified date in the mini calendar * @param calendar the mini calendar object * @param new_date a new date to display in the mini calendar */ updateCalendar(calendar: any, new_date: Date); /** * updates tht specified collection with new options * @param collection the name of the collection to update * @param options the new values of the collection */ updateCollection(collection: string, options: any): boolean; /** * updates the specified event * @param id the event id */ updateEvent(id: string); /** * displays the specified view and date (doesn't invokes any events) * @param date the date to set * @param view the view name */ updateView(date: Date, view: string); } declare var scheduler: SchedulerStatic;