Skip to content

docs(Scheduler): add hide all day parameter #2437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2024
Merged

docs(Scheduler): add hide all day parameter #2437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f18a76e
docs(Scheduler): add hide all day parameter
xristianstefanov Oct 16, 2024
5609ab4
chore(Scheduler): apply changes as per comments
xristianstefanov Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions _contentTemplates/scheduler/views.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ Generally, the views are designed around the timeframe that they show and the da

| Attribute | Type and Default Value | Description |
|----------|----------|----------|
| `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.
| `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.
| `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.
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` - defines when the working day ends.
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
| `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.
| `HideAllDayRow` | `bool` | Determines whether to render the row for all-day appointments. If set to `true`, this row will be hidden.
| `SlotDivisions` |`int` | The number of partitions in each major time slot.
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
| `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.
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` — defines when the working day ends.
| `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.
#end

#visible-times-tip
Expand Down
2 changes: 1 addition & 1 deletion components/scheduler/views/multiday.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In this article:
* [Resource Grouping](#resource-grouping-in-the-multiday-view)

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

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

Expand Down
15 changes: 14 additions & 1 deletion components/scheduler/views/timeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,22 @@ In this article:
* [Example](#example)
* [Resource Grouping](#resource-grouping-in-the-timeline-view)

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

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:

@[template](/_contentTemplates/common/parameters-table-styles.md#table-layout)

| Attribute | Type and Default Value | Description |
|----------|----------|----------|
| `ColumnWidth` | `decimal` | The width of each time column in pixels.
| `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.
| `NumberOfDays` | `int` <br/> `1` | How many days to show side by side in the view.
| `SlotDivisions` |`int` | The number of partitions in each major time slot.
| `SlotDuration` | `int` | The time span of each major time slot in minutes.
| `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.
|`WorkDayEnd` | `DateTime` | The counterpart to `WorkDayStart` &mdash; defines when the working day ends.
| `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.

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

Expand Down
Loading