EmphasizeElements Class

Beta

An implementation of EmphasizeElements.FeatureOverrideProvider for emphasizing selected elements through simple color/transparency appearance overrides.

Implements

Methods

Name Description
addFeatureOverrides(overrides: FeatureSymbology.Overrides, vp: Viewport): void Establish active feature overrides to emphasize elements and apply color/transparency overrides.  
clearAlwaysDrawnElements(vp: Viewport): boolean Clear always drawn elements.  
clearEmphasizedElements(vp: Viewport): boolean Clear emphasized elements.  
clearEmphasizedIsolatedElements(vp: Viewport, setToAlwaysDrawn: boolean): boolean Clear emphasized isolated elements.  
clearHiddenElements(vp: Viewport): boolean Clear hidden elements.  
clearIsolatedElements(vp: Viewport): boolean Clear isolated elements.  
clearNeverDrawnElements(vp: Viewport): boolean Clear never drawn elements.  
clearOverriddenElements(vp: Viewport, key?: number): boolean Clear elements with color/transparency overrides.  
createDefaultAppearance(): FeatureSymbology.Appearance Create default appearance to use for emphasizeElements when not supplied by caller.  
createOverrideKey(color: ColorDef, override: FeatureOverrideType): number | undefined Get override key from color and override type  
emphasizeElements(ids: Id64Arg, vp: Viewport, defaultAppearance?: FeatureSymbology.Appearance, replace: boolean = true): boolean Set the element IDs to be always drawn normally with all other elements in the view overridden to draw using a default appearance..  
emphasizeSelectedElements(vp: Viewport, defaultAppearance?: FeatureSymbology.Appearance, replace: boolean = true, clearSelection: boolean = true): boolean Set the currently selected elements to be always drawn normally with all other elements in the view overridden to draw using a default appearance.  
fromJSON(props: EmphasizeElementsProps, vp: Viewport): boolean    
getAlwaysDrawnElements(vp: Viewport): Id64Set | undefined Get the IDs of the currently always drawn elements.  
getEmphasizedElements(vp: Viewport): Id64Set | undefined Get the IDs of the currently emphasized elements.  
getEmphasizedIsolatedElements(): Id64Set | undefined Get the IDs of the currently emphasized isolated elements.  
getHiddenElements(vp: Viewport): Id64Set | undefined Get the IDs of the currently hidden elements.  
getIsolatedElements(vp: Viewport): Id64Set | undefined Get the IDs of the currently isolated elements.  
getNeverDrawnElements(vp: Viewport): Id64Set | undefined Get the IDs of the currently never drawn elements.  
getOverriddenElements(): Map<number, Id64Set> | undefined Get the map of current elements with color/transparency overrides.  
getOverriddenElementsByKey(key: number): Id64Set | undefined Get the IDs of current elements with the specified color/transparency override.  
getOverrideFromKey(key: number, color: ColorDef): FeatureOverrideType Get color and override type for the given key.  
hideElements(ids: Id64Arg, vp: Viewport, replace: boolean = false): boolean Set the element IDs to be never drawn.  
hideSelectedElements(vp: Viewport, replace: boolean = false, clearSelection: boolean = true): boolean Set the currently selected elements to be never drawn.  
isActive(vp: Viewport): boolean    
isolateElements(ids: Id64Arg, vp: Viewport, replace: boolean = true): boolean Set the element IDs to be always drawn exclusively.  
isolateSelectedElements(vp: Viewport, replace: boolean = true, clearSelection: boolean = true): boolean Set the currently selected elements to be always drawn exclusively.  
overrideElements(ids: Id64Arg, vp: Viewport, color: ColorDef, override: FeatureOverrideType = FeatureOverrideType.ColorOnly, replace: boolean = false): boolean Set the element IDs to display with a color/transparency override.  
overrideSelectedElements(vp: Viewport, color: ColorDef, override: FeatureOverrideType = FeatureOverrideType.ColorOnly, replace: boolean = false, clearSelection: boolean = true): boolean Set the currently selected elements to display with a color/transparency override.  
toJSON(vp: Viewport): EmphasizeElementsProps    
clear(vp: Viewport, inactiveOnly: boolean = false): void Static Clear current Viewport.featureOverrideProvider if it's an instance of EmphasizeElements.  
get(vp: Viewport): EmphasizeElements | undefined Static Get current Viewport.featureOverrideProvider if it's an instance of EmphasizeElements.  
getOrCreate(vp: Viewport): EmphasizeElements Static Get or replace current Viewport.featureOverrideProvider with an instance of EmphasizeElements.  

Properties

Name Type Description
defaultAppearance Accessor FeatureSymbology.Appearance | undefined Get the current default appearance such as used by emphasizeElements.  

Defined in

Last Updated: 20 September, 2019