{ "mixins": [ "composables/private.useCellWidth", "composables/private.useCheckChange", "composables/private.useMove", "composables/private.useCommon", "composables/private.useInterval", "composables/private.useMaxDays", "composables/private.useMonth", "composables/private.useTasks", "composables/private.useTimes", "composables/private.useScheduler", "composables/private.useResource", "composables/private.useNavigation" ], "meta": { "docsUrl": "https://qcalendar.netlify.app/developing/qcalendar" }, "props": { "mode": { "type": "String", "category": "behavior", "desc": "Tells QCalendar (wrapper) which calendar component to use", "default": "'day'", "values": [ "'day'", "'month'", "'agenda'", "'resource'", "'scheduler'", "'task'" ], "examples": [ "'week'", "'month'" ] }, "hide-header": { "type": "Boolean", "category": "style", "desc": "Hide the calendar header.", "applicable": [ "All" ] } }, "events": { "input": { "desc": "v-model; Emitted when calendar date changes", "applicable": [ "All" ], "params": { "value": { "type": "String", "desc": "In `YYYY-MM-DD` format", "required": true, "__exemption": [ "examples" ] } } }, "change": { "desc": "Emitted when the calendar dates change. For instance, if in `month` view, the `start` contains the timestamp object for the 1st of the month, and `end` contains the timestamp object for the last day of the month. For week view it's the first day of the displayed week and last day of the displayed week", "applicable": [ "All" ], "params": { "{start, end}": { "type": "Timestamp", "tsType": "Timestamp", "desc": "The timestamp objects for the first and last valid date being displayed", "__exemption": [ "examples" ] } } }, "moved": { "desc": "Emitted when the date is moved", "applicable": [ "All" ], "params": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "The timestamp object of the move. For instance, if in month view, this will be the timestamp object containing the 1st of the month", "__exemption": [ "examples" ] } } }, "expanded": { "desc": "Event occurs when hierarchial resources are expanded/collapses", "applicable": [ "Scheduler", "Resource" ], "params": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object that was toggle, check `expanded` property for `true` or `false`", "__exemption": [ "examples" ] } } }, "mini-mode": { "desc": "Event occurs when switching to/from mini-mode, when the `breakpoint` property is set to `auto`", "applicable": [ "Month" ], "params": { "value": { "type": "Boolean", "desc": "If switched to `mini-mode`, then the value is `true`, otherwise it is `false" } } }, "click-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-date": { "desc": "Occurs on date button", "applicable": [ "All" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-day": { "desc": "Occurs on day", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "true if this is an outside day" }, "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-day-header": { "desc": "Occurs on day header", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week for that weekday", "__exemption": [ "examples" ] }, "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing all the days in the month for that weekday", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the weekday", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode" } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-workweek": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "miniMode": { "type": "Boolean", "desc": "true if calendar is currently in mini-mode" }, "week": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects representing the week", "__exemption": [ "examples" ] }, "workweekLabel": { "type": "String", "desc": "The workweek label", "examples": [ "'18'", "'22'" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-workweek-header": { "desc": "Occurs on workweek", "applicable": [ "month" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "start": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Object", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-interval": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-interval-header": { "desc": "Occurs on interval area", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects applicable for the view", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "'900'" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-time": { "desc": "Occurs on time area of the main slotted content", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "resource", "day-resource", "month", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope of the event", "__exemption": [ "examples" ], "definition": { "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp of the event", "__exemption": [ "examples" ] }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "__exemption": [ "examples" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "__exemption": [ "examples" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "index": { "type": "Number", "desc": "The index of the column when using `column-count` property", "__exemption": [ "examples" ] }, "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object associated with the event. Only applicable for resource views", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-resource-day": { "desc": "Occurs on resource day area", "applicable": [ "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The data object", "__exemption": [ "examples" ], "definition": { "resource": { "type": "Object", "tsType": "ResourceObject", "desc": "The resource object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The resource index", "__exemption": [ "examples" ] }, "timestamp": { "type": "Object", "tsType": "Timestamp", "desc": "The timestamp object", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-column-head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown:column:head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup:column:head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter:column:head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave:column:head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove:column:head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-column-head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-column-head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-column-head": { "desc": "Occurs on column header", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "tsType": "ColumnObject", "desc": "Contains the object passed for the column when either property `left-column-options` or `right-column-options` are used", "__exemption": [ "examples" ] }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-column-header": { "desc": "Occurs on column header, when extra columns have been added", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "click-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "contextmenu-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousedown-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseup-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseenter-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mouseleave-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "mousemove-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchstart-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchend-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } }, "touchmove-column": { "desc": "Occurs on column when using the `left-column-options` or `right-column-options` properties", "applicable": [ "week-agenda" ], "params": { "data": { "type": "Object", "desc": "The data passed to the function", "__exemption": [ "examples" ], "definition": { "scope": { "type": "Object", "desc": "The scope object", "__exemption": [ "examples" ], "definition": { "column": { "type": "Object", "tsType": "ColumnObject", "desc": "The column object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the column when using the `left-column-options` or `right-column-options` properties", "__exemption": [ "examples" ] } } }, "event": { "type": "Object", "desc": "JS event object", "__exemption": [ "examples" ] } } } } } }, "methods": { "prev": { "desc": "Triggers the calendar to display the previous (ex: day, week, month)", "applicable": [ "All" ], "params": null, "returns": null, "__exemption": [ "examples" ] }, "next": { "desc": "Triggers the calendar to display the next (ex: day, week, month)", "applicable": [ "All" ], "params": null, "returns": null, "__exemption": [ "examples" ] }, "move": { "desc": "Triggers the calendar to move for count iterations, depending on positive (forwards) or negative (backwards) value", "applicable": [ "All" ], "params": { "count": { "type": "Number", "desc": "The amount of iterations to move (negative for backwards, positive for forwards). If value is 0, emits `today's date` to v-model", "examples": [ "-5 (moves 5 iterations backward - if in `month` view, this would be -5 months", "5 (moves 5 iterations forward - if in `day` view, this would be 5 days" ] } }, "returns": null }, "moveToToday": { "desc": "Emits `today's date` to v-model", "applicable": [ "All" ], "params": null, "returns": null, "__exemption": [ "examples" ] }, "updateCurrent": { "desc": "Update various values to be consistent with current date", "applicable": [ "All" ], "params": null, "returns": null, "__exemption": [ "examples" ] }, "timeStartPos": { "desc": "Calculates the starting y position of the passed in time", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "timeStartPosX": { "desc": "Calculates the starting x position of the passed in time", "applicable": [ "resource", "day-resource" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] } }, "returns": { "type": "Number", "desc": "The absolute x starting position", "examples": [ "120", "482" ] } }, "timeDurationHeight": { "desc": "Given a duration (in minutes), will return the css height value", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "timeDurationWidth": { "desc": "Given a duration (in minutes), will return the css width value", "applicable": [ "resource", "day-resource" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's width", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } }, "heightToMinutes": { "addedIn": "v3.4.0", "desc": "Given a height (in pixels) return the duration (in minutes)", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "params": { "height": { "type": [ "Number", "String" ], "desc": "The number of pixels for the event to calculate it's duration", "examples": [ "30", "'90px'" ] } }, "returns": { "type": "Number", "desc": "The duration (in minutes) to be used for the event", "examples": [ "80", "120" ] } }, "widthToMinutes": { "desc": "Given a width (in pixels) return the duration (in minutes)", "addedIn": "v3.4.0", "applicable": [ "resource", "day-resource" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of pixels for the event to calculate it's duration", "examples": [ "'300px'", "900" ] } }, "returns": { "type": "Number", "desc": "The duration (in minutes) to be used for the event", "examples": [ "80", "120" ] } }, "scrollToTime": { "desc": "When on an interval view, scroll to the passed in time (y position)", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "month-interval", "custom-interval", "scheduler", "week-scheduler", "month-scheduler", "custom-scheduler" ], "returns": { "type": "Boolean", "desc": "If the procedure was successful or not" }, "params": { "time": { "type": "String", "desc": "The time in which to scoll to. If the time is already visible on the viewport, this function will have no affect.", "required": true, "examples": [ "'09:00'" ] }, "duration": { "type": "Number", "desc": "The amount of time in milliseconds to do the scroll", "examples": [ "200" ] } } }, "scrollToTimeX": { "desc": "When on an resource interval view, scroll to the passed in time (x position)", "applicable": [ "resource", "day-resource" ], "returns": { "type": "Boolean", "desc": "If the procedure was successful or not" }, "params": { "time": { "type": "String", "desc": "The time in which to scoll to. If the time is already visible on the viewport, this function will have no affect.", "required": true, "examples": [ "'09:00'" ] }, "duration": { "type": "Number", "desc": "The amount of time in milliseconds to do the scroll", "examples": [ "200" ] } } } }, "slots": { "head-day": { "desc": "Replaces the complete internal day header", "scope": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The index of the iteration", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "If currently in mini-mode (applied to Month calendars only)", "__exemption": [ "examples" ] } }, "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week", "month-interval", "custom-interval", "all scheduler", "all agenda" ] }, "day-header": { "desc": "index is added if using `column-count` property", "scope": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "If applicable, the index of the column-header", "__exemption": [ "examples" ] } }, "applicable": [ "day" ] }, "day-header-label": { "desc": "Used to replace the label", "scope": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object", "__exemption": [ "examples" ] }, "shortWeekdayLabel": { "type": "Boolean", "desc": "True if `short-weekday-label` property is set", "__exemption": [ "examples" ] } }, "applicable": [ "day", "week-agenda" ] }, "day-body": { "desc": "index is added if using `column-count` property", "scope": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object", "__exemption": [ "examples" ] }, "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day" ], "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "applicable": [ "day", "2day", "3day", "4day", "5day", "6day" ], "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } } }, "applicable": [ "day", "2day", "3day", "4day", "5day", "6day", "week-agenda" ] }, "day-container": { "desc": "The container is everything below the headers, including the intervals", "scope": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of timestamp objects that are to be displayed in the container. This slot does not replace the container, but instead, allows you to add to it. Example: use css `position: absolute` to create a `current time` bar.", "__exemption": [ "examples" ] } } }, "intervals-header": { "desc": "Use to render items in the intervals header", "scope": { "days": { "type": "Array", "tsType": "TimestampArray", "desc": "An array of Timestamp objects", "__exemption": [ "examples" ] } }, "applicable": [ "day" ] }, "interval": { "desc": "index is added if using `column-count` property", "scope": { "timeStartPos": { "type": "Function", "desc": "Calculates the starting y position of the passed in time", "params": { "time": { "type": "String", "desc": "The time for which a position is needed in 24-hour format (HH:mm)", "examples": [ "'09:00'" ] }, "clamp": { "type": "Boolean", "desc": "Clamp negative values to 0", "default": "true" } }, "returns": { "type": "Number", "desc": "The absolute y starting position, but `false` on invalid time parameter", "examples": [ "120", "482" ] } }, "timeDurationHeight": { "type": "Function", "desc": "Given a duration (in minutes), will return the css height value", "params": { "duration": { "type": [ "Number", "String" ], "desc": "The number of minutes for the event to calculate it's height", "examples": [ "'300'", "900" ] } }, "returns": { "type": "Number", "desc": "The height (in pixels) to be used for the event", "examples": [ "80", "120" ] } } }, "applicable": [ "day" ] }, "day": { "desc": "Use to add items to the `day` rendering", "scope": { "outside": { "type": "Boolean", "desc": "true if the date is outside of the calendar month, but still displayed" }, "day": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp for the day of the slotted content", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "head-day-label": { "desc": "Use to replace the head day label", "scope": { "dayLabel": { "type": "String", "desc": "The string of the dayLabel", "__exemption": [ "examples" ] }, "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp for the day of the slotted content", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "day-btn": { "desc": "Use to replace the `day button`", "scope": { "dayLabel": { "type": "String", "desc": "The string of the dayLabel", "__exemption": [ "examples" ] }, "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp for the day of the slotted content", "__exemption": [ "examples" ] }, "outside": { "type": "Boolean", "desc": "If this day is considered `outside` the current month", "__exemption": [ "examples" ] }, "selectedDate": { "type": "Boolean", "desc": "If this day is a selected date (applicable only for mini-mode)", "__exemption": [ "examples" ] }, "activeDate": { "type": "Boolean", "desc": "If this day is the currently selected date (v-model)", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "month-label": { "desc": "Use to replace the `month label`. Not applicable in `mini-mode`", "scope": { "monthLabel": { "type": "String", "desc": "The string of the monthLabel", "__exemption": [ "examples" ] }, "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp for the day of the slotted content", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "day-of-year": { "desc": "Use to replace the `day of year` label. Not applicable in `mini-mode`", "scope": { "timestamp": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object", "__exemption": [ "examples" ] } }, "applicable": [ "month" ] }, "workweek": { "desc": "Scoped slot for the workweek", "scope": { "workweekLabel": { "type": "String", "desc": "The string for the workweek label", "__exemption": [ "examples" ] }, "date": { "type": "Timestamp", "tsType": "Timestamp", "desc": "Timestamp object, workWeekLabel and miniMode", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "workweek-header": { "desc": "Scoped slot for the workweek header area", "scope": { "start": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp object representing the first day of the week", "__exemption": [ "examples" ] }, "end": { "type": "Timestamp", "tsType": "Timestamp", "desc": "A timestamp object representing the last day of the week", "__exemption": [ "examples" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } }, "applicable": [ "month" ] }, "week": { "desc": "", "applicable": [ "month" ], "scope": { "week": { "type": "Array", "tsType": "TimestampArray", "desc": "This is an array of timestamp objects. One for each day of the week to be displayed", "__exemption": [ "examples" ] }, "weekdays": { "type": "Array", "tsType": "NumberArray", "category": "model", "desc": "The normal weekdays array looks like this `[0, 1, 2, 3, 4, 5, 6]` where 0=Sunday, 1=Monday, etc. A week that starts on Monday, would look like this: `[1,2,3,4,5,6,0]` and a 5-day workweek would look like this: `[1,2,3,4,5]`", "default": "[0, 1, 2, 3, 4, 5, 6]", "examples": [ "[1,2,3,4,5,6,0]", "[1,2,3,4,5]" ] }, "miniMode": { "type": "Boolean", "desc": "true if currently in mini-mode. Handle if you have set mini-mode to `auto`" } } }, "scheduler-resources-header": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "scheduler-day-header": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "scheduler-column-header-before": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "scheduler-column-header-after": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "scheduler-resource-day": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "scheduler-resource": { "desc": "", "scope": { "data": { "type": "Object", "desc": "", "__exemption": [ "examples" ] } }, "applicable": [ "scheduler" ] }, "column-header": { "desc": "Use this slot to add to the column header when properties `left-column-options` or `right-column-options` are used", "scope": { "data": { "type": "Object", "tsType": "ColumnObject", "desc": "This is the object passed to properties `left-column-options` or `right-column-options`", "__exemption": [ "examples" ] } }, "applicable": [ "week-agenda" ] }, "column-body": { "desc": "Use this slot to add to the column body when properties `left-column-options` or `right-column-options` are used", "scope": { "data": { "type": "Object", "tsType": "ColumnObject", "desc": "This is the object passed to properties `left-column-options` or `right-column-options`", "__exemption": [ "examples" ] } }, "applicable": [ "week-agenda" ] }, "interval-label": { "desc": "Use this slot to change the display of an interval label", "scope": { "interval": { "type": "Timestamp", "tsType": "Timestamp", "desc": "The interval object for this label", "__exemption": [ "examples" ] }, "index": { "type": "Number", "desc": "The interval index", "__exemption": [ "examples" ] }, "label": { "type": "String", "desc": "The interval label", "examples": [ "'03:00'", "'3 AM'" ] } }, "applicable": [ "resource", "day-resource" ] } } }