Calendar

The Calendar Component is a feature-rich way to organize and edit date and calendar entries in Lowcoder. To offer the best experience for Calendars, we integrated the fullcalendar.io Project.

You can refer to the documentation like this: https://fullcalendar.io/docs

Dynamic Data for Events

In the "Basic" section, you can bind your Datasource to feed the calendar with your existing Events.

The JSON structure is an array of objects, where each object represents a single event on the calendar. Here's a breakdown of what each key in the object means:

• id: A unique identifier for the event. This is a string that helps distinguish each event from others.

• title: The name or title of the event. This is a brief description that will be displayed on the calendar to represent the event.

• start: The start date and time of the event. This should be in the format "YYYY-MM-DD HH:MM:SS". For all-day events, you can omit the time part and only provide the date.

• end: The end date and time of the event, following the same format as the start date. For all-day events that last multiple days, this indicates the end date.

• color: (Optional) A string representing the color code (in hexadecimal format) to be used for the event's display on the calendar. This allows for visual differentiation between different types of events.

• allDay: (Optional) A boolean value (true or false) indicating whether the event lasts all day. If true, the event will be shown as an all-day event, possibly in a different section of the calendar or styled differently. If this key is omitted, the event is treated as having specific start and end times.

[
    {
        "id": "1",
        "title": "Coding",
        "start": "2024-03-04 09:00:00",
        "end": "2024-03-04 23:30:00",
        "color": "#079968",
        "allDay": true
    },...
]

As soon as a user edits or adds a new Event, the data object is updated so that you can persist this change on your chosen Datasource.

// Access all current calendar event data
return calendar1.events;

Editable Calendar

Based on the Setting "Editable" you can allow your Application Users to add or edit own Calendar Events. A small modal opens and allows the entry of Event information.

Premium Views

To display the Premium Views (Resource Timeline and Resource Grid), you must purchase a License at https://fullcalendar.io/purchase per Developer Seat. This License is then valid for all App Users in the Role "Member / Viewer".

You can enter the License Key in the Property Settings Menu. As soon as you enter the License Key, the Premium Views will be available at the Dropdown "Default View".

Component Playground

On Component Playground, you can interact with the Calendar component and explore it's Properties, Events and Methods. Play with different Styling properties to see the effect on the Calendar component.

Component Auto-Docs

In the Auto-Docs of Calendar component, we have shown how to use different properties of the Calendar component. It also includes the Styling properties of the Calendar component.

Properties of the Calendar

These properties are accessible in {{ }} notations, as well as in JavaScript Queries.

Events

Events give you the ability to trigger further actions (with Event-Handlers).

Methods

You have the capability to engage with components via their respective methods, which can be accessed by their designated names within any segment where JavaScript is utilized. Additionally, these components can be activated through the 'Control Component' action, which is triggered in response to specific events.

setResources() :

calendar1.setResources() method sets the Calendar's Resources property. This method takes an Array of Object/s as an argument.

calendar1.setResources(
  [
    {
        "id": "1",
        "title": "South Auditorium"
    },
    {
        "id": "2",
        "title": "West Auditorium",
        "eventColor": "gree"
    },
    {
        "id": "3",
        "title": "HQ Auditorium",
        "children": [
            {
                "id": "r1",
                "title": "Room 1"
            },
            {
                "id": "r2",
                "title": "Room 2"
            }
        ]
    }
]);

clearResources() :

calendar1.clearResources() method clears the Calendar's Resources property, and removes all the Resources.

calendar1.clearResources();

resetResources() :

calendar1.resetResources() method resets the Calendar's Resources property to the default data.

calendar1.clearResources();

clearInsertedEvents() :

calendar1.clearInsertedEvents() method clears any newly inserted event on the Calendar component. It clears the value of the toInsertedEvents property.

calendar1.clearInsertedEvents();

clearUpdatedEvents() :

calendar1.clearUpdatedEvents() method clears any updated details on the event of the Calendar component. It clears the value of the toUpdatedEvents property.

calendar1.clearUpdatedEvents();

clearDeletedEvents() :

calendar1.clearDeletedEvents() method clears any deleted event from the Calendar component. It clears the value of the toDeletedEvents property.

calendar1.clearDeletedEvents();

setDayGridDayView() :

calendar1.setDayGridDayView() method sets the Calendar view where list of the current Day's Events is shown. It switches the Calendar view to 'Day Grid Day', displaying a Single day in a grid layout that includes all events for that day.

calendar1.setDayGridDayView();

setDayGridMonthView() :

calendar1.setDayGridMonthView() method sets the Calendar view where current Month is shown. It switches the Calendar view to 'Day Grid Month', presenting the entire month in a grid with events displayed on their respective days.

calendar1.setDayGridMonthView();

setDayGridWeekView() :

calendar1.setDayGridWeekView() method sets the Calendar view where list of the current Week's Events is shown. It switches the Calendar view to 'Day Grid Week', where the days of the week are displayed as Columns and Events are laid out in Grid form.

calendar1.setDayGridWeekView();

setListWeekView() :

calendar1.setListWeekView() method sets the Calendar view where only those days of the Week are shown which have some Events. It switches the Calendar view to 'List Week', which provides a list-style overview of all the events happening throughout the week.

calendar1.setListWeekView();

setMultiMonthYearView() :

calendar1.setMultiMonthYearView() method sets the Calendar view where Full current year is shown on the Calendar component with all the 12 months. It switches the Calendar view to 'Multi Month Year', showing multiple months at once, allowing for long-term planning and overview.

calendar1.setMultiMonthYearView();

setTimeGridDayView() :

calendar1.setTimeGridDayView() method sets the Calendar view where current Day is shown with full 24 hours timeline. It switches the Calendar view to 'Time Grid Day', which shows a detailed hourly schedule for a Single day.

calendar1.setTimeGridDayView();

setTimeGridWeekView() :

calendar1.setTimeGridWeekView() method sets the Calendar view where current Week is shown with full 7 days and 24 hours timeline. It switches the Calendar view to 'Day Grid Week', where the days of the week are displayed as Columns and Events are laid out in Grid form.

calendar1.setTimeGridWeekView();

setResourceTimeGridDayView() :

calendar1.setResourceTimeGridDayView() is yet to be implemented. It switches the Calendar view to 'Resource Time Grid Day', which displays resources along the vertical axis and the hours of the Single day along the horizontal axis.

calendar1.setResourceTimeGridDayView();

setResourceTimelineDayView() :

calendar1.setResourceTimelineDayView() is yet to be implemented. It switches the Calendar view to 'Resource Timeline Day', showing Events against a timeline for a Single day, segmented by Resources.

calendar1.setResourceTimelineDayView();