API Reference > frontend-devTools > Tools > ChangeHiliteSettingsTool

ChangeHiliteSettingsTool Class

Beta  

Changes the selected viewport's hilite settings, or resets to defaults.

Extends

Methods

Name Description
constructor(..._args: any[]): ChangeHiliteSettingsTool    
apply(vp: Viewport, settings?: Settings): void Protected    
getCurrentSettings(vp: Viewport): Settings Protected    

Inherited methods

Name Inherited from Description
parseAndRun(...inputArgs: string[]): boolean ChangeHiliteTool  
run(settings?: Settings): boolean ChangeHiliteTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static ChangeHiliteTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string ChangeHiliteTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string ChangeHiliteTool 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,
ChangeHiliteTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string ChangeHiliteTool 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 ChangeHiliteTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string ChangeHiliteTool 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,
ChangeHiliteTool.keyin is returned.
hidden Static boolean ChangeHiliteTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N ChangeHiliteTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string ChangeHiliteTool Get the iconSpec from this Tool's class.
iconSpec Static string ChangeHiliteTool The icon for this Tool.
keyin Accessor ReadOnly string ChangeHiliteTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string ChangeHiliteTool 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").
maxArgs Accessor StaticReadOnly number ChangeHiliteTool  
minArgs Accessor StaticReadOnly number ChangeHiliteTool  
namespace Static I18NNamespace ChangeHiliteTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string ChangeHiliteTool 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: 12 June, 2024