Skip to content

Commit 980345b

Browse files
docs(Scheduler): add hide all day parameter (#2437)
* docs(Scheduler): add hide all day parameter * chore(Scheduler): apply changes as per comments
1 parent 3fd6cad commit 980345b

File tree

3 files changed

+21
-7
lines changed

3 files changed

+21
-7
lines changed

_contentTemplates/scheduler/views.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ Generally, the views are designed around the timeframe that they show and the da
77

88
| Attribute | Type and Default Value | Description |
99
|----------|----------|----------|
10-
| `StartTime` | `DateTime` | This is the first hour that is shown in the view. Defaults to midnight, so if you do not set it to a value close to the start of the working day, the user is likely to see only blank spaces before they scroll down.
11-
| `WorkDayStart` | `DateTime` | This is when the working day starts. The work hours have a different background than non-working hours so the user can distinguish them easily. This parameter also influences the "Show Business Hours" toggle.
12-
| `EndTime` | `DateTime` | The counterpart to `StartTime` - defines when the full day ends. Defaults to midnight. If you have the day end earlier you can reduce the amount of elements that render, but the user may not see some late appointments.
13-
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` - defines when the working day ends.
14-
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
10+
| `EndTime` | `DateTime` | The counterpart to `StartTime` — defines when the full day ends. Defaults to midnight. If you set the `EndTime` earlier than midnight, you reduce the elements that render, but the user may not see late appointments.
11+
| `HideAllDayRow` | `bool` | Determines whether to render the row for all-day appointments. If set to `true`, this row will be hidden.
1512
| `SlotDivisions` |`int` | The number of partitions in each major time slot.
13+
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
14+
| `StartTime` | `DateTime` | The first hour displayed in the view. Defaults to midnight. If not set to a value close to the start of the working day, the view may show blank spaces before scrolling down.
15+
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` — defines when the working day ends.
16+
| `WorkDayStart` | `DateTime` | The start time of the working day; differentiates work hours with a distinct background for easy identification. Influences the **Show Business Hours** toggle.
1617
#end
1718

1819
#visible-times-tip

components/scheduler/views/multiday.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In this article:
2222
* [Resource Grouping](#resource-grouping-in-the-multiday-view)
2323

2424
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
25-
* `NumberOfDays` - how many days will be rendered side-by-side in the view.
25+
| `NumberOfDays` | `int` <br/> `1` | How many days to show side by side in the view.
2626

2727
@[template](/_contentTemplates/scheduler/views.md#visible-times-tip)
2828

components/scheduler/views/timeline.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,22 @@ In this article:
1919
* [Example](#example)
2020
* [Resource Grouping](#resource-grouping-in-the-timeline-view)
2121

22-
@[template](/_contentTemplates/scheduler/views.md#day-views-common-properties)
22+
## View Parameters
23+
24+
Generally, the views are designed around the timeframe that they show and the day-based views share some common properties that you will likely have to set to provide a good user experience for the user:
25+
26+
@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)
27+
28+
| Attribute | Type and Default Value | Description |
29+
|----------|----------|----------|
2330
| `ColumnWidth` | `decimal` | The width of each time column in pixels.
31+
| `EndTime` | `DateTime` | The counterpart to `StartTime` &mdash; defines when the full day ends. Defaults to midnight. If you have the day end earlier you can reduce the amount of elements that render, but the user may not see some late appointments.
2432
| `NumberOfDays` | `int` <br/> `1` | How many days to show side by side in the view.
33+
| `SlotDivisions` |`int` | The number of partitions in each major time slot.
34+
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
35+
| `StartTime` | `DateTime` | The first hour displayed in the view. Defaults to midnight. If not set to a value close to the start of the working day, the view may show blank spaces before scrolling down.
36+
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` &mdash; defines when the working day ends.
37+
| `WorkDayStart` | `DateTime` | The start time of the working day; differentiates work hours with a distinct background for easy identification. Influences the **Show Business Hours** toggle.
2538

2639
@[template](/_contentTemplates/scheduler/views.md#visible-times-tip)
2740

0 commit comments

Comments
 (0)