Skip to main content

checkLimitViolation

Description

Checks whether the specified event takes place at the blocked time period

checkLimitViolation: (event: any) => boolean

Parameters

  • event - (required) object - the event object

Returns

  • isBlocked - (boolean) - returns true, if the event occurs at the blocked time, otherwise - false.

Example

var event = {
text : "New Event",
start_date : new Date(2013, 02, 20, 10, 00),
end_date : new Date(2013, 02, 20, 14, 00)
};

var isBlocked = scheduler.checkLimitViolation(event); //returns 'true' or 'false'

Details

note

The method requires the limit plugin to be activated.

Note, the method invokes the onLimitViolation event.

Need help?
Got a question about the documentation? Reach out to our technical support team for help and guidance. For custom component solutions, visit the Services page.