Skip to content

Commit 48d314c

Browse files
docs(scheduler): improve view parameters explanations
1 parent 6895555 commit 48d314c

File tree

4 files changed

+14
-3
lines changed

4 files changed

+14
-3
lines changed

_contentTemplates/scheduler/views.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,22 @@ Generally, the views are designed around the timeframe that they show and the da
1111

1212
* `WorkDayStart` - the counterpart to `WorkDayStart` - defines when the working day ends.
1313

14-
If there are appointments outside of the defined visible time the user will not be able to see them. For most cases where the working day is subject to scheduling this may not be a problem, but if your users need to manage night shifts or irregular work hours, you may want to have a longer day rendered, or to bind the value to a time picker so the user can alter it themselves.
14+
* `SlotDuration` - the time span of each major time slot in minutes.
1515

16+
* `SlotDivisions` - the number of partitions in each major time slot.
17+
#end
1618

19+
#visible-times-tip
20+
If there are appointments outside of the defined visible time the user will not be able to see them. For most cases where the working day is subject to scheduling this may not be a problem, but if your users need to manage night shifts or irregular work hours, you may want to have a longer day rendered, or to bind the value to a time picker so the user can alter it themselves.
1721
#end
1822

1923
#day-slots-explanation
2024
### Slots
2125

2226
Views that show hours let you control their precision through the `SlotDuration` and `SlotDivisions` parameters:
2327

24-
1. `SlotDuration` - the time between the hour markers.
25-
1. `SlotDivisions` - how many partitions each time between the hour markers is separated into.
28+
1. `SlotDuration` - the time span of each major time slot in minutes.
29+
1. `SlotDivisions` - the number of partitions in each major time slot.
2630

2731
>caption Figure: Slots explanation
2832

components/scheduler/views/day.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ In this article:
100100

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

103+
@[template](/_contentTemplates/scheduler/views.md#visible-times-tip)
104+
103105
@[template](/_contentTemplates/scheduler/views.md#day-slots-explanation)
104106

105107

components/scheduler/views/multiday.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ In this article:
101101

102102

103103
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
104+
* `NumberOfDays` - how many days will be rendered side-by-side in the view.
105+
106+
@[template](/_contentTemplates/scheduler/views.md#visible-times-tip)
104107

105108
@[template](/_contentTemplates/scheduler/views.md#day-slots-explanation)
106109

components/scheduler/views/week.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ In this article:
102102

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

105+
@[template](/_contentTemplates/scheduler/views.md#visible-times-tip)
106+
105107
@[template](/_contentTemplates/scheduler/views.md#day-slots-explanation)
106108

107109

0 commit comments

Comments
 (0)