Skip to content

Commit 748391a

Browse files
committed
docs(Scheduler): add Agenda view documentation article
1 parent e2929ba commit 748391a

File tree

8 files changed

+134
-62
lines changed

8 files changed

+134
-62
lines changed

components/scheduler/resource-grouping.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,6 @@ The settings tag will have the following Parameters:
3535
* `Resources(List<string>)` - provides a list of one or more resource names, which will be used to group the events.
3636
* `Orientation(SchedulerGroupOrientation)` - has two values: `Horizontal` (default) and `Vertical`. Determines the direction in which the resource tables are rendered.
3737

38-
For more information on grouping by resources in each view, refer to the following sections:
39-
40-
* [**Day** view grouping]({%slug scheduler-views-day%}#resource-grouping-in-the-day-view)
41-
* [**MultiDay** view grouping]({%slug scheduler-views-multiday%}#resource-grouping-in-the-multiday-view)
42-
* [**Week** view grouping]({%slug scheduler-views-week%}#resource-grouping-in-the-week-view)
43-
* [**Month** view grouping]({%slug scheduler-views-month%}#resource-grouping-in-the-month-view)
44-
4538
## Examples
4639
The examples below showcase [resource grouping by one resource](#resource-grouping-by-one-resource) and [resource grouping by multiple resources](#resource-grouping-by-multiple-resources) respectively.
4740

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
title: Agenda
3+
page_title: Scheduler - Agenda View
4+
description: Agenda View in the Scheduler for Blazor.
5+
slug: scheduler-views-agenda
6+
tags: telerik,blazor,scheduler,view,agenda
7+
published: True
8+
position: 6
9+
---
10+
11+
# Agenda View
12+
13+
The Agenda view of the Scheduler for Blazor shows a weekly summary (or a custom period set by the user) in a table format. Also the Agenda view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%})
14+
15+
16+
In this article:
17+
18+
* [View Parameters](#view-parameters)
19+
* [Example](#example)
20+
21+
## View Parameters
22+
23+
The following parameters allow you to configure the agenda view:
24+
25+
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)
26+
27+
| Attribute | Type and Default&nbsp;Value | Description |
28+
| --- | --- | --- |
29+
| `NumberOfDays` | `int` <br /> (`7 (a week)`) | Represents the number of days shown in the view. |
30+
| `HideEmptyAgendaDays` | `bool` <br /> (`true`) | Defines whether dates with no appointments are rendered. |
31+
32+
## Example
33+
34+
>caption Declare the Agenda View in the markup
35+
36+
>tip You can declare other views as well, this example adds only the Agenda view for brevity.
37+
38+
````CSHTML
39+
@* Define the agenda view. *@
40+
41+
<TelerikScheduler Data="@Appointments" @bind-Date="@StartDate" Width="800px">
42+
<SchedulerViews>
43+
<SchedulerAgendaView HideEmptyAgendaDays="@HideEmptyDays" />
44+
</SchedulerViews>
45+
</TelerikScheduler>
46+
47+
@code {
48+
private DateTime StartDate { get; set; } = new DateTime(2024, 10, 22);
49+
50+
private bool HideEmptyDays { get; set; }
51+
52+
private List<SchedulerAppointment> Appointments = new List<SchedulerAppointment>()
53+
{
54+
new SchedulerAppointment
55+
{
56+
Title = "Team Meeting",
57+
Description = "Discuss the project progress.",
58+
Start = new DateTime(2024, 10, 14, 10, 00, 0),
59+
End = new DateTime(2024, 10, 14, 11, 00, 0)
60+
},
61+
new SchedulerAppointment
62+
{
63+
Title = "Doctor Appointment",
64+
Description = "Routine check-up.",
65+
Start = new DateTime(2024, 10, 16, 9, 30, 0),
66+
End = new DateTime(2024, 10, 16, 10, 00, 0)
67+
},
68+
new SchedulerAppointment
69+
{
70+
Title = "Client Call",
71+
Description = "Quarterly review with the client.",
72+
Start = new DateTime(2024, 10, 22, 14, 00, 0),
73+
End = new DateTime(2024, 10, 22, 15, 00, 0)
74+
},
75+
new SchedulerAppointment
76+
{
77+
Title = "Team Outing",
78+
Description = "Lunch with the team.",
79+
Start = new DateTime(2024, 10, 23, 12, 30, 0),
80+
End = new DateTime(2024, 10, 23, 14, 00, 0)
81+
},
82+
new SchedulerAppointment
83+
{
84+
Title = "Webinar",
85+
Description = "Industry trends and insights.",
86+
Start = new DateTime(2024, 10, 24, 16, 00, 0),
87+
End = new DateTime(2024, 10, 24, 17, 30, 0)
88+
},
89+
new SchedulerAppointment
90+
{
91+
Title = "Project Deadline",
92+
Description = "Final submission of deliverables.",
93+
Start = new DateTime(2024, 10, 29, 9, 00, 0),
94+
End = new DateTime(2024, 10, 29, 12, 00, 0)
95+
}
96+
};
97+
98+
public class SchedulerAppointment
99+
{
100+
public string Title { get; set; }
101+
public string Description { get; set; }
102+
public DateTime Start { get; set; }
103+
public DateTime End { get; set; }
104+
public bool IsAllDay { get; set; }
105+
}
106+
}
107+
````
108+
109+
## See Also
110+
111+
* [Views]({%slug scheduler-views-overview%})
112+
* [Navigation]({%slug scheduler-navigation%})
113+
* [Live Demo: Scheduler Agenda View](https://demos.telerik.com/blazor-ui/scheduler/agenda-view)
114+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)
115+

components/scheduler/views/day.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ position: 1
1010

1111
# Day View
1212

13-
The Day view of the Scheduler for Blazor shows a single day to the user.
13+
The Agenda view of the Scheduler for Blazor shows a weekly summary (or a custom period set by the user) in a table format. Also the Day view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%}).
1414

1515
The `Date` parameter of the scheduler controls which date is displayed.
1616

@@ -19,7 +19,6 @@ In this article:
1919
* [View Parameters](#view-parameters)
2020
* [Slots](#slots)
2121
* [Example](#example)
22-
* [Resource Grouping](#resource-grouping-in-the-day-view)
2322

2423
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
2524

@@ -96,16 +95,9 @@ In this article:
9695
}
9796
````
9897

99-
## Resource Grouping in the Day View
100-
101-
You can configure the Day view to display events that are [grouped by a resource]({%slug scheduler-resource-grouping%}).
102-
103-
>caption Resource Grouping in a Day view.
104-
105-
@[template](/_contentTemplates/scheduler/views.md#resource-grouping-code-snippet-for-examples)
106-
10798
## See Also
10899

109100
* [Views]({%slug scheduler-views-overview%})
110101
* [Navigation]({%slug scheduler-navigation%})
111102
* [Live Demo: Scheduler Day View](https://demos.telerik.com/blazor-ui/scheduler/day-view)
103+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)

components/scheduler/views/month.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ position: 4
1010

1111
# Month View
1212

13-
The Month view of the Scheduler for Blazor shows an entire month to the user.
13+
The Month view of the Scheduler for Blazor shows an entire month to the user. Also the Month view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%}).
1414

1515
The `Date` parameter of the Scheduler controls which month is displayed. It's the one containing the date.
1616

@@ -19,7 +19,6 @@ In this article:
1919

2020
* [View Parameters](#view-parameters)
2121
* [Example](#example)
22-
* [Resource Grouping](#resource-grouping-in-the-month-view)
2322

2423
## View Parameters
2524

@@ -140,16 +139,9 @@ If the `ItemsPerSlot` parameter is a zero or a negative value, an `ArgumentOutOf
140139
}
141140
````
142141

143-
## Resource Grouping in the Month View
144-
145-
You can configure the Month view to display appointments that are [grouped by a resource]({%slug scheduler-resource-grouping%}).
146-
147-
>caption Resource Grouping in a Month view.
148-
149-
@[template](/_contentTemplates/scheduler/views.md#resource-grouping-code-snippet-for-examples)
150-
151142
## See Also
152143

153144
* [Views]({%slug scheduler-views-overview%})
154145
* [Navigation]({%slug scheduler-navigation%})
155146
* [Live Demo: Scheduler Month View](https://demos.telerik.com/blazor-ui/scheduler/month-view)
147+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)

components/scheduler/views/multiday.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@ description: MultiDay View in the Scheduler for Blazor.
55
slug: scheduler-views-multiday
66
tags: telerik,blazor,scheduler,view,multiday
77
published: True
8-
position: 2
8+
position: 3
99
---
1010

1111
# MultiDay View
1212

13-
The MultiDay view of the Scheduler for Blazor shows several days at once to the user.
13+
The MultiDay view of the Scheduler for Blazor shows several days at once to the user. Also the MultiDay view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%}).
1414

15-
The `Date` parameter of the scheduler controls which is the first rendered date, and the `NumberOfDays` parameter of the View controls how many days will be rendered.
15+
The `Date` parameter of the scheduler controls which is the first rendered date, and the `NumberOfDays` parameter of the View controls how many days will be rendered.
1616

1717
In this article:
1818

1919
* [View Parameters](#view-parameters)
2020
* [Slots](#slots)
2121
* [Example](#example)
22-
* [Resource Grouping](#resource-grouping-in-the-multiday-view)
2322

2423
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
2524
* `NumberOfDays` - how many days will be rendered side-by-side in the view.
@@ -98,16 +97,10 @@ In this article:
9897
}
9998
````
10099

101-
## Resource Grouping in the MultiDay View
102-
103-
You can configure the MultiDay view to display events that are [grouped by a resource]({%slug scheduler-resource-grouping%}).
104-
105-
>caption Resource Grouping in a MultiDay view.
106-
107-
@[template](/_contentTemplates/scheduler/views.md#resource-grouping-code-snippet-for-examples)
108-
109100
## See Also
110101

111102
* [Views]({%slug scheduler-views-overview%})
112103
* [Navigation]({%slug scheduler-navigation%})
113104
* [Live Demo: Scheduler MultiDay View](https://demos.telerik.com/blazor-ui/scheduler/multiday-view)
105+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)
106+

components/scheduler/views/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@ You can read more about this in the [Navigation]({%slug scheduler-navigation%})
2121
The available views are:
2222

2323
* [Scheduler**Day**View]({%slug scheduler-views-day%})
24-
* [Scheduler**MultiDay**View]({%slug scheduler-views-multiday%})
2524
* [Scheduler**Week**View]({%slug scheduler-views-week%})
25+
* [Scheduler**MultiDay**View]({%slug scheduler-views-multiday%})
2626
* [Scheduler**Month**View]({%slug scheduler-views-month%})
2727
* [Scheduler**Timeline**View]({%slug scheduler-views-timeline%})
28+
* [Scheduler**Agenda**View]({%slug scheduler-views-agenda%})
2829

2930
>caption Allow the user to navigate between Day and Week views only by defining only them. Example how to choose starting View (Week) and Date (29 Nov 2019).
3031

components/scheduler/views/timeline.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,18 @@ description: Timeline View in the Scheduler for Blazor.
55
slug: scheduler-views-timeline
66
tags: telerik,blazor,scheduler,view,timeline
77
published: True
8-
position: 1
8+
position: 5
99
---
1010

1111
# Timeline View
1212

13-
The Timeline view displays appointments in a continuous horizontal direction.
13+
The Timeline view displays appointments in a continuous horizontal direction. Also the Timeline view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%})
1414

1515
In this article:
1616

1717
* [View Parameters](#view-parameters)
1818
* [Slots](#slots)
1919
* [Example](#example)
20-
* [Resource Grouping](#resource-grouping-in-the-timeline-view)
2120

2221
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
2322
| `ColumnWidth` | `decimal` | The width of each time column in pixels.
@@ -98,16 +97,10 @@ In this article:
9897
}
9998
````
10099

101-
## Resource Grouping in the Timeline View
102-
103-
You can configure the Timeline view to display events that are [grouped by a resource]({%slug scheduler-resource-grouping%}).
104-
105-
>caption Resource Grouping in a Timeline view.
106-
107-
@[template](/_contentTemplates/scheduler/views.md#resource-grouping-vertical-code-snippet-for-examples)
108-
109100
## See Also
110101

111102
* [Views]({%slug scheduler-views-overview%})
112103
* [Navigation]({%slug scheduler-navigation%})
113104
* [Live Demo: Scheduler Timeline View](https://demos.telerik.com/blazor-ui/scheduler/timeline-view)
105+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)
106+

components/scheduler/views/week.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ description: Week View in the Scheduler for Blazor.
55
slug: scheduler-views-week
66
tags: telerik,blazor,scheduler,view,week
77
published: True
8-
position: 3
8+
position: 2
99
---
1010

1111
# Week View
1212

13-
The Week view of the scheduler shows the entire week to the user.
13+
The Week view of the scheduler shows the entire week to the user. Also the Week view can be configured to display the events that are [grouped by resource]({%slug scheduler-resource-grouping%})
1414

1515
The `Date` parameter of the scheduler controls which week is displayed. The first day depends on the current culture's `FirstDayOfWeek`.
1616

@@ -19,7 +19,6 @@ In this article:
1919
* [View Parameters](#view-parameters)
2020
* [Slots](#slots)
2121
* [Example](#example)
22-
* [Resource Grouping](#resource-grouping-in-the-week-view)
2322

2423
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
2524

@@ -96,16 +95,10 @@ In this article:
9695
}
9796
````
9897

99-
## Resource Grouping in the Week View
100-
101-
You can configure the Week view to display events that are [grouped by a resource]({%slug scheduler-resource-grouping%}).
102-
103-
>caption Resource Grouping in a Week view.
104-
105-
@[template](/_contentTemplates/scheduler/views.md#resource-grouping-code-snippet-for-examples)
106-
10798
## See Also
10899

109100
* [Views]({%slug scheduler-views-overview%})
110101
* [Navigation]({%slug scheduler-navigation%})
111102
* [Live Demo: Scheduler Week View](https://demos.telerik.com/blazor-ui/scheduler/week-view)
103+
* [Resource Grouping Example]({%slug scheduler-resource-grouping%}#resource-grouping-by-one-resource)
104+

0 commit comments

Comments
 (0)