Skip to content

Scheduler: Add snapToCellsMode API Desc.#8599

Open
arman-boyakhchyan wants to merge 12 commits intoDevExpress:26_1from
arman-boyakhchyan:scheduler-snaptocellsmode-26-1
Open

Scheduler: Add snapToCellsMode API Desc.#8599
arman-boyakhchyan wants to merge 12 commits intoDevExpress:26_1from
arman-boyakhchyan:scheduler-snaptocellsmode-26-1

Conversation

@arman-boyakhchyan
Copy link
Copy Markdown
Contributor

No description provided.

@arman-boyakhchyan arman-boyakhchyan self-assigned this Mar 24, 2026
Copilot AI review requested due to automatic review settings March 24, 2026 06:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation for the snapToCellsMode API in dxScheduler and makes the corresponding enum/type visible (instead of hidden).

Changes:

  • Moved Enums.SnapToCellsMode doc from _hidden into the public dxScheduler “Types” section and added value descriptions.
  • Added detailed descriptions (including per-view defaults) to dxScheduler.Options.snapToCellsMode and dxScheduler.Options.views.snapToCellsMode.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
api-reference/_hidden/Enums/SnapToCellsMode.md Removes the hidden placeholder enum doc.
api-reference/10 UI Components/dxScheduler/9 Types/SnapToCellsMode.md Adds public enum/type doc with value semantics.
api-reference/10 UI Components/dxScheduler/1 Configuration/views/snapToCellsMode.md Documents view-specific snapToCellsMode behavior and defaults.
api-reference/10 UI Components/dxScheduler/1 Configuration/snapToCellsMode.md Documents global snapToCellsMode behavior and defaults.

Copilot AI review requested due to automatic review settings March 26, 2026 11:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Copilot AI review requested due to automatic review settings March 27, 2026 07:32
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Co-authored-by: Vladimir Abadzhev <vladimira@devexpress.com>
Copilot AI review requested due to automatic review settings March 31, 2026 07:28
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

Comment on lines +7 to +11
Specifies how the Scheduler component snaps appointments to grid (applies to all view types).

