{ 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 }
* @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: { 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 }
* @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): { 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 }
* @param {any} index. A number that represents the index of an event or a Scheduler event object.
* @param {any} eventObj. An object describing a Scheduler event. The properties of this object will be applied to the desired event.
*/
updateEvent(index: any, eventObj: any): void;
/**
* Removes an existing event.
* @param {any} index. A number that represents the index of an event or the actual event object to be removed.
*/
removeEvent(index: any): void;
/**
* Returns an array of all exceptions of the target repeating event.
* @param {any} eventObj. The index, id or an object reference of an existing repeating Scheduler event.
* @returns {any}
*/
getEventExceptions(eventObj: any): any;
/**
* Adds an event exception to a repeating event. The exception occurences for a repeating event can be gathered via the following methods: Example usage:
scheduler.addEventException(eventObj, { date: occuranceDate, dateStart: newDateStart, dateEnd: newDateEnd, label: 'Exception' });
* @param {any} eventObj. The index, id or an object reference of an existing repeating Scheduler event.
* @param {any} exceptionObj. An event object that describes an exception. Exception event objects must have a date attribute of type Date which indicates the date of occurence.
*/
addEventException(eventObj: any, exceptionObj: any): void;
/**
* Updates an event exception of a repeating event. The exception occurences for a repeating event can be gathered via the following methods: Example usage:
scheduler.updateEventException(eventObj, dateOfOccurance, { dateStart: newDateStart, dateEnd: newDateEnd, label: 'Updated Exception' });
* @param {any} eventObj. The index, id or an object reference of an existing repeating Scheduler event.
* @param {any} exceptionRef. The index, id, an occurence date of the exception or an object reference of an existing Scheduler repeating event exception.
* @param {any} exceptionObj. An event object that describes an exception. All attributes of an exception can be updated except the occurance date (the date attribute).
*/
updateEventException(eventObj: any, exceptionRef: any, exceptionObj: any): void;
/**
* Removes an exception from a repeating event.
* @param {any} eventObj. The index, id or an object reference of an existing repeating Scheduler event.
* @param {any} index. The index, id, occurance date or an object reference of an event exception that belongs to the target repeating event.
*/
removeEventException(eventObj: any, index: any): void;
/**
* Opens the popup Window for specific event Editing.
* @param {any} index. A number that represents the index of a event or the actual event object to be edited.
*/
openWindow(index: any): void;
/**
* Closes the popup window.
*/
closeWindow(): void;
/**
* Prepares the Scheduler for printing by opening the browser's Print Preview.
*/
print(): void;
/**
* Scrolls the Scheduler to a Date.
* @param {Date} date. The date to scroll to.
* @param {boolean} strictScroll?. Determines whether to scroll strictly to the date or not. This mean sthat the Scheduler wll scroll to the begining of the cell that corresponds to the target date.
* @param {boolean} autoScroll?. Calculates the scroll positions and element bounds, then adds an offset to scroll within the middle of the view.
*/
scrollToDate(date: Date, strictScroll?: boolean, autoScroll?: boolean): void;
/**
* Navigates the Scheduler to a Date.
* @param {Date} date. The date to navigate to.
*/
navigateToDate(date: Date): void;
/**
* Scrolls the Scheduler to an event.
* @param {any} index. The index of a Scheduler event or the actual event object to scroll to.
*/
scrollToEvent(index: any): void;
/**
* Opens a custom notification.
* @param {string} message. The notification message.
* @param {any} toastSettings. Smart.Toast settings to be applied to the Toast element when opening the notification.
*/
openNotification(message: string, toastSettings: any): void;
/**
* Closes all notifications.
*/
closeNotifications(): void;
/**
* Returns all occurances of an event.
* @param {any} eventObj. A Scheduler evnet object.
* @param {number} count. The number of occurances to return. By default 100 date occurances of the event are returned.
*/
occurrences(eventObj: any, count: number): void;
/**
* Returns all occurances of an event between two dates.
* @param {any} eventObj. A Scheduler event object.
* @param {Date} dateFrom. The start date.
* @param {Date} dateTo. The end date.
*/
occurrencesBetween(eventObj: any, dateFrom: Date, dateTo: Date): void;
/**
* Returns the first occurance of an event after a date.
* @param {any} eventObj. A Scheduler event object.
* @param {number} date. The date after which the first occurance of the event will be returned.
*/
occurrenceAfter(eventObj: any, date: number): void;
/**
* Returns the last occurance of an event before a date.
* @param {any} eventObj. A Scheduler event object.
* @param {number} date. The date before which the first occurance of the event will be returned.
*/
occurrenceBefore(eventObj: any, date: number): void;
/**
* Returns the dateStart/dateEnd of a timeline cell.
* @param {HTMLElement} cell. A Scheduler timeline cell element.
* @returns {any}
*/
getCellDateRange(cell: HTMLElement): any;
/**
* Opens the tooltip(event menu) for an event.
* @param {any} eventObj. A Scheduler event object or it's index.
*/
openEventTooltip(eventObj: any): void;
/**
* Closes the event tooltip (event menu).
*/
closeEventTooltip(): void;
/**
* Returns true or false whether the date is restricted or not.
* @param {Date} date. A Date object.
* @returns {boolean}
*/
isDateRestricted(date: Date): boolean;
/**
* Returns true or false whether the hour is restricted or not.
* @param {number | Date} hour. A number that represents an hour ( 0 to 23 ) or a Date object.
* @returns {boolean}
*/
isHourRestricted(hour: number | Date): boolean;
/**
* Returns true or false whether the event is restricted or not.
* @param {any} eventObj. A Scheduler event object or a direct event HTMLElement instance.
* @returns {boolean}
*/
isEventRestricted(eventObj: any): boolean;
/**
* Deletes the current undo/redo history.
* @returns {boolean}
*/
deleteUndoRedoHistory(): boolean;
/**
* Indicates whether it is possible to redo an action.
* @returns {boolean}
*/
canRedo(): boolean;
/**
* Indicates whether it is possbile to undo an action.
* @returns {boolean}
*/
canUndo(): boolean;
/**
* Redo the next event modification.
* @param {number} step?. A step to redo to.
* @returns {boolean}
*/
redo(step?: number): boolean;
/**
* Undo the last event modification.
* @param {number} step?. A step to undo to.
* @returns {boolean}
*/
undo(step?: number): boolean;
}
/**Sets the Schedulers's Data Export options. */
export interface SchedulerDataExport {
/**
* Sets whether the columns header will be exported.
* Default value: true
*/
header?: boolean;
/**
* Sets the name of the event properties that will be exported as columns.
* Default value:
*/
columns?: string[];
/**
* Sets a custom style object of the dataExport.
* Default value: null
*/
style?: any;
/**
* Sets the exported file's name.
* Default value: "jqxScheduler"
*/
fileName?: string;
/**
* Sets the page orientation, when exporting to PDF.
* Default value: "portrait"
*/
pageOrientation?: string;
}
export interface SchedulerEvent {
/**
* Event Repeat Object.
* Default value: undefined
*/
repeat?: SchedulerEventRepeat;
/**
* Event CSS class.
* Default value: ""
*/
class?: string;
/**
* Event start date.
* Default value:
*/
dateStart?: string | Date;
/**
* Event end date.
* Default value:
*/
dateEnd?: string | Date;
/**
* Determines whether dragging is disabled for the event.
* Default value: false
*/
disableDrag?: boolean;
/**
* Determines whether resizing is disabled for the event.
* Default value: false
*/
disableResize?: boolean;
/**
* Event unique id.
* Default value: ""
*/
id?: string;
/**
* Event Label.
* Default value: ""
*/
label?: string;
/**
* Event Description.
* Default value: ""
*/
description?: string;
/**
* Determines whether an event is an all day event ot nor. All day events ignore time.
* Default value: false
*/
allDay?: boolean;
/**
* Sets a background color for the event. The background color should be in HEX format.
* Default value: "false"
*/
backgroundColor?: string;
/**
* Sets a color for the event. The color should be in HEX format.
* Default value: "false"
*/
color?: string;
/**
* Sets the appointment status.
* Default value: "false"
*/
status?: string;
/**
* Event resource unique id.
* Default value: ""
*/
resourceId?: string;
/**
* Event notifications.
* Default value: null
*/
notifications?: SchedulerNotification[];
}
/**Event Repeat Object. */
export interface SchedulerEventRepeat {
/**
* Determines the repeating frequency. The event can repeat hourly, daily, weekly, monthly or yearly.
* Default value: hourly
*/
repeatFreq?: SchedulerRepeatFreq | string;
/**
* Determines the repeating interval.
* Default value: 1
*/
repeatInterval?: number;
/**
* Determines on wah day/date the event will repeat on. This is applicable only when repeatFreq is of type 'weekly' ( allows to pick the days of week from 0 to 6, where 0 is Sunday and 6 is Saturday), 'monthly' ( allows to pick a date of the month from 0 to 31) or 'yearly' (allows to pick a particular Date to repeat on. The date can be set as a Date or an object of type{ month: string, date: number }).
* Default value:
*/
repeatOn?: any;
/**
* Determines when the repeating event will end. By default it does not have an end condition. If the value is set to a number than it is considered as the number of time the event will repeat before it ends. If it's a Date then it is considered as the end date for the repeating series. If not set it will never end.
* Default value: 0
*/
repeatEnd?: number | Date | undefined;
/**
* Event exceptions represent a repeating series event that has been re-scheduler for another date/time or it has been hidden from the Scheduler. Exceptions cannot repeat.
* Default value: undefined
*/
exceptions?: { Date: string | Date, DateStart: Date | string, DateEnd: Date | string, backgroundColor: string, color: string, hidden: boolean }[] | undefined;
}
export interface SchedulerNotification {
/**
* The number of days/weeks when the notification should appear before the event starts.
* Default value: 0
*/
interval?: number;
/**
* The type of the interval for the notification.
* Default value: days
*/
type?: SchedulerNotificationType | string;
/**
* An array that represents the time when the notification should appear before the event starts. The array should have the following format: [hours: number, minutes:number]
* Default value:
*/
time?: number[];
/**
* The message that will appear inside the notificaiton. If no message is set, then the label of the event is displayed.
* Default value: ""
*/
message?: string;
/**
* Determines the type of icon that will be displayed inside the notification. By default the iconType is 'info'.
* Default value: ""
*/
iconType?: string;
}
export interface SchedulerResource {
/**
* Resource label.
* Default value: ""
*/
label?: string;
/**
* Resource unique value.
* Default value: ""
*/
value?: string;
/**
* An array that defined the data of the resources. The data represents objects that should contain the following proeprties: lable - the label for the resource item.id - the unique id for the resource item.backgroundColor - the background color for the events that have the resource item assigned.color - the color for the events that have the resource item assigned.
* Default value:
*/
dataSource?: any;
/**
* Determines the property name to sort the dataSource by.
* Default value: "null"
*/
sortBy?: string;
/**
* Determines the custom sorting function that will be used to sort the resource dataSource. The sortFunction is used when sortOrder is set to custom.
* Default value: null
*/
sortFunction?: any;
/**
* Determines the sorting order. 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?: SchedulerResourceSortOrder | string;
}
export interface SchedulerStatuse {
/**
* Status label.
* Default value: ""
*/
label?: string;
/**
* Status unique value.
* Default value: ""
*/
value?: string;
}
declare global {
interface Document {
createElement(tagName: "smart-scheduler"): Scheduler;
querySelector(selectors: "smart-scheduler"): Scheduler | null;
querySelectorAll(selectors: "smart-scheduler"): NodeListOf