Scheduler: describe getOccurrences + Occurence API#8529
Scheduler: describe getOccurrences + Occurence API#8529vladaskorohodova wants to merge 5 commits intoDevExpress:26_1from
Conversation
...nce/10 UI Components/dxScheduler/3 Methods/getOccurrences(startDate_endDate_appointments).md
Outdated
Show resolved
Hide resolved
...nce/10 UI Components/dxScheduler/3 Methods/getOccurrences(startDate_endDate_appointments).md
Outdated
Show resolved
Hide resolved
api-reference/10 UI Components/dxScheduler/9 Types/Occurrence/Occurrence.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
| --- | ||
| ##### shortDescription | ||
| <!-- Description goes here --> | ||
| The start date of the appointment occurrence. |
There was a problem hiding this comment.
The shortDescription sections in this docs set typically keep the content indented under the heading (the placeholder line you replaced was indented). To avoid breaking the doc generator’s parsing/formatting, keep the same indentation level used by the placeholder. Apply the same formatting fix to endDate.md, appointmentData.md, and Occurrence.md shortDescription blocks as well.
| The start date of the appointment occurrence. | |
| The start date of the appointment occurrence. |
| startDate: new Date(2026, 1, 1, 9, 0), | ||
| endDate: new Date(2026, 1, 6, 10, 0), | ||
| recurrenceRule: 'FREQ=DAILY;COUNT=5' |
There was a problem hiding this comment.
The example’s dates/durations don’t match the comment: (1) the recurring "Meeting" has a ~5-day duration (endDate is Feb 6 while startDate is Feb 1), which will produce multi-day overlapping occurrences rather than a 1-hour meeting; (2) new Date(2026, 1, 4) is Feb 4 at 00:00, so an occurrence on Feb 4 at 09:00 would likely be excluded—making “February 2–4” inaccurate. Adjust the meeting endDate to preserve the intended appointment duration (e.g., same day 10:00), and either change the interval end to include Feb 4’s occurrences (e.g., Feb 5 00:00 / end-of-day) or update the comment to reflect the actual returned range.
| // Returns occurrences of the "Meeting" appointment for February 2-4, 2026 and the "Call" appointment for February 3, 2026: | ||
| const occurrences = scheduler.getOccurrences(new Date(2026, 1, 2), new Date(2026, 1, 4), appointments); |
There was a problem hiding this comment.
The example’s dates/durations don’t match the comment: (1) the recurring "Meeting" has a ~5-day duration (endDate is Feb 6 while startDate is Feb 1), which will produce multi-day overlapping occurrences rather than a 1-hour meeting; (2) new Date(2026, 1, 4) is Feb 4 at 00:00, so an occurrence on Feb 4 at 09:00 would likely be excluded—making “February 2–4” inaccurate. Adjust the meeting endDate to preserve the intended appointment duration (e.g., same day 10:00), and either change the interval end to include Feb 4’s occurrences (e.g., Feb 5 00:00 / end-of-day) or update the comment to reflect the actual returned range.
|
|
||
| ##### param(startDate): Date | ||
| <!-- Description goes here --> | ||
| The start date of the time interval. |
There was a problem hiding this comment.
| The start date of the time interval. | |
| The start date of the interval. |
|
|
||
| ##### param(endDate): Date | ||
| <!-- Description goes here --> | ||
| The end date of the time interval. |
There was a problem hiding this comment.
| The end date of the time interval. | |
| The end date of the interval. |
| --- | ||
| ##### shortDescription | ||
| <!-- Description goes here --> | ||
| Gets an array of appointment occurrences that fall within a specified time interval. |
There was a problem hiding this comment.
| Gets an array of appointment occurrences that fall within a specified time interval. | |
| Gets an array of appointment occurrences that fall within a specified interval. |
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| An occurrence is an appointment instance that falls within the specified time interval. Recurring appointments can generate multiple occurrences. |
There was a problem hiding this comment.
| An occurrence is an appointment instance that falls within the specified time interval. Recurring appointments can generate multiple occurrences. | |
| An occurrence is an appointment instance that falls within the specified interval. Recurring appointments can generate multiple occurrences. |
|
|
||
| --- | ||
| <!-- Description goes here --> No newline at end of file | ||
| An occurrence is an appointment instance that falls within the specified time interval. Recurring appointments can generate multiple occurrences. No newline at end of file |
There was a problem hiding this comment.
| An occurrence is an appointment instance that falls within the specified time interval. Recurring appointments can generate multiple occurrences. | |
| An occurrence is an appointment instance that falls within the specified interval. Recurring appointments can generate multiple occurrences. |
No description provided.