Skip to main content

mode

Description​

Optional. An initial view mode of Event Calendar

Usage​

mode?: string | number; // "day" | "week" | "month" | "year" | "agenda" | "timeline" | custom_id

Default config​

By default, the mode config is set to the "week" value

mode: "week"
note

You can set the mode property to the "day", "week", "month", "year", "agenda" or "timeline" view IDs used by default, or define a custom ID in the config.views property

info

To set the view mode dynamically, you can use the setMode() and setConfig() methods

Example​

// create Event Calendar
new eventCalendar.EventCalendar("#root", {
    mode: "timeline"
    // other configuration parameters
});

Related sample: Event Calendar. Readonly

Change log: The timeline mode was added in v2.0