Hooks
Hook functions for use in Functional React Components.
Global Functions
| Name | Description | |
|---|---|---|
| useActiveIModelConnection | React hook that maintains the active IModelConnection. | |
| useActiveStageId | React hook that maintains the active stage Id. | |
| useActiveViewport | React hook that maintains the active viewport. | |
| useAnalysisAnimationDataProvider | Hook that returns either a AnalysisAnimationTimelineDataProvider or undefined based on if the supplied viewport contains analysis data. | |
| useScheduleAnimationDataProvider | Hook that returns either a ScheduleAnimationTimelineDataProvider or undefined based on if the supplied viewport contains schedule script. | |
| useSolarDataProvider | Hook that returns either a SolarTimelineDataProvider or undefined based on if the supplied viewport's display style is set to display shadows. |
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.