Skip to content

Add local state selectStorey options documentation #101

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
Kurtil merged 1 commit into from
Oct 15, 2025
Merged

Add local state selectStorey options documentation #101

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/viewer/reference/local_context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ interface LocalContext extends Context {
readonly selectedStorey: StateStorey | null;
loadModels(ids: number[]): Promise<boolean>;
unloadModels(ids: number[]): boolean;
selectStorey(storey: StateStorey): void;
selectStorey(storey: StateStorey, { showPlans?: boolean, fitViewRequested?: boolean }): void;
Comment on lines 43 to +46
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

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

Type inconsistency: The interface definition uses StateStorey but the documentation table uses Storey. Both should use the same type for consistency.

Copilot uses AI. Check for mistakes.
showPlan(plan: StatePlan): void;
hidePlan(plan: StatePlan): void;

Expand Down Expand Up @@ -85,7 +85,7 @@ To manage models, storeys and plans for a given context you can use the `localCo
| **methods** | |
| `loadModels(ids: number[])` | Load the given models in this context |
| `unloadModels(ids: number[])` | Unload the given models from this context |
| `selectStorey(storey: Storey)` | Set storey as the current storey |
| `selectStorey(storey: Storey, { showPlans?: boolean, fitViewRequested?: boolean })` | Set storey as the current storey. If `showPlans` is `false` (default to `true`), the corresponding storey plans are not shown. `fitViewRequested` (default to `true`) is an hint indicating to the `"storey-selected"` listeners that a fit view should be done. Usefull if a custom fit view is performed juste after selecting the storey. |
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

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

Corrected spelling of 'Usefull' to 'Useful' and 'juste' to 'just'.

Suggested change
| `selectStorey(storey: Storey, { showPlans?: boolean, fitViewRequested?: boolean })` | Set storey as the current storey. If `showPlans` is `false` (default to `true`), the corresponding storey plans are not shown. `fitViewRequested` (default to `true`) is an hint indicating to the `"storey-selected"` listeners that a fit view should be done. Usefull if a custom fit view is performed juste after selecting the storey. |
| `selectStorey(storey: Storey, { showPlans?: boolean, fitViewRequested?: boolean })` | Set storey as the current storey. If `showPlans` is `false` (default to `true`), the corresponding storey plans are not shown. `fitViewRequested` (default to `true`) is an hint indicating to the `"storey-selected"` listeners that a fit view should be done. Useful if a custom fit view is performed just after selecting the storey. |

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Oct 15, 2025

Choose a reason for hiding this comment

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

Type inconsistency: The interface definition uses StateStorey but the documentation table uses Storey. Both should use the same type for consistency.

Suggested change
| `selectStorey(storey: Storey, { showPlans?: boolean, fitViewRequested?: boolean })` | Set storey as the current storey. If `showPlans` is `false` (default to `true`), the corresponding storey plans are not shown. `fitViewRequested` (default to `true`) is an hint indicating to the `"storey-selected"` listeners that a fit view should be done. Usefull if a custom fit view is performed juste after selecting the storey. |
| `selectStorey(storey: StateStorey, { showPlans?: boolean, fitViewRequested?: boolean })` | Set storey as the current storey. If `showPlans` is `false` (default to `true`), the corresponding storey plans are not shown. `fitViewRequested` (default to `true`) is an hint indicating to the `"storey-selected"` listeners that a fit view should be done. Usefull if a custom fit view is performed juste after selecting the storey. |

Copilot uses AI. Check for mistakes.
| `showPlan(plan: Plan)` | Show plan |
| `hidePlan(plan: Plan)` | Hide plan |

Expand Down