Hooks
Hook functions for use in Functional React Components.
Constants
| Name | Description | |
|---|---|---|
| FrameworkVersionContext | Deprecated |
Global Functions
| Name | Description | |
|---|---|---|
| FrameworkVersion | The FrameworkVersion component provides uiVersion context to react component. | Deprecated |
| 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. | |
| useFrameworkVersion | Deprecated | |
| 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. | Beta |
Interfaces
| Name | Description | |
|---|---|---|
| FrameworkVersionProps | Deprecated |
Last Updated: 30 November, 2023