Skip to content

Commit 5624144

Browse files
adnanqaopsgitbook-bot
authored andcommitted
GITBOOK-198: Documentation updates to Different components in Layout and Dashboard sections.
1 parent 83d8659 commit 5624144

File tree

36 files changed

+842
-89
lines changed

36 files changed

+842
-89
lines changed

docs/SUMMARY.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,40 @@
4848
* [Layers](build-applications/app-editor/layers.md)
4949
* [Visual Components](build-applications/app-editor/visual-components/README.md)
5050
* [Common Component Settings](build-applications/app-editor/visual-components/common-component-settings.md)
51-
* [File upload](build-applications/app-editor/visual-components/file-upload.md)
52-
* [Charts and graphs](build-applications/app-editor/visual-components/charts-and-graphs.md)
53-
* [Image](build-applications/app-editor/visual-components/image.md)
54-
* [List View](build-applications/app-editor/visual-components/list-view.md)
55-
* [Drawer](build-applications/app-editor/visual-components/drawer.md)
56-
* [Google Maps](build-applications/app-editor/visual-components/google-maps.md)
57-
* [Table](build-applications/app-editor/visual-components/table.md)
5851
* [Messages / Toast](build-applications/app-editor/visual-components/messages-toast.md)
59-
* [Calendar](build-applications/app-editor/visual-components/calendar.md)
52+
* [Dashboard & Reporting](build-applications/app-editor/visual-components/dashboard-and-reporting/README.md)
53+
* [Table](build-applications/app-editor/visual-components/dashboard-and-reporting/table.md)
54+
* [Charts and graphs](build-applications/app-editor/visual-components/dashboard-and-reporting/charts-and-graphs.md)
55+
* [Google Maps](build-applications/app-editor/visual-components/dashboard-and-reporting/google-maps.md)
56+
* [Layout & Navigation](build-applications/app-editor/visual-components/layout-and-navigation/README.md)
57+
* [List View](build-applications/app-editor/visual-components/layout-and-navigation/list-view.md)
58+
* [Drawer](build-applications/app-editor/visual-components/layout-and-navigation/drawer.md)
59+
* [Modal](build-applications/app-editor/visual-components/layout-and-navigation/modal.md)
60+
* [Navigation](build-applications/app-editor/visual-components/layout-and-navigation/navigation.md)
61+
* [Cascader](build-applications/app-editor/visual-components/layout-and-navigation/cascader.md)
62+
* [Tree / Tree Select](build-applications/app-editor/visual-components/layout-and-navigation/tree-tree-select.md)
63+
* [Link](build-applications/app-editor/visual-components/layout-and-navigation/link.md)
64+
* [Floating Button](build-applications/app-editor/visual-components/layout-and-navigation/floating-button.md)
65+
* [Text](build-applications/app-editor/visual-components/layout-and-navigation/text.md)
66+
* [Step Control](build-applications/app-editor/visual-components/layout-and-navigation/step-control.md)
67+
* [Page Layout](build-applications/app-editor/visual-components/layout-and-navigation/page-layout.md)
68+
* [Content Card](build-applications/app-editor/visual-components/layout-and-navigation/content-card.md)
69+
* [Tabbed Container](build-applications/app-editor/visual-components/layout-and-navigation/tabbed-container.md)
70+
* [Data Collection & Forms](build-applications/app-editor/visual-components/data-collection-and-forms/README.md)
71+
* [Form](build-applications/app-editor/visual-components/data-collection-and-forms/form.md)
72+
* [Input Field Types](build-applications/app-editor/visual-components/data-collection-and-forms/input-field-types.md)
73+
* [JSON Schema Form](build-applications/app-editor/visual-components/data-collection-and-forms/json-schema-form.md)
74+
* [Meeting & Collaboration](build-applications/app-editor/visual-components/meeting-and-collaboration.md)
75+
* [Project Management](build-applications/app-editor/visual-components/project-management.md)
76+
* [Calendar & Scheduling](build-applications/app-editor/visual-components/calendar-and-scheduling/README.md)
77+
* [Calendar](build-applications/app-editor/visual-components/calendar-and-scheduling/calendar.md)
78+
* [Document & File Management](build-applications/app-editor/visual-components/document-and-file-management/README.md)
79+
* [File upload](build-applications/app-editor/visual-components/document-and-file-management/file-upload.md)
80+
* [Item & Signature Handling](build-applications/app-editor/visual-components/item-and-signature-handling.md)
81+
* [Multimedia & Animation](build-applications/app-editor/visual-components/multimedia-and-animation/README.md)
82+
* [Image](build-applications/app-editor/visual-components/multimedia-and-animation/image.md)
83+
* [Integration & Extension](build-applications/app-editor/visual-components/integration-and-extension.md)
84+
* [Legacy & Deprecated](build-applications/app-editor/visual-components/legacy-and-deprecated.md)
6085
* [Option lists](build-applications/app-editor/option-lists.md)
6186
* [Date handling](build-applications/app-editor/date-handling.md)
6287
* [Use Markdown](build-applications/app-editor/use-markdown.md)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Calendar & Scheduling
2+
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Calendar
2+
3+
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](https://fullcalendar.io/docs) Project.
4+
5+
You can refer to the documentation like this: [https://fullcalendar.io/docs](https://fullcalendar.io/docs)
6+
7+
<figure><img src="../../../../.gitbook/assets/Component Calendar Overview.png" alt=""><figcaption></figcaption></figure>
8+
9+
### Dynamic Data for Events
10+
11+
In the "Basic" section, you can bind your Datasource to feed the calendar with your existing Events.
12+
13+
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:
14+
15+
* **`id`**: A unique identifier for the event. This is a string that helps distinguish each event from others.
16+
* **`title`**: The name or title of the event. This is a brief description that will be displayed on the calendar to represent the event.
17+
* **`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.
18+
* **`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.
19+
* **`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.
20+
* **`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.
21+
22+
```
23+
[
24+
{
25+
"id": "1",
26+
"title": "Coding",
27+
"start": "2024-03-04 09:00:00",
28+
"end": "2024-03-04 23:30:00",
29+
"color": "#079968",
30+
"allDay": true
31+
},...
32+
]
33+
```
34+
35+
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.&#x20;
36+
37+
```
38+
// Access all current calendar event data
39+
return calendar1.events;
40+
```
41+
42+
### Editable Calendar
43+
44+
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.
45+
46+
### Premium Views
47+
48+
To display the Premium Views (Resource Timeline and Resource Grid), you must purchase a License at [https://fullcalendar.io/purchase](https://fullcalendar.io/purchase) per Developer Seat. This License is then valid for all App Users in the Role "Member / Viewer".
49+
50+
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".
51+
52+
### Properties of the Calendar
53+
54+
These properties are accessible in \{{ \}} notations, as well as in JavaScript Queries.&#x20;
55+
56+
<table><thead><tr><th width="168.40234375">Property Name</th><th width="144.2265625">Type</th><th>Description</th></tr></thead><tbody><tr><td>allEvents</td><td>Array</td><td>An array of Objects containing list of all the Events on a Calendar component</td></tr><tr><td>events</td><td>Array</td><td></td></tr><tr><td>hidden</td><td>Boolean</td><td>Returns True or False based on whether the Form component is hidden or not</td></tr><tr><td>resources</td><td>Array</td><td></td></tr><tr><td>resourcesEvents</td><td>Array</td><td></td></tr><tr><td>toDeletedEvents</td><td>Object</td><td></td></tr><tr><td>toInsertedEvents</td><td>Object</td><td>An Object to be Inserted as a new Event in the Calendar </td></tr><tr><td>toUpdatedEvents</td><td>Object</td><td>An Object to be updated as an Event in the Calendar</td></tr></tbody></table>
57+
58+
#### Events <a href="#events" id="events"></a>
59+
60+
Events give you the ability to trigger further actions (with Event-Handlers).
61+
62+
<table><thead><tr><th width="175.01953125">Event Name</th><th width="442.3671875">Description</th></tr></thead><tbody><tr><td>Change</td><td>When a User make any"changes" to the Calendar component.</td></tr><tr><td>Double Click</td><td>When a User "Double Click" on an Event or a Time slot.</td></tr><tr><td>Drag</td><td>When a User "Drags" an Event.</td></tr><tr><td>Drop</td><td>When a User "Drops" an Event.</td></tr></tbody></table>
63+
64+
#### Methods <a href="#methods" id="methods"></a>
65+
66+
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.
67+
68+
<table><thead><tr><th width="247.83984375">Method Name</th><th width="446.3984375">Description</th></tr></thead><tbody><tr><td>clearDeletedEvents</td><td>Clears the data in the property toDeletedEvent</td></tr><tr><td>clearInsertedEvents</td><td>Clears the data in the property toInsertedEvent</td></tr><tr><td>clearUpdatedEvents</td><td>Clears the data in the property toUpdatedEvent</td></tr><tr><td>setResources</td><td>Set the data for the property Resources</td></tr><tr><td>clearResources</td><td>Clear the data for the property Resources</td></tr><tr><td>resetResources</td><td>Reset the data for the property Resources</td></tr><tr><td>setDayGridDayView</td><td>Switches the Calendar view to 'Day Grid Day', displaying a Single day in a grid layout that includes all events for that day.</td></tr><tr><td>setDayGridWeeklyView</td><td>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.</td></tr><tr><td>setDayGridMonthlyView</td><td>Switches the Calendar view to 'Day Grid Month', presenting the entire month in a grid with events displayed on their respective days.</td></tr><tr><td>setListWeekView</td><td>Switches the Calendar view to 'List Week', which provides a list-style overview of all the events happening throughout the week.</td></tr><tr><td>setMultiMonthYearView</td><td>Switches the Calendar view to 'Multi Month Year', showing multiple months at once, allowing for long-term planning and overview.</td></tr><tr><td>setResourceTimeGridDayView</td><td>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.</td></tr><tr><td>setResourceTimelineDayView</td><td>Switches the Calendar view to 'Resource Timeline Day', showing Events against a timeline for a Single day, segmented by Resources.</td></tr><tr><td>setTimeGridDayView</td><td>Switches the Calendar view to 'Time Grid Day', which shows a detailed hourly schedule for a Single day.</td></tr><tr><td>setTimeGridWeekView</td><td>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.</td></tr></tbody></table>
69+

docs/build-applications/app-editor/visual-components/calendar.md

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Dashboard & Reporting
2+

docs/build-applications/app-editor/visual-components/google-maps.md renamed to docs/build-applications/app-editor/visual-components/dashboard-and-reporting/google-maps.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ Lowcoder offers an innovative approach to integrating Geomaps from Google with a
44

55
The core feature of this integration is the seamless combination of Google Geomaps with eCharts overlays. Google Geomaps provides a robust and familiar mapping interface, known for its detailed and accurate geographical data. By overlaying eCharts, Lowcoder enables the addition of rich, interactive data visualizations directly onto these maps. This overlay capability is not just about static data representation; it supports dynamic, real-time data updates, making it ideal for applications that require up-to-the-minute information, such as traffic monitoring, weather updates, or tracking movements in logistics.
66

7-
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-27 at 22.07.19.png" alt=""><figcaption><p>Distribution of Lowcoder Users worldwide (10.2023)</p></figcaption></figure>
7+
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-27 at 22.07.19.png" alt=""><figcaption><p>Distribution of Lowcoder Users worldwide (10.2023)</p></figcaption></figure>
88

9-
Lowcoder ensures that the data displayed in the eCharts overlay is not only current but can also be updated in real-time with the [Stream Query](../../../connect-your-data/data-sources-in-lowcoder/websocket-datasource.md). This is crucial for scenarios where timely data is essential for decision-making. Users can see changes as they happen, providing an interactive and engaging experience.
9+
Lowcoder ensures that the data displayed in the eCharts overlay is not only current but can also be updated in real-time with the [Stream Query](../../../../connect-your-data/data-sources-in-lowcoder/websocket-datasource.md). This is crucial for scenarios where timely data is essential for decision-making. Users can see changes as they happen, providing an interactive and engaging experience.
1010

1111
The eCharts overlay on Google Geomaps in Lowcoder also offers a high degree of customization and interactivity. Users can zoom in and out, pan across different regions, and interact with the data points on the map. This interactivity is enhanced with tooltips, clickable elements, and various chart types like heatmaps, scatter plots, or line graphs, all geo-referenced and layered over the map.
1212

1313
### Using Geomap in Lowcoder
1414

1515
As the first step, place a new Chart from the right Components panel on the canvas.
1616

17-
<figure><img src="../../../.gitbook/assets/App Editor GeoMaps use 1.png" alt=""><figcaption></figcaption></figure>
17+
<figure><img src="../../../../.gitbook/assets/App Editor GeoMaps use 1.png" alt=""><figcaption></figcaption></figure>
1818

1919
Now you can select in the Component Properties the type "Map"
2020

21-
<figure><img src="../../../.gitbook/assets/App Editor GeoMaps Select Map.png" alt=""><figcaption></figcaption></figure>
21+
<figure><img src="../../../../.gitbook/assets/App Editor GeoMaps Select Map.png" alt=""><figcaption></figcaption></figure>
2222

2323
You can use the Properties "Zoomlevel, Longitude, and Latitude" to define the first impression of the GeoMap when the App is displayed.
2424

@@ -133,12 +133,12 @@ When you publish your app, an Google Maps API Key must be in place to display th
133133

134134

135135

136-
<figure><img src="../../../.gitbook/assets/Google Maps APIs 0.png" alt=""><figcaption></figcaption></figure>
136+
<figure><img src="../../../../.gitbook/assets/Google Maps APIs 0.png" alt=""><figcaption></figcaption></figure>
137137

138138
To display only the Map and use the JavaScript API, "Map Embed API" and "Maps JavaScript API" need to be activated.
139139

140-
<figure><img src="../../../.gitbook/assets/Google Maps APIs 1.png" alt=""><figcaption></figcaption></figure>
140+
<figure><img src="../../../../.gitbook/assets/Google Maps APIs 1.png" alt=""><figcaption></figcaption></figure>
141141

142142
Now you can create and see your Google Maps API Key. It is suggested that you limit the Traffic by a Domain or IP Range.
143143

144-
<figure><img src="../../../.gitbook/assets/Google Maps APIs API Key.png" alt=""><figcaption></figcaption></figure>
144+
<figure><img src="../../../../.gitbook/assets/Google Maps APIs API Key.png" alt=""><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)