Options

locale

Default: 'en'
Accepts: 'en', 'fr'

Set the default locale to use. Actually you can only choose between 'en' and 'fr'.
See momentjs for valid locales.

Note: the momentjs file must contain the locale you want to use.

defaultDisplay

Default: 'months'
Accepts: 'months', 'days', 'list'

Defines which display mode must be used on initialization.

hideEmptyLines

Default: true

With this option activated, the lines with no task will automatically be hidden.

disableLabelsMovement

Default: false

By default, the tasks label will move on scroll to stay on the screen. You can use this option to disable this feature.

defaultGroupName

Default: 'unlisted'

Defines a default group name. Note that the default value will be translated depending on the current locale.

defaultDate

Default: The current date

Sets the starting date.

defaultColor

Default: #00BCD4

Defines a default color for the tasks and some UI elements.

disableNotifications

Default: false

Disables notifications.

notificationDuration

Default: 4000

Sets the notifications duration (in ms).

hideSpinner

Default: true

Hides the preloader.

Note: The preloader will appears on each page change. You may only use it if you have to work with a lot of data or using Ajax requests.

disableUndo

Default: false

The undo option is a little bit particular: On each modification, you'll be notified with a link that allows you to revert what you just have done.
Be careful if you are using events options (see the events page). The callback functions will only be called after the notification disappearance to let you have a few seconds of hesitation.

Note: this option requires the notifications to be enabled!

resizeTask

Default: false

You can turn off the tasks resizing with this option.

tasks

Default: Array of Objects

Use this option to define tasks that will be displayed into the scheduler.
Take a look at the options bellow. Each task is an object.

Note: What about setting a function as argument to this option and get the tasks using ajax? Yes! You can!

task: id*

Requires: String

Each defined tasks must be set with a unique ID.

task: name*

Requires: String

Each defined tasks must be set with a unique name.

task: description

Accepts: String

You can set descriptions for each task using this option. However, this is not required.

task: color

Accepts: All colors definition types

If you don't define this option, the task will either use the defaultColor option, either the #00BCD4 color (if the defaultColor option is not defined).

task: tag

Accepts: String

Defines a tag for the task

Note: Tags are meant to be used with short sentences of one or two words max.

task: tagColor

Accepts: All colors definition types

Defines a background-color for the task tag.

users

Accepts: Array of objects

You can add users using this option.
Take a look at the options below to learn more about the required options.

user: name*

Requires: String

Defines the user name. This option is required.

user: group

Accepts: String

Defines the user group name.

Note: All the users with a matching group name will be sorted together.

user: tasks

Accepts: Array of objects

Defines the user tasks. Each task must be composed of the following elements:

an id: (String) refers to the task it is about (defined in the tasks options)
a start_date: (valid Date) The beginning of the task
a end_date: (valid Date) The end of the task

Example:

/* ... */
tasks: [
    {
     id: 'dlaJ-S76-sk2',
     start_date: '2016-08-07 13:45',
     end_date: '2016-08-15 18:00'
    }
]
/* ... */