addCalendar

adds a calendar into Gantt

string addCalendar(CalendarConfig calendar);

calendar

CalendarConfig

an object with configuration of the calendar

string

the id of the calendar

Example

// adding a previously created calendar
var calendarId = gantt.addCalendar(calendar);
 
// adding a calendar with a new config
var calendarId = gantt.addCalendar({
    id:"custom", // optional
    worktime: {
        hours: ["8:00-17:00"],
        days: [ 1, 1, 1, 1, 1, 1 ,1]
    }
});
 
var calendar = gantt.getCalendar(calendarId);

Related samples

Details

The calendar configuration object can contain the following attributes:

id? - (string | number) - optional, the calendar id
worktime? - (object) - an object that sets the worktime in days and hours. It can include:
- hours? - (string[] | number[] | boolean) - optional, an array with global working hours, sets the start and end hours of the task
- days? - (WorkDaysTuple) - optional, an array of 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day
- customWeeks? - (object) - optional, an object with different working-time rules for different periods of time. The object can contain a set of key:value pairs where key is the name of a time span and value is an object with a list of attributes.
  - [timespan: string] - (object) - the time span with the working time settings. The name of that object is used as the name of the time span
    - from - (Date) - the date when the time span is scheduled to begin
    - to - (Date) - the date when the time span is scheduled to be completed
    - hours? - (Array<string | number>) - optional, an array of working hours as 'from'-'to' pairs.'false' value sets a day-off, 'true' (default value) applies the default hours (["8:00-17:00"])
    - days? - (WorkDaysTuple | boolean) - optional, an array of 7 days of the week (from 0 - Sunday, to 6 - Saturday), where 1/true stands for a working day and 0/false - a non-working day.

Setting individual working hours for a day

Instead of the number of a week day, you can also set custom working hours for this day.
For example:

var calendar = {
    id:"calendar1", // optional
    worktime: {
        hours: ["8:00-17:00"],
        days: [ 0, 1, 1, 1, ["12:00-17:00"], 1, 0]
    }
}

where ["12:00-17:00"] are working hours from 12 pm to 17 pm for Thursday.

Setting worktime for different time intervals

There is the ability to configure different working time rules for different periods of time by using the customWeeks attribute:

// adding a calendar with a new config
gantt.addCalendar({
    id:"default", // optional
    worktime: {
        hours: ["8:00-17:00"],
        days: [ 1, 1, 1, 1, 1, 1 ,1],
        customWeeks: {
            winter: {
                from: new Date(2020, 11, 1),// December 1st, 2020
                to: new Date(2021, 2, 1),// March 1st 00:00, 2021
                hours: ["9:00-13:00", "14:00-16:00"],
                days: [ 1, 1, 1, 1, 0, 0, 0]
            }
        }
    }
});