API Reference › appui-react › Tools

Tools

Core Tool definitions

Classes

Name Description  
CoreTools Utility Class that provides definitions of tools provided by the core-frontend core.  
FrameworkToolAdmin Subclass of ToolAdmin in @itwin/core-frontend to be used to initialize IModelApp.  
HideIsolateEmphasizeActionHandler Interface for class that handles Hide, Isolate, and Emphasize Actions  
HideIsolateEmphasizeManager Provides helper functions for doing commands on logical selection like categories and subjects.  
RestoreAllFrontstagesTool Immediate tool that will reset the layout of all frontstages to that specified in the stage definition.  
RestoreFrontstageLayoutTool Immediate tool that will reset the layout to that specified in the stage definition.  
SelectionContextToolDefinitions Utility Class that provides definitions for tools dependent on current selection.  

Enumerations

Name Description  
HideIsolateEmphasizeAction Supported Hide, Isolate, and Emphasize Actions.  
KeyinFieldLocalization Controls whether localized and/or non-localized key-in strings appear in a KeyinField's auto-completion list.  

Global Functions

Name Description  
areNoFeatureOverridesActive return ConditionalBooleanValue object used to show items if selection set is active.  
featureOverridesActiveStateFunc return state with isVisible set to true is SectionSet is active.  
getFeatureOverrideSyncEventIds return SyncEventIds that trigger selection state function refresh.  
getIsHiddenIfFeatureOverridesActive return ConditionalBooleanValue object used to show item if feature overrides are active.  
getIsHiddenIfSelectionNotActive return ConditionalBooleanValue object used to show items if selection set is active.  
getSelectionContextSyncEventIds return SyncEventIds that trigger selection state function refresh.  
isNoSelectionActive return SyncEventIds that trigger selection state function refresh.  
selectionContextStateFunc return state with isVisible set to true is SectionSet is active.  

Interfaces

Name Description  
EmphasizeElementsChangedArgs Selection Context Action Event Argument  
KeyinEntry Defines a keyin entry to show/filter in UI  

Last Updated: 21 March, 2024