Add local state selectStorey options documentation #101
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the optional parameters of the selectStorey method in the LocalContext interface, enhancing the API documentation with details about the showPlans and fitViewRequested options.
- Updated the method signature to include optional parameters object with
showPlansandfitViewRequestedboolean options - Added detailed documentation explaining the behavior and default values of these options
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| | `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. | |
There was a problem hiding this comment.
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. | |
Comment on lines
43
to
+46
| 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; |
There was a problem hiding this comment.
Type inconsistency: The interface definition uses StateStorey but the documentation table uses Storey. Both should use the same type for consistency.
| | `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. | |
There was a problem hiding this comment.
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. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.