smart-webcomponents-angular

import {BaseElement, Animation} from "./smart.element" export interface SchedulerProperties { /** * Determines the scroll speed while dragging an event. * Default value: 30 */ autoScrollStep?: number; /** * Determines whether the all day cells in Day and Week views automatically change their height depending on the events count in these cells. * Default value: false */ autoHeightAllDayCells?: boolean; /** * Defines an array of objects with start and end fields, where start and end are Date objects. For example: [{ 'start': '2022-10-25T12:00.000Z', 'end': '2022-10-25T13:00.000Z' }]. * Default value: */ available?: any; /** * Determines the color scheme for the event background selector in the event window editor. * Default value: #D50000,#E67C73,#F4511E,#F6BF26,#33B679,#0B8043,#039BE5,#3F51B5,#7986CB,#8E24AA,#616161, */ colorScheme?: string[]; /** * Determines the current time of the Scheduler to use for the current time indicator functionality. By default the current time is Today. * Default value: new Date() */ currentTime?: string | Date; /** * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells. * Default value: false */ currentTimeIndicator?: boolean; /** * Determines the refresh interval in seconds for the currentTimeIndicator. * Default value: 1 */ currentTimeIndicatorInterval?: number; /** * Determines the context menu items that are visible when the Context Menu is opened. * Default value: null */ contextMenuDataSource?: any[]; /** * Determines whether the clipboard shortcuts for copy/paste/cut action of events are visible in the Scheduler context menu or not. * Default value: false */ contextMenuClipboardActions?: boolean; /** * Allows to customize the content of the event elements. It can be an HTMLTemplateElement that will be applied to all events or it's id as a string or a function that will be called for each event with the following parameters: eventContent - the content holder for the event,eventObj - the event object.. When using an HTMLTemplateElement it's possible to add property bindings inside the template that will be mapped to the corresponding object properties. * Default value: null */ eventTemplate?: any; /** * Allows to customize the content of the event collector elements. It can be an HTMLTemplateElement that will be applied to all events or it's id as a string or a function that will be called for each event with the following parameters: eventContent - the content holder for the event,eventObj - the event object.. When using an HTMLTemplateElement it's possible to add property bindings inside the template that will be mapped to the corresponding object properties. * Default value: null */ eventCollectorTemplate?: any; /** * Determines how the events inside the Scheduler are rendered.classic - the events are arranged next to each other and try to fit inside the cells.modern - the events obey the CSS property that determines their size and if there's not enough space inside the cell for all events to appear, an event collector is created to hold the rest of the events. On mobile phones only collectors are created. * Default value: modern */ eventRenderMode?: SchedulerEventRenderMode | string; /** * Allows to customize the content of the event menu items (tooltip). When clicked on an event element an event menu with details opens. It can be an HTMLTemplateElement that will be applied to all events or it's id as a string or a function that will be called for each event with the following parameters: eventContent - the content holder for the event,eventObj - the event object.. When using an HTMLTemplateElement it's possible to add property bindings inside the template that will be mapped to the corresponding object properties. * Default value: null */ eventTooltipTemplate?: any; /** * Allows to customize the content of the timeline cells. It can be an HTMLTemplateElement that will be applied to all cells or it's id as a string or a function that will be called for each cell with the following parameters: cellContent - the content holder for the cell,cellDate - the cell date.. When using an HTMLTemplateElement it's possible to add property bindings inside the template that will be mapped to the value of the cell. * Default value: null */ cellTemplate?: any; /** * Determines the currently visible date for the Scheduler. * Default value: new Date() */ dateCurrent?: string | Date; /** * Sets the Schedulers's Data Export options. * Default value: [object Object] */ dataExport?: SchedulerDataExport; /** * Determines the events that will be loaded inside the Timeline. Each event represents an object that should contain the following properties: * Default value: */ dataSource?: SchedulerEvent[]; /** * A callback that can be used to customize the text inside the date selector located in the header. The callback has one parameter - the current date. * Default value: null */ dateSelectorFormatFunction?: any; /** * Determines the day format of the dates in the timeline. * Default value: short */ dayFormat?: SchedulerDayFormat | string; /** * Enables or disables the element. * Default value: false */ disabled?: boolean; /** * Disables auto scrolling of the timeline while dragging/resizing an event. * Default value: false */ disableAutoScroll?: boolean; /** * Disables dragging of events. * Default value: false */ disableDrag?: boolean; /** * Disables dropping of events. * Default value: false */ disableDrop?: boolean; /** * Disables resizing of events. * Default value: false */ disableResize?: boolean; /** * Disables the cell selection. * Default value: false */ disableSelection?: boolean; /** * Disables the window editor for the events. * Default value: false */ disableWindowEditor?: boolean; /** * Disables the context menu of the events and cells. * Default value: false */ disableContextMenu?: boolean; /** * Disables the event menu that appears when an event/collector has been clicked. * Default value: false */ disableEventMenu?: boolean; /** * Disables the view menu that allows to select the current Scheduler view. * Default value: false */ disableViewMenu?: boolean; /** * Disables the date menu that allows to select the current Scheduler date. * Default value: false */ disableDateMenu?: boolean; /** * A callback that can be used to customize the drag feedback that appears when an event is dragged. * Default value: null */ dragFeedbackFormatFunction?: any; /** * Determines the offset for the drag feedback from the pointer. * Default value: 10,10 */ dragOffset?: any; /** * Determines the filtering condition for the events.The filter property takes an array of objects or a function. Each object represents a single filtering condition with the following attributes: name - the name of the Scheduler event property that will be filtered by.value - the filtering condition value. The value will be used to compare the events based on the filterMode, for example: [{ name: 'price', value: 25 }]. The value can also be a function. The function accepts a single arguemnt - the value that corresponds to the filtered attribute. The function allows to apply custom condition that is different from the default filter modes. It should return true ( if the evnet passes the filtering condition ) or false ( if the event does not meet the filtering condition ). Here's an example: [{ name: 'roomId', value: (id) => ['2', '3'].indexOf(id + '') > -1 }]. In the example the events that do not have a 'roomId' property that is equal to '2' or '3' will be filtered out.. If a function is set to the filter property instead, it allows to completely customize the filtering logic. The function passes a single argument - each Scheduler event that will be displayed. The function should return true ( if the condition is met ) or false ( if not ). * Default value: (eventObj) => return eventObj.label === 'TargetLabel',[{ name: 'roomId', value: (id) => ['2', '3'].indexOf(id + '') > -1 }] */ filter?: any; /** * Determines whether Scheduler's filtering is enabled or not. * Default value: true,false */ filterable?: any; /** * Determines the filter mode. * Default value: equals */ filterMode?: FilterMode | string; /** * A getter that returns an array of all Scheduler events. * Default value: */ events?: SchedulerEvent[]; /** * Determines the first day of week for the Scheduler. By default it's Sunday. * Default value: 0 */ firstDayOfWeek?: number; /** * Allows to customize the footer of the Scheduler. It can be an HTMLTemplateElement, it's id as a string or a function with the following parameters: footerContainer - the footer container.. * Default value: null */ footerTemplate?: any; /** * Determines whether the events will be grouped by date. * Default value: false */ groupByDate?: boolean; /** * Determines the grouping orientation. * Default value: horizontal */ groupOrientation?: SchedulerGroupOrientation | string; /** * Allows to customize the content of the group cells that are visible inside the header. It can be an HTMLTemplateElement that will be applied to all cells or it's id as a string or a function that will be called for each group cell with the following parameters: cellContent - the content holder for the group cell.cellObj - the group cell object.. When using an HTMLTemplateElement it's possible to add property bindings inside the template that will be mapped to the corresponding object properties. * Default value: null */ groupTemplate?: any; /** * Determines the resources that the events are grouped by. * Default value: */ groups?: any; /** * Determines the end hour that will be displayed in 'day' and 'week' views. * Default value: 23 */ hourEnd?: number; /** * Determines the start hour that will be displayed in 'day' and 'week' views. * Default value: 0 */ hourStart?: number; /** * Determines the formatting of hours inside the element. * Default value: numeric */ hourFormat?: SchedulerHourFormat | string; /** * Allows to customize the header of the Scheduler. It can be an HTMLTemplateElement, it's id as a string or a function with the following parameters: headerContent - the header container.. * Default value: null */ headerTemplate?: any; /** * Determines the position of the Date selector inside the Header of the element. * Default value: near */ headerDatePosition?: SchedulerHeaderDatePosition | string; /** * Determines the styling of the Header navigation controls. * Default value: flat */ headerNavigationStyle?: SchedulerHeaderNavigationStyle | string; /** * Determines the position of the view selector control inside the Header of the element. * Default value: far */ headerViewPosition?: SchedulerHeaderViewPosition | string; /** * Determines whether the 'All Day' container with the all day events is hidden or not. * Default value: false */ hideAllDay?: boolean; /** * Determines whether the days set by 'nonworkingDays' property are hidden or not. * Default value: false */ hideNonworkingWeekdays?: boolean; /** * Determines whether other month days are visible when view is set to month. When enabled, events that start on other month days are not displayed and the cells that represent such days do not allow the creation of new events on them. Also dragging and droping an event on other month days is not allowed. Reszing is also affected. Events can end on other month days, but cannot start on one. * Default value: false */ hideOtherMonthDays?: boolean; /** * Determines whether the 'Today' button is hidden or not. * Default value: false */ hideTodayButton?: boolean; /** * Determines whether the checkable items in the view selection menu are hidden or not. * Default value: false */ hideViewMenuCheckableItems?: boolean; /** * Determines whether the weekend days are hidden or not. * Default value: false */ hideWeekend?: boolean; /** * Determines the location of the legend inside the Scheduler. By default the location is inside the footer but it can also reside in the header. * Default value: footer */ legendLocation?: SchedulerLegendLocation | string; /** * Determines the position of the legend. By default it's positioned to the near side but setting it to 'far' will change that. * Default value: near */ legendPosition?: SchedulerLegendPosition | string; /** * Determines the layout of the legend items. * Default value: auto */ legendLayout?: SchedulerLegendLayout | string; /** * Determines the number of items when the legend switches automatically from horizontal list to menu. * Default value: 10 */ legendLayoutMenuBreakpoint?: number; /** * Determines the mouse wheel step. When this property is set to a positive number, the scroll step with mouse wheel or trackpad will depend on the property value. * Default value: 50 */ mouseWheelStep?: number; /** * Determines weather or not horizontal scrollbar is shown. * Default value: auto */ horizontalScrollBarVisibility?: HorizontalScrollBarVisibility | string; /** * Sets or gets the unlockKey which unlocks the product. * Default value: "" */ unlockKey?: string; /** * Determines the language of the Scheduler. * Default value: "en" */ locale?: string; /** * Detetmines the maximum view date for the Scheduler. * Default value: 2100-1-1 */ max?: string | Date; /** * Detetmines the maximum number of events per Scheduler cell. By default this property is null which means that the number of events per cell is automatically determined by the size of the events. * Default value: null */ maxEventsPerCell?: number | null; /** * Detetmines the minimum view date for the Scheduler. * Default value: 1900-1-1 */ min?: string | Date; /** * Sets or gets an object specifying strings used in the element that can be localized. Used in conjunction with the property locale. * Default value: * [object Object] */ messages?: any; /** * Determines the minute formatting inside the Scheduler. * Default value: 2-digit */ minuteFormat?: MinuteFormat | string; /** * Determines the month name formatting inside the Scheduler. * Default value: long */ monthFormat?: MonthFormat | string; /** * Determines the nonworking days of the week from 0 to 6, where 0 is the first day of the week and 6 is the last day. Nonworking days will be colored differently inside the Timeline. The color is determined by a CSS variable. * Default value: */ nonworkingDays?: any; /** * Determines the nonworking hours of the day. Hours are represented as numbers inside an array, however ranges of hours can be defined as an array with starting and ending hour separated by a comma. In the timline the cells that represent nonworking days are colored differently from the rest. * Default value: */ nonworkingHours?: any; /** * Determines the interval (in seconds) at which the element will check for notifications. * Default value: 60 */ notificationInterval?: number; /** * Determines the visibility of the resize handles. * Default value: auto */ resizeHandlesVisibility?: ResizeHandlesVisibility | string; /** * Determines the rate at which the element will refresh it's content on element resize. By default it's refresh immediately. This property is used for element resize throttling * Default value: 0 */ resizeInterval?: number; /** * An array of resources that can be assigned to the events. * Default value: */ resources?: SchedulerResource[]; /** * Defines an array of dates that are not allowed to have events on. Events that overlap restricted Dates or start/end on them will not be displayed. * Default value: */ restrictedDates?: any; /** * Defines an array of hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. * Default value: */ restrictedHours?: any; /** * Defines an array of dates and hours that are not allowed to have events on. Events that overlap restricted Hours or start/end on them will not be displayed. Each array item is an Object and requires 2 fields - date and hours. For example: { date: new Date(2023, 10, 1), hours: [[0, 6], 12, [20, 23]] }. The hours define a range of restricted hours similartly to the restricted hours property, the date defines a date where the restricted hours will be applied. * Default value: */ restricted?: any; /** * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. * Default value: false */ rightToLeft?: boolean; /** * Determines the position of the date navigation navigation buttons inside the header of the element. * Default value: near */ scrollButtonsPosition?: SchedulerScrollButtonsPosition | string; /** * Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded. * Default value: false */ shadeUntilCurrentTime?: boolean; /** * Determines whether the resource legend is visible or not. The Legend shows the resources and their items in the footer section of the Scheduler. If filterable is enabled it is possible to filter by resource items by clicking on the corresponding resource item from the legend. * Default value: false */ showLegend?: boolean; /** * Determines the name of the resource data item property that will be used for sorting the resource data defined as the resource.dataSource. * Default value: "null" */ sortBy?: string; /** * Allows to define a custom sorting function that will be used to sort the resource data. The sortFunction is used when sortOrder is set to custom. * Default value: null */ sortFunction?: any; /** * Determines the sorting order of the resource data items. When set to custom, a custom sorting function has to be defined for the sortFunction property. The asc stands for 'ascending' while desc means 'descending' sorting order. * Default value: asc */ sortOrder?: SchedulerSortOrder | string; /** * Determines the repeating delay of the repeat buttons inside the header of the element. Such buttons are the Date navigation buttons and the view scroll buttons. * Default value: 80 */ spinButtonsDelay?: number; /** * Determines the initial delay of the repeat buttons inside the header of the element. Such buttons are the Date navigation buttons and the view scroll buttons. * Default value: 0 */ spinButtonsInitialDelay?: number; /** * Defines the statuses that will be available for selection thourgh the window editor for the events. * Default value: [{"label":"None"},{"label":"Free","value":"free"},{"label":"Tentative","value":"tentative"},{"label":"Busy","value":"busy"},{"label":"Out of Office","value":"outOfOffice"}] */ statuses?: SchedulerStatuse[]; /** * Sets or gets the element's visual theme. * Default value: "" */ theme?: string; /** * A format function for the Header of the Timeline. Allows to modify the date labels in the header cells. * Default value: null */ timelineHeaderFormatFunction?: any; /** * Determines the date scale for the timeline cells. * Default value: hour */ timelineDayScale?: SchedulerTimelineDayScale | string; /** * Enables/Disables the tick marks next to the time cells in the vertical header of the element. Time header appears in 'day' and 'week' views. * Default value: false */ timeRulerTicks?: boolean; /** * Determines the timeZone for the element. By default if the local time zone is used if the property is not set. * Default value: Local */ timeZone?: SchedulerTimeZone | string; /** * Allows to display additional timeZones at once along with the default that is set via the timeZone property. Accepts an array values that represent the ids of valid time zones. The possbile time zones can be viewed in the timeZone property description. By default the local time zone is displayed. * Default value: */ timeZones?: any; /** * Determines the delay ( in miliseconds) before the tooltip/menu appears. * Default value: 0 */ tooltipDelay?: number; /** * Determines the offset ot the tooltip/menu. * Default value: */ tooltipOffset?: number[]; /** * Determines weather or not vertical scrollbar is shown. * Default value: auto */ verticalScrollBarVisibility?: VerticalScrollBarVisibility | string; /** * Determines the current view. The property accepts view values that are defined in the views property. Custom views should contain a valid value that will be set as the current view. * Default value: "day" */ view?: string; /** * Indicates the current Scheduler viewType. Custom views must contain a valid type property that corresponds to one of the view types. This property should not be set. * Default value: day */ viewType?: SchedulerViewType | string; /** * Determines the viewing date range of the timeline. The property should be set to an array of strings or view objects. When you set it to a string, you should use any of the following: 'day', 'week', 'month', 'agenda', 'timelineDay', 'timelineWeek', 'timelineMonth'. Custom views can be defined as objects instead of strings. The view object should contain the following properties: label - the label for the view.value - the value for the view. The value is the unique identifier for the view.type - the type of view. The type should be one of the default allowed values for a view.hideWeekend - an Optional property that allows to hide the weekend only for this specific view.hideNonworkingWeekdays - an Optional property that allows to hide the nonwrking weekdays for this specific view.shortcutKey - an Optional property that allows to set a custom shortcut key for the view.hideHours - an Optional property applicable only to timelineWeek view that allows to hide the hour cells and only show the day cells. * Default value: day,week,month */ views?: SchedulerViews | string; /** * Determines type of the view selector located in the header of the element. * Default value: menu */ viewSelectorType?: SchedulerViewSelectorType | string; /** * Determines the Start Date rule. The Week and TimelineWeek views start by default from the current date taking into account the firstDayOfWeek property. When this property is set to 'dateCurrent', these views will start from the value of the 'dateCurrent'. * Default value: firstDayOfWeek */ viewStartDay?: SchedulerViewStartDay | string; /** * Determines the format of the week days inside the element. * Default value: short */ weekdayFormat?: WeekDayFormat | string; /** * Determines the format of the dates inside the timeline header when they represent years. * Default value: numeric */ yearFormat?: YearFormat | string; /** * Sets or gets if the element can be focused. * Default value: false */ unfocusable?: boolean; /** * Determines the maximum number of redo/undo steps that will be remembered by the Scheduler. When the number is reached the oldest records are removed in order to add new. * Default value: 100 */ undoRedoSteps?: number; /** * A function that can be used to completly customize the popup Window that is used to edit events. The function has the following arguments: target - the target popup Window that is about to be opened.type - the type of the window. The type determines the purpose of the window. The default type is an empty string which means that it's the default event editing window. The other type is 'confirm' ( confirmation window) that appears when clicking on a repeating event. eventObj - the event object that is going to be edited. * Default value: null */ windowCustomizationFunction?: any; } /** Scheduler displays a set ot Events in Day, Week, Month, Agenda, Timeline Day, Timeline Week, Timeline Month views. */ export interface Scheduler extends BaseElement, SchedulerProperties { /* Get a member by its name */ [name: string]: any; /** * This event is triggered when a batch update was started after executing the beginUpdate method. * @param event. The custom event. */ onBeginUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a batch update was ended from after executing the endUpdate method. * @param event. The custom event. */ onEndUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a new cell is selected/unselected. * @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue) * value - The new selected Date. * oldValue - The previously selected Date. */ onChange: ((this: any, ev: Event) => any) | null; /** * This event is triggered when an Event has been updated/inserted/removed/dragged/resized or an exception of a repeating event has been added/updated/removed. * @param event. The custom event. Custom data event was created with: ev.detail(item, type) * item - An object that represents the actual item with it's attributes. * type - The type of change that is being done to the item. */ onItemChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when an Event is going to be updated/inserted/removed. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(item, type) * item - An object that represents the actual item with it's attributes. * type - The type of change that is going to be made to the item (e.g. 'inserting', 'removing', 'updating', 'exceptionInserting', 'exceptionUpdating', 'exceptionRemoving'). */ onItemChanging?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when en event, event item or a context menu item is clicked. * @param event. The custom event. Custom data event was created with: ev.detail(item, type, itemObj) * item - The HTMLElement for the event. * type - The type of item that is clicked. The possible values are: <ul><li>event - when an event item is clicked.</li><li>context - when a context menu item is clicked.</li></ul>. * itemObj - The event object. */ onItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when an Event is inserted. * @param event. The custom event. Custom data event was created with: ev.detail(item) * item - An object that represents the actual item with it's attributes. */ onItemInsert?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when an Event is removed. * @param event. The custom event. Custom data event was created with: ev.detail(item) * item - An object that represents the actual item with it's attributes. */ onItemRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when an Event is updated. * @param event. The custom event. Custom data event was created with: ev.detail(type, item) * type - The type of item that has been modified. * item - An object that represents the actual item with it's attributes. */ onItemUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the view is changed via user interaction. * @param event. The custom event. Custom data event was created with: ev.detail(oldValue, value) * oldValue - The value of the previously selected view. * value - The value of the new selected view. */ onViewChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered before the view is changed via user interaction. The view change action can be canceled if event.preventDefault() is called on the event. * @param event. The custom event. Custom data event was created with: ev.detail(oldValue, value) * oldValue - The value of the previously selected view. * value - The value of the new selected view. */ onViewChanging?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a shortcut key for an event is pressed. By default only 'Delete' key is used. * @param event. The custom event. Custom data event was created with: ev.detail(key, target, eventObj) * key - The shortcut key that was pressed. * target - The event target (HTMLElement). * eventObj - The scheduler Event object that affected by the keypress. */ onEventShortcutKey?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the 'dateCurrent' property is changed. This can be caused by navigating to a different date. * @param event. The custom event. Custom data event was created with: ev.detail(oldValue, value) * oldValue - The previous current date that was in view. * value - The current date in view. */ onDateChange?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when dragging of an event begins. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, itemDateRange, originalEvent) * target - The HTMLElement that corresponds to the event that is going to be dragged. * item - The scheduler Event object that is going to be dragged. * itemDateRange - The start/end dates for the Scheduler Event. * originalEvent - The original event object. */ onDragStart: ((this: any, ev: Event) => any) | null; /** * This event is triggered when dragging of an event finishes. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, itemDateRange, originalEvent) * target - The HTMLElement that corresponds to the event that is dragged. * item - The scheduler Event object that is dragged. * itemDateRange - The new start/end dates for the dragged Scheduler Event. * originalEvent - The original event object. */ onDragEnd: ((this: any, ev: Event) => any) | null; /** * This event is triggered when the user drops an item over a cell. * @param event. The custom event. Custom data event was created with: ev.detail(target, date, allDay) * target - The HTMLElement that corresponds to the event that is dragged. * date - The cell's date under the pointer. * allDay - Boolean value, which is true when the cell under the pointer is all day cell. */ onDropoverCell?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when resizing of a task starts. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, itemDateRange, originalEvent) * target - The HTMLElement that corresponds to the event that is going to be resized. * item - The scheduler Event object that is going to be resized. * itemDateRange - The start/end dates for Scheduler Event that is going to be resized. * originalEvent - The original event object. */ onResizeStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the resizing of an event finishes. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, itemDateRange, originalEvent) * target - The HTMLElement that corresponds to the event that is resized. * item - The scheduler Event object that is resized. * itemDateRange - The new start/end dates for the resized Scheduler Event. * originalEvent - The original event object. */ onResizeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user starts top open the event dialog window. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, type, eventObj) * target - The dialog window that is opening. * item - The event object that is going to be edited. * type - The type of window that is going to open. Two window types are available, the dafault which is an empty string ( does not have a type) and 'confirm' which is displayed when clicked on a repeating event. * eventObj - The event object that is the target of the menu. */ onEditDialogOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user opens the event dialog window. * @param event. The custom event. Custom data event was created with: ev.detail(target, editors, item, eventObj) * target - The dialog window that is opened. * editors - An object containing all event editors that are present inside the window. This property is undefined when the window is of type 'confirm', because confirm windows do not contain editors. * item - The event object that is being edited. * eventObj - The event object that is the target of the menu. */ onEditDialogOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user closes the event dialog window. * @param event. The custom event. Custom data event was created with: ev.detail(target, editors, item, eventObj) * target - The dialog window that is closed. * editors - An object containing all event editors that are present inside the window. This property is undefined when the window is of type 'confirm', because confirm windows do not contain editors. * item - The event object that is being edited. * eventObj - The event object that is the target of the menu. */ onEditDialogClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user is about to close the event dialog window. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, item, type, eventObj) * target - The dialog window that is closing. * item - The event object that is edited. * type - The type of window that is going to be closed. Two window types are available, the dafault which is an empty string ( does not have a type) and 'confirm' which is displayed when clicked on a repeating event. * eventObj - The event object that is the target of the menu. */ onEditDialogClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user begins to open the context menu on a timeline cell or an event element. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, cellObj, eventObj) * target - The context menu instance. * owner - The HTMLElement that the menu belongs to. * cellObj - The cell object that is the target of the menu. If the target is an event instead of a cell this parameter will be undefined. * eventObj - The event object that is the target of the menu. If the target is a cell instead of an event this paramter will be undefined. */ onContextMenuOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the context menu is opened. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, cellObj, eventObj) * target - The context menu instance. * owner - The HTMLElement that the menu belongs to. * cellObj - The cell object that is the target of the menu. If the target is an event instead of a cell this parameter will be undefined. * eventObj - The event object that is the target of the menu. If the target is a cell instead of an event this paramter will be undefined. */ onContextMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the context menu is closed. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, cellObj, eventObj) * target - The context menu instance. * owner - The HTMLElement that the menu belongs to. * cellObj - The cell object that is the target of the menu. If the target is an event instead of a cell this parameter will be undefined. * eventObj - The event object that is the target of the menu. If the target is a cell instead of an event this paramter will be undefined. */ onContextMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user is about to close the context menu. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, cellObj, eventObj) * target - The context menu instance. * owner - The HTMLElement that the menu belongs to. * cellObj - The cell object that is the target of the menu. If the target is an event instead of a cell this parameter will be undefined. * eventObj - The event object that is the target of the menu. If the target is a cell instead of an event this paramter will be undefined. */ onContextMenuClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the event menu is about to open. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, eventObj) * target - The menu instance. * owner - The HTMLElement of the event that the menu belongs to. * eventObj - The event object that is the target of the menu. */ onEventMenuOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the event menu is opened. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, eventObj) * target - The menu instance. * owner - The HTMLElement of the event that the menu belongs to. * eventObj - The event object that is the target of the menu. */ onEventMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the event menu is closed. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, eventObj) * target - The menu instance. * owner - The HTMLElement of the event that the menu belongs to. * eventObj - The event object that is the target of the menu. */ onEventMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the evet menu is about to close. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(target, owner, eventObj) * target - The menu instance. * owner - The HTMLElement of the event that the menu belongs to. * eventObj - The event object that is the target of the menu. */ onEventMenuClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the date selection menu is opened. * @param event. The custom event. Custom data event was created with: ev.detail(target) * target - The menu instance. */ onDateMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the date selection menu is closed. * @param event. The custom event. Custom data event was created with: ev.detail(target) * target - The menu instance. */ onDateMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the view selection menu is opened. * @param event. The custom event. Custom data event was created with: ev.detail(target) * target - The menu instance. */ onViewMenuOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the view selection menu is closed. * @param event. The custom event. Custom data event was created with: ev.detail(target) * target - The menu instance. */ onViewMenuClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a notification is opened. * @param event. The custom event. Custom data event was created with: ev.detail(instance) * instance - The toast item instance that is opened. */ onNotificationOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a notification is closed. * @param event. The custom event. Custom data event was created with: ev.detail(instance) * instance - The toast item instance that is closed. */ onNotificationClose?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * Adds an event to the Scheduler. Accepts an event object of the following format (same as the dataSource format): <pre>{ label?: string, dateStart: date, dateEnd: date, description?: string, id?: string | number, class?: string, backgroundColor?: string, color?: string, notifications?: { interval: numeric, type?: string, time: number[] }[], allDay?: boolean, disableDrag?: boolean, disableResize?: boolean, repeat?: { repeatFreq: string, repeatInterval: number, repeatOn?: number | number[] | date, repeatEnd?: number | date, exceptions?: { date: date, dateStart?: date, dateEnd?: date, hidden?: boolean, backgroundColor?: string, status?: string, label?: string, description?: string, notifications?: { interval: numeric, type?: string, time: number[] }[], disableDrag?: boolean, disableResize?: boolean }[] }, status?: string }</pre> * @param {any} eventObj. An object describing a Scheduler event that is not already present in the element. */ addEvent(eventObj: any): void; /** * Adds a new view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView'); * @param {string} type. The view type. * @param {string} label. The view's label displayed in the header. * @param {string} value. The view's value used to identify the view. * @param {boolean} hideWeekend. Determines whether to hide the weekend. * @param {boolean} hideNonworkingWeekdays. Determines whether to hide the non working days. * @param {number} additionalDays. Determines whether to add additional days to the view. */ addView(type: string, label: string, value: string, hideWeekend: boolean, hideNonworkingWeekdays: boolean, additionalDays: number): void; /** * Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once. */ beginUpdate(): void; /** * Creates an event and adds it to the Scheduler. * @param {string} label. Event label. * @param {string} value. Event value. * @param {string} dateStart. Event date start. * @param {string} dateEnd. Event date end. * @param {boolean} allDay. Event all day. Set it to true to create all day event. */ createEvent(label: string, value: string, dateStart: string, dateEnd: string, allDay: boolean): void; /** * Ends the update operation. This method will resume the rendering and will refresh the element. */ endUpdate(): void; /** * Returns an array of the start and end view dates. * @returns {Date[]} */ getViewDates(): Date[]; /** * Refereshes the Scheduler by recalculating the Scrollbars. * @param {boolean} fullRefresh?. If set the Scheduler will be re-rendered completely. */ refresh(fullRefresh?: boolean): void; /** * Exports the events from the Scheduler. * @param {string} dataFormat. Determines the format of the exported file. The following values are available: <ul><li>pdf</li><li>xlsx</li><li>html</li><li>iCal</li></ul> * @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer to the Smart Export Documentation. * @param {any} dataCallback?. A callback that allows to change the exported data. */ exportData(dataFormat: string, callback?: any, dataCallback?: any): void; /** * Returns a JSON representation of the events inside the Scheduler. * @returns {any} */ getDataSource(): any; /** * Returns a JSON representation of the resources inside the Scheduler. * @returns {any} */ getResources(): any; /** * Gets a date from coordinates * @param {number} x. X coordinate. * @param {number} y. Y coordinate. * @returns {string} */ getDateFromCoordinates(x: number, y: number): string; /** * Gets whether a cell is all day cell from coordinates * @param {number} x. X coordinate. * @param {number} y. Y coordinate. * @returns {boolean} */ getIsAllDayCellFromCoordinates(x: number, y: number): boolean; /** * Returns the current state of the Scheduler. Includes the current dateCurernt, dataSource and timeZone properties. * @returns {any} */ getState(): any; /** * Removes a previously saved state of the element form LocalStorage according to it's id. Requires an id to be set to the element. */ clearState(): void; /** * Loads a previously saved state of the element or checks LocalStorage for any saved states if no argument is passed to the method. * @param {any[]} state?. An Array containing a valid structure of Scheduler events. If no state is provided, the element will check localStorage for a saved state. */ loadState(state?: any[]): void; /** * Saves the current events of the element to LocalStorage. Requires an id to be set to the element. * @param {any[]} state?. An Array containing a valid structure of Scheduler events. */ saveState(state?: any[]): void; /** * Sets the Scheduler's view. Example: scheduler.addView('week', 'My View', 'myView', false, false, 10); scheduler.setView('myView'); * @param {string} view?. The view's value. For example: 'day'. */ setView(view?: string): void; /** * Checks whether the Scheduler contains the event. * @param {any} eventObj. A Scheduler event object. * @returns {boolean} */ containsEvent(eventObj: any): boolean; /** * Inserts an event as object of the following format (same as the dataSource format): <pre>{ label?: string, dateStart: date, dateEnd: date, description?: string, id?: string | number, class?: string, backgroundColor?: string, color?: string, notifications?: { interval: numeric, type?: string, time: number[] }[], allDay?: boolean, disableDrag?: boolean, disableResize?: boolean, repeat?: { repeatFreq: string, repeatInterval: number, repeatOn?: number | number[] | date, repeatEnd?: number | date, exceptions?: { date: date, dateStart?: date, dateEnd?: date, hidden?: boolean, backgroundColor?: string, status?: string, label?: string, description?: string, notifications?: { interval: numeric, type?: string, time: number[] }[], disableDrag?: boolean, disableResize?: boolean }[] }, status?: string }</pre> * @param {any} eventObj. An object describing a Scheduler event that is not already present in the element. * @param {number} index?. A number that represents the index to insert the event at. If not provided the event is inserted at the end of the list. */ insertEvent(eventObj: any, index?: number): void; /** * Updates an event object of the following format (same as the dataSource format): <pre>{ label?: string, dateStart: date, dateEnd: date, description?: string, id?: string | number, class?: stri