API Reference > frontend-devTools > Tools > EmphasizeSelectedElementsTool

EmphasizeSelectedElementsTool Class

Beta  

If any elements are selected, emphasize them all by overriding their color to be orange; and de-emphasize all other elements by drawing them transparent grey.

Extends

Methods

Name Description
constructor(..._args: any[]): EmphasizeSelectedElementsTool    
execute(emph: EmphasizeElements, vp: ScreenViewport): void    
parseAndRun(...args: string[]): boolean Run this instance of a tool using a series of string arguments.  

Inherited methods

Name Inherited from Description
run(_args: any[]): boolean EmphasizeElementsTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static EmphasizeElementsTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
maxArgs Accessor StaticReadOnly number    
minArgs Accessor StaticReadOnly number    
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
_wantClear Accessor ProtectedReadOnly boolean EmphasizeElementsTool  
_wantCreate Accessor ProtectedReadOnly boolean EmphasizeElementsTool  
description Accessor ReadOnly string EmphasizeElementsTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string EmphasizeElementsTool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
EmphasizeElementsTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string EmphasizeElementsTool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor ReadOnly string EmphasizeElementsTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string EmphasizeElementsTool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
EmphasizeElementsTool.keyin is returned.
hidden Static boolean EmphasizeElementsTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N EmphasizeElementsTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string EmphasizeElementsTool Get the iconSpec from this Tool's class.
iconSpec Static string EmphasizeElementsTool The icon for this Tool.
keyin Accessor ReadOnly string EmphasizeElementsTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string EmphasizeElementsTool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
namespace Static I18NNamespace EmphasizeElementsTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string EmphasizeElementsTool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localize
the keyin, description, etc. from the current locale.

Defined in

Last Updated: 11 June, 2024