Skip to content

docs: Document the model visualization contract (service-module + platform layers) - #2568

Open
oemebamo wants to merge 5 commits into
TimefoldAI:mainfrom
oemebamo:timefold-solver-enterprise-issues-815
Open

docs: Document the model visualization contract (service-module + platform layers)#2568
oemebamo wants to merge 5 commits into
TimefoldAI:mainfrom
oemebamo:timefold-solver-enterprise-issues-815

Conversation

@oemebamo

@oemebamo oemebamo commented Aug 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

cedricdhooge96
cedricdhooge96 reviewed Aug 4, 2026
View reviewed changes
Comment thread docs/src/modules/ROOT/pages/deploying-to-platform/visualization.adoc
@oemebamo
oemebamo marked this pull request as ready for review August 25, 2026 07:50
@oemebamo
oemebamo requested a review from triceo as a code owner August 25, 2026 07:50
cedricdhooge96
cedricdhooge96 reviewed Aug 25, 2026
View reviewed changes
Comment thread docs/src/modules/ROOT/pages/deploying-to-platform/visualization.adoc Outdated
TomCools
TomCools reviewed Aug 28, 2026
View reviewed changes
Comment thread docs/src/modules/ROOT/pages/deploying-to-platform/visualization.adoc
[#_calling_your_api_from_the_iframe]
== Calling your model's API from inside the iframe

The platform injects the following query parameters into the iframe's `src` URL:

@TomCools TomCools Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is no longer the main case. Yes it works, but the new one is by using messages between the frames. @oemebamo, want me to take this PR to the finish line?

TomCools
TomCools reviewed Aug 28, 2026
View reviewed changes
Comment thread docs/src/modules/ROOT/pages/deploying-to-platform/visualization.adoc
timefold.model.visualization.pages[1].label=Gantt chart
----

Each declared page has three required fields; omitting any of them fails the build.

@TomCools TomCools Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How does this help with routing? Are pages a new concept introduced with the specific front-end components? Is the KEY also a tab in the UI?

@TomCools TomCools Aug 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this required now? Or if this is not supplied, does it use "visualization" for whatever is in the UI folder?

TomCools
TomCools requested changes Aug 28, 2026
View reviewed changes

@TomCools TomCools left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See other comments

@triceo
triceo removed the request for review from rsynek August 28, 2026 12:21
@oemebamo

oemebamo commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator Author

Feedback from @muellerd that's useful to incorporate here:

Daniel Mueller at 2026-08-20 10:12 AM When working on the visualization, I was not sure what is feasible for the platform to handle/show. For the household pto planner, I wanted to be able to show detailed information if you click on a day of the calendar. I was thinking about either a popup or something like a sidebar where the information can be shown. Due to the fact that I didn’t know if a sidebar was possible, I went for the popup.

@triceo
triceo requested review from rsynek and removed request for triceo August 31, 2026 18:18
@oemebamo
oemebamo requested a review from a team September 7, 2026 14:46

This branch was successfully deployed

1 active and 1 inactive deployments
documentation (preview) — 3a707e99 Deployed Sep 10, 2026 by oemebamo via Build Documentation #687
View deployment
internal — 3a707e99 Deployed Sep 10, 2026 by oemebamo via approval_required #687
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TomCools TomCools TomCools requested changes
@cedricdhooge96 cedricdhooge96 cedricdhooge96 left review comments
@rsynek rsynek Awaiting requested review from rsynek rsynek is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@oemebamo @TomCools @cedricdhooge96