---
<!-- Description goes here --> No newline at end of file
If a Scheduler is bound to a [dataSource](/Documentation/ApiReference/UI_Components/dxScheduler/Configuration/#dataSource), it can snap appointments to grid. If this functionality is active, the Scheduler increases appointment dimensions (never shrinks appointments).

Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The phrasing is grammatically incomplete in a few places (for example, “snaps appointments to grid” should be “to the grid”/“to grid cells”), and the first paragraph starts with an introductory dependent clause (“If a Scheduler is bound…, …”). Consider rewriting these sentences to use direct active voice and consistent articles (for example, start with “Bind the Scheduler to a dataSource to enable…”).

Copilot uses AI. Check for mistakes.
Comment on lines +7 to +11
Specifies how a Scheduler View snaps appointments to grid.

---
<!-- Description goes here --> No newline at end of file
If a Scheduler is bound to a [dataSource](/Documentation/ApiReference/UI_Components/dxScheduler/Configuration/#dataSource), you can snap appointments to grid. If this functionality is active, the Scheduler increases appointment dimensions (never shrinks appointments).

Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the component-level option, a few sentences are missing articles (“to grid” → “to the grid”/“to grid cells”) and start with an introductory dependent clause (“If a Scheduler is bound…, …”). Consider rewriting for direct active voice (for example, “Bind the Scheduler to a dataSource to enable…”).

Copilot uses AI. Check for mistakes.
Comment on lines +9 to +16
Specifies how Scheduler snaps appointments to grid.

---
The following **snapToCellsMode** values are available:

- *"always"*: Scheduler snaps all appointments to grid.
- *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell.
- *"never"*: Scheduler does not snap appointments to grid. No newline at end of file
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The enum’s short description and value descriptions are inconsistent with the corresponding option docs (for example, "always" is described as "Appointments occupy cells fully" here, but the option pages describe snapping behavior; "never" mentions dimension changes instead of snapping). To avoid confusing readers, align the enum’s wording with the option descriptions and use consistent phrasing (for example, “the Scheduler … the grid”).

Suggested change
Specifies how Scheduler snaps appointments to grid.
---
The following **snapToCellsMode** values are available:
- *"always"*: Scheduler snaps all appointments to grid.
- *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell.
- *"never"*: Scheduler does not snap appointments to grid.
Specifies how the Scheduler snaps appointments to the grid.
---
The following **snapToCellsMode** values are available:
- *"always"*: The Scheduler always snaps appointments to the grid.
- *"auto"*: The Scheduler snaps an appointment to the grid if it occupies more than half of a cell.
- *"never"*: The Scheduler never snaps appointments to the grid.

Copilot uses AI. Check for mistakes.
Co-authored-by: dirkpieterse <dirk.pieterse@devexpress.com>
Copilot AI review requested due to automatic review settings April 2, 2026 14:59
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

---
##### shortDescription
<!-- Description goes here -->
Specifies how the Scheduler component snaps appointments to the grid (applies to all view types).
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this short description, "snaps appointments to grid" is missing the article "the". For consistency with the view-level documentation in this PR, consider using "to the grid".

Copilot uses AI. Check for mistakes.

---
<!-- Description goes here --> No newline at end of file
The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence is missing the definite article at the beginning. Consider changing "Scheduler can snap..." to "The Scheduler can snap..." to match the style used elsewhere in the Scheduler docs and in the view-level description added in this PR.

Copilot uses AI. Check for mistakes.
Comment on lines +14 to +16
- *"always"*: Scheduler snaps all appointments to the grid.
- *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell.
- *"never"*: Scheduler does not snap appointments to the grid.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These bullet descriptions omit the article in "to grid". For readability and consistency with the view-level snapToCellsMode doc, use "to the grid" in each bullet.

Copilot uses AI. Check for mistakes.
The following **snapToCellsMode** values are available:

- *"always"*: Scheduler snaps all appointments to the grid.
- *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell.
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These bullet descriptions omit the article in "to grid". For readability and consistency with the configuration-level docs in this PR, use "to the grid" in each bullet.

Suggested change
- *"auto"*: Appointments that cover more than half of a cell are stretched to occupy the entire cell.
- *"auto"*: Appointments that cover more than half of a cell are snapped to the grid and stretched to occupy the entire cell.

Copilot uses AI. Check for mistakes.
Copilot AI review requested due to automatic review settings April 3, 2026 10:49
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

---
##### shortDescription
<!-- Description goes here -->
Specifies how the Scheduler component snaps appointments to the grid (applies to all view types).
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The shortDescription says this setting "applies to all view types", but the note below states that the "agenda" view ignores this property. Please adjust the shortDescription to exclude agenda (or rephrase to avoid implying it applies to every view type).

Suggested change
Specifies how the Scheduler component snaps appointments to the grid (applies to all view types).
Specifies how the Scheduler component snaps appointments to the grid.

Copilot uses AI. Check for mistakes.
Comment on lines +18 to +32
The default **snapToCellsMode** value varies by view:

<table class="dx-table">
<tr>
<th>Value</th>
<th>Scheduler Views</th>
</tr>
<tr>
<td><i>"never"</i></td>
<td><i>"day"</i>, <i>"week"</i>, <i>"workWeek"</i>, <i>"timelineDay"</i>, <i>"timelineWeek"</i>, <i>"timelineWorkWeek"</i></td>
</tr>
<tr>
<td><i>"always"</i></td>
<td><i>"month"</i>, <i>"timelineMonth"</i></td>
</tr>
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section says the default snapToCellsMode value varies by view, but the table does not mention the "agenda" view (which is called out later as ignoring the property). Consider clarifying that the table applies only to views where snapToCellsMode is respected, or add an explicit agenda entry (for example, "ignored").

Copilot uses AI. Check for mistakes.

---
<!-- Description goes here --> No newline at end of file
The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them.
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"When this feature is enabled" is ambiguous because snapToCellsMode itself controls whether snapping is enabled. Consider explicitly stating which values enable snapping (for example, that snapping is disabled when the value is "never").

Suggested change
The Scheduler can snap appointments to the grid. When this feature is enabled, the component increases appointment dimensions and never reduces them.
The Scheduler can snap appointments to the grid. When **snapToCellsMode** is set to *"always"* or *"auto"*, the component increases appointment dimensions and never reduces them.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants