API Reference › frontend-devTools› Tools › ClipColorTool

ClipColorTool Class

This tool specifies or un-specifies a clip color to use for pixels inside or outside the clip region. Arguments can be:

  • clear
  • inside | clear
  • outside | clear must be in one of the following forms: "rgb(255,0,0)" "rgba(255,0,0,255)" "rgb(100%,0%,0%)" "hsl(120,50%,50%)" "#rrbbgg" "blanchedAlmond" (see possible values from ColorByName). Case insensitive.

@see [ColorDef]

Extends

Methods

Name Description
constructor(..._args: any[]): ClipColorTool    
parseAndRun(...args: string[]): Promise<boolean> This runs the tool using the given arguments, specifying or unspecifying a clip color to use for pixels inside or outside the clip region.  

Inherited methods

Name Inherited from Description
run(..._args: any[]): Promise<boolean> Inherited Tool Run this instance of a Tool.
register(namespace?: string): void Static Inherited Tool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
maxArgs Accessor Static ReadOnly number The maximum number of arguments allowed by parseAndRun, or undefined if there is no maximum.  
minArgs Accessor Static ReadOnly number The minimum number of arguments allowed by parseAndRun.  
toolId Static string The unique string that identifies this tool.  

Inherited properties

Name Type Inherited from Description
description Accessor Inherited ReadOnly string Tool Get the localized description string from this Tool's class
description Accessor Static Inherited ReadOnly string Tool 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,
Tool.flyover is returned.
englishKeyin Accessor Static Inherited ReadOnly string Tool 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 Inherited ReadOnly string Tool Get the localized flyover string from this Tool's class
flyover Accessor Static Inherited ReadOnly string Tool 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,
Tool.keyin is returned.
hidden Static Inherited boolean Tool If true, this Tool will not appear in the list from ToolRegistry.getToolList.
iconSpec Accessor Inherited ReadOnly string Tool Get the iconSpec from this Tool's class.
iconSpec Static Inherited string Tool The icon for this Tool.
keyin Accessor Inherited ReadOnly string Tool Get the localized keyin string from this Tool's class
keyin Accessor Static Inherited ReadOnly string Tool 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 Inherited string Tool The namespace that provides localized strings for this Tool.
toolId Accessor Inherited ReadOnly string Tool 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: 14 November, 2024