API Reference > frontend-devtools > Effects > VignetteConfig VignetteConfig Class Beta Configures the VignetteEffect. Extends Tool Methods Name Description constructor(..._args: any[]): VignetteConfig parseAndRun(...input: string[]): boolean run(width?: number, height?: number, roundness?: number, smoothness?: number): boolean Inherited methods Name Inherited from Description register(namespace?: I18NNamespace, i18n?: I18N): void Static Tool Register this Tool class with the ToolRegistry. Properties Name Type Description maxArgs Accessor StaticReadOnly number minArgs Accessor StaticReadOnly number roundness Static number How round the vignette will be, from 0.0 (perfectly rectangular) to 1.0 (perfectly round). size StaticReadonly Float32Array Size of the vignette in the form (width/2, height/2). smoothness Static number How quickly the vignette fades in. toolId Static string Inherited properties Name Type Inherited from Description description Accessor ReadOnly string Tool Get the localized description string from this Tool's class description Accessor StaticReadOnly string Tool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" fromits registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,flyover is returned. englishKeyin Accessor StaticReadOnly string Tool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" fromits registered Namespace (e.g. "en/MyApp.json"). flyover Accessor ReadOnly string Tool Get the localized flyover string from this Tool's class flyover Accessor StaticReadOnly string Tool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" fromits registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,keyin is returned. hidden Static boolean Tool If true, this Tool will not appear in the list from getToolList. i18n Static I18N Tool The internationalization services instance used to translate strings from the namespace. iconSpec Accessor ReadOnly string Tool Get the iconSpec from this Tool's class. iconSpec Static string Tool The icon for this Tool. keyin Accessor ReadOnly string Tool Get the localized keyin string from this Tool's class keyin Accessor StaticReadOnly string Tool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" fromits registered Namespace (e.g. "en/MyApp.json"). namespace Static I18NNamespace Tool The I18NNamespace that provides localized strings for this Tool. toolId Accessor 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 localizethe keyin, description, etc. from the current locale. Defined in frontend-devtools/src/effects/Vignette.ts Line 82 Last Updated: 12 June, 2024