API Reference › appui-react › Tools › HideIsolateEmphasizeManager

HideIsolateEmphasizeManager Class

Provides helper functions for doing commands on logical selection like categories and subjects.

Extends

Methods

Name Description
constructor(): HideIsolateEmphasizeManager    
areFeatureOverridesActive(vp: Viewport): boolean Checks to see if any featureOverrideProviders are active  
processClearEmphasize(): Promise<void> Function that is run when ClearEmphasize tool button is pressed  
processClearOverrideCategories(): Promise<void> Function that is run when ClearOverrideCategories tool button is pressed  
processClearOverrideModels(): Promise<void> Function that is run when ClearOverrideModels tool button is pressed  
processEmphasizeSelected(): Promise<void> Function that is run when EmphasizeSelected tool button is pressed  
processHideSelected(): Promise<void> Function that is run when HideSelected tool button is pressed  
processHideSelectedElementsCategory(): Promise<void> Function that is run when HideSelectedElementsCategory tool button is pressed  
processHideSelectedElementsModel(): Promise<void> Function that is run when HideSelectedElementsModel tool button is pressed  
processIsolateSelected(clearSelection: boolean = true): Promise<void> Function that is run when IsolateSelected tool button is pressed  
processIsolateSelectedElementsCategory(): Promise<void> Function that is run when IsolateSelectedElementsCategory tool button is pressed  
processIsolateSelectedElementsModel(): Promise<void> Function that is run when IsolateSelectedElementsModel tool button is pressed  
clearEmphasize(vp: undefined | Viewport): void Static Clear Hidden,Isolated, or Emphasized elements in specified view  
clearOverrideCategories(vp: Viewport): void Static Clear (restore) the previously hidden categories hidden by hideSelectedElementsCategory  
clearOverrideModels(vp: Viewport): void Static Clear (restore) the previously hidden/isolated models hidden by hideSelectedElementsModel  
emphasizeSelected(vp: Viewport, emphasisSilhouette: boolean = true): Promise<void> Static Emphasize the selected elements from either presentation layer's logical selection or selected graphics  
emphasizeSelectedCategory(vp: Viewport): Promise<void> Static Emphasize hilited categories.  
getCategoryOverrides(vp: Viewport): undefined | Set<string> Static Return the list of category overrides (hidden or isolated categories)  
getModelOverrides(vp: Viewport): undefined | Set<string> Static Return the list of model overrides (hidden or isolated models)  
hideCommand(vp: Viewport): Promise<void> Static Hide either based on Presentation selection, if defined, else the selected graphic elements  
hideSelected(vp: Viewport): void Static Hide the selected elements  
hideSelectedElementsCategory(vp: Viewport): Promise<void> Static Hide the categories defined by the elements in the current SelectionSet  
hideSelectedElementsModel(vp: Viewport): Promise<void> Static Hide the models defined by the elements in the current SelectionSet  
isOverrideCategories(vp: Viewport): boolean Static Determine if categories are hidden by hideSelectedElementsCategory or isolateSelectedElementsCategory  
isOverrideModels(vp: Viewport): boolean Static Determine if models are hidden by hideSelectedElementsModel or isolateSelectedElementsModel  
isolateCommand(vp: Viewport): Promise<void> Static Isolate either based on Presentation selection, if defined, else the selected graphic elements  
isolateSelected(vp: Viewport): void Static Isolate the selected elements  
isolateSelectedElementsCategory(vp: Viewport): Promise<void> Static Isolate the selected category found in SelectionSet elements  
isolateSelectedElementsModel(vp: Viewport): Promise<void> Static Isolate model from selected elements  
isolateSelectedModel(vp: Viewport): Promise<void> Static Isolate hilited models.  
updateCategoryOverride(vp: Viewport, ids: string[]): void Static Add category ids to the category override cache (hidden or isolated categories)  
updateModelOverride(vp: Viewport, ids: string[]): void Static Add model ids to the model override cache (hidden or isolated models)  

Inherited properties

Name Type Inherited from Description
emphasizeElementsChanged Static BeEvent<(args: EmphasizeElementsChangedArgs) => void> HideIsolateEmphasizeActionHandler  
hideIsolateEmphasizeUiSyncId Accessor StaticReadOnly string HideIsolateEmphasizeActionHandler String Id sent to allow UI to refresh its display state.

Defined in

Last Updated: 05 April, 2